Set Terminal Configuration (Utility Network)

Summary

Assigns a terminal configuration to an asset type in a utility network.

Once a terminal configuration has been established, this tool allows you to set the terminal configuration for a utility network asset type of a device feature class or junction object table. When a terminal configuration is assigned to an asset type, a feature created with that asset type will have terminals. More specifically, the feature will have the terminals specified for the terminal configuration.

To understand what underlying terminals are provided for each asset type, review the Terminal Configuration section on the Network Properties dialog box of the utility network layer properties.

Usage

  • A terminal configuration can be assigned to more than one asset type, but an asset type can only be assigned one terminal configuration.

  • Assigning a terminal configuration to an asset type is permanent and cannot be changed or removed.

  • This tool can be used with the Add Terminal Configuration tool, which is used to add a new terminal configuration to a utility network.

  • If an asset type has not been assigned a user-defined terminal configuration, the default terminal configuration is Single terminal.

  • The network topology must be disabled.

  • When working with an enterprise geodatabase, the connected ArcGIS Enterprise portal account must be the portal utility network owner.

  • When working with an enterprise geodatabase, this tool must be connected to the default version when executed.

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

Parameters

LabelExplanationData Type
Input Utility Network

The utility network containing the terminal configuration that will be set on a specific asset type.

Utility Network; Utility Network Layer
Domain Network

The domain network to which the asset type belongs.

String
Input Table

The utility network feature class or table to which the asset type belongs.

String
Asset Group

The asset group to which the asset type belongs.

String
Asset Type

The asset type that will receive the terminal configuration.

String
Terminal Configuration

The terminal configuration to be assigned to the asset type.

String

Derived Output

LabelExplanationData Type
Updated Utility Network

The updated utility network

Utility Network

arcpy.un.SetTerminalConfiguration(in_utility_network, domain_network, device_featureclass, assetgroup, assettype, terminal_configuration)
NameExplanationData Type
in_utility_network

The utility network containing the terminal configuration that will be set on a specific asset type.

Utility Network; Utility Network Layer
domain_network

The domain network to which the asset type belongs.

String
device_featureclass

The utility network feature class or table to which the asset type belongs.

String
assetgroup

The asset group to which the asset type belongs.

String
assettype

The asset type that will receive the terminal configuration.

String
terminal_configuration

The terminal configuration to be assigned to the asset type.

String

Derived Output

NameExplanationData Type
out_utility_network

The updated utility network

Utility Network

Code sample

SetTerminalConfiguration example (Python window)

Set the terminal configuration for the Air powered asset type.

import arcpy
arcpy.SetTerminalConfiguration_un("Utility Network", "ElectricDistribution", 
                                  "ElectricDistributionDevice", "Circuit Breaker", 
                                  "Air powered", "Dual terminal")

Environments

Licensing information

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

Related topics