Enable Cluster Keys (Utility Network)

Summary

Creates a CLUSTERKEY attribute field on classes in utility network versions 4 through 7. This attribute field is updated by the Calculate Cluster Keys tool with values that facilitate the grouping of features and objects in the network topology.

Cluster keys enable analytical operations to be performed more efficiently in the utility network when working with nonspatial junction and edge objects. The cluster keys are consumed by the network topology on enable and can be helpful when running operations that query the network topology, such as a trace.

Learn more about working with cluster keys

Usage

• This tool modifies the schema of the utility network classes and is intended for use with utility network versions 4 through 7.

• The network topology must be disabled.

• When working with an enterprise geodatabase, the Input Utility Network parameter value must be from a database connection established as the database utility network owner.

• An exclusive lock must be obtained, meaning that you must close active connections to the dataset, including those from services.

License:

The active portal account must be assigned a license with the ArcGIS Advanced Editing user type extension to use this tool in an enterprise deployment.

Parameters

Dialog

Label	Explanation	Data Type
Input Utility Network	The utility network containing the classes to which the CLUSTERKEY attribute field will be added.	Utility Network; Utility Network Layer

Derived Output

Label	Explanation	Data Type
Output Utility Network	The updated utility network.	Utility Network

Python

arcpy.un.EnableClusterKeys(in_utility_network)

Name	Explanation	Data Type
in_utility_network	The utility network containing the classes to which the CLUSTERKEY attribute field will be added.	Utility Network; Utility Network Layer

Derived Output

Name	Explanation	Data Type
out_utility_network	The updated utility network.	Utility Network

Code sample

EnableClusterKeys example (Python window)

Create a CLUSTERKEY field on all utility network feature and object classes on a utility network named My Utility Network.

import arcpy 
arcpy.un.CalculateClusterKeys('My Utility Network')

Environments

This tool does not use any geoprocessing environments.

Licensing information

• Basic: No
• Standard: Yes
• Advanced: Yes