Calculate Cluster Keys (Utility Network Tools)

Summary

Populates the CLUSTERKEY attribute field on all utility network classes with an integer value to facilitate 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.

Usage

• The network topology must be disabled. Enable the network topology to update and use the cluster key values in the network topology.

• The utility network schema must contain the CLUSTERKEY attribute on all classes. Use the Enable Cluster Keys tool to add the attribute field to classes in a utility network.

• 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.

  Learn more about how to work with cluster keys

Parameters

• Dialog
• Python

Label	Explanation	Data type
Input Utility Network	The utility network where the cluster keys will be added.	Utility Network; Utility Network Layer
Overwrite (Optional)	Specifies whether existing cluster key values will be overwritten with new values for the specified extent. Checked—Existing cluster key values will be overwritten for all classes in the specified extent. Unchecked—Existing cluster key values will not be overwritten for classes in the specified extent. This is the default.	Boolean
Extent (Optional)	The geographical extent that will be used to generate the cluster keys. When no extent is provided, the tool will use the full extent of the utility network. Current Display Extent —The extent will be based on the active map or scene. Draw Extent —The extent will be based on a rectangle drawn on the map or scene. Extent of a Layer —The extent will be based on an active map layer. Choose an available layer or use the Extent of data in all layers option. Each map layer has the following options: All Features —The extent of all features. Selected Features —The extent of the selected features. Visible Features —The extent of visible features. Browse —The extent will be based on a dataset. Intersection of Inputs —The extent will be the intersecting extent of all inputs. Union of Inputs —The extent will be the combined extent of all inputs. Clipboard —The extent can be copied to and from the clipboard. Copy Extent —Copies the extent and coordinate system to the clipboard. Paste Extent —Pastes the extent and coordinate system from the clipboard. If the clipboard does not include a coordinate system, the extent will use the map's coordinate system. Reset Extent —The extent will be reset to the default value. When coordinates are manually provided, the coordinates must be numeric values and in the active map's coordinate system. The map may use different display units than the provided coordinates. Use a negative value sign for south and west coordinates.	Extent

Derived output

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

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics

• An overview of the Administration toolset
• Find a geoprocessing tool