Add Tier (Utility Network)

Summary

Creates a new tier for a domain network in a utility network.

Tiers are collections of subnetworks that share the same level, name restrictions, and topology type. Tiers are required for subnetwork management.

Usage

• A subnetwork name field is added for domain networks with a partitioned tier definition for the first tier added to the domain network. For domain networks with a hierarchical tier definition, a subnetwork field name is created using the Subnetwork Field Name parameter value. To learn more, see Subnetwork name.

• For domain networks with a hierarchical tier definition, the Tier Group Name is a required parameter. Tier groups can be created for domain networks with a hierarchical tier definition using the Add Tier Group tool.

• Tiers should be added before appending data in the utility network feature classes. If data is appended before adding a new tier, an error will occur.

• The network topology must be disabled.

• The following requirements must be met 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.
  • The connected ArcGIS Enterprise portal account must be the portal utility network owner.
  • This tool must be connected to the default version when executed.

Parameters

Dialog

Label	Explanation	Data Type
Input Utility Network	The utility network that contains the domain network where the tier will be added.	Utility Network; Utility Network Layer
Domain Network	The domain network where the tier will be created.	String
Name	The name of the new tier. The name must be unique in the entire utility network.	String
Rank	The rank of the tier being added. The highest rank is the number 1.	Long
Topology Type (Optional)	Specifies the topology type for the new tier. Subnetworks with radial and mesh topology types both support one or more subnetwork controllers. This parameter is disabled on the tool dialog box if the input domain network was created with a hierarchical tier definition and the topology type defaults to mesh. If the domain network was created with a partitioned tier definition, this parameter will have all topology types available in the drop-down list. For tracing or subnetwork management, this parameter does not currently provide a difference in behavior. The functionality of this parameter is under development and will be applicable in a future release. Radial—The subnetworks will have a radial topology type. Mesh—The subnetworks will have a mesh topology type. This is the default topology type for a tier created with a hierarchical tier definition.	String
Tier Group Name (Optional)	The existing tier group to which the new tier will be added. This parameter is required for domain networks with a hierarchical tier definition.	String
Subnetwork Field Name (Optional)	The name of the field where the subnetwork names for this tier will be stored. This is a system-maintained field that will be created the first time a tier is added to a tier group and reused for any additional tiers. For example, you have two tier groups: Distribution and Transmission. When you add a tier named system to the Distribution group and specify the subnetwork field name to be systemsubnet, the field is created. Next, you add a second tier named system to the Transmission group. This parameter will detect that the systemsubnet field should be used as the subnetwork field name. This parameter is required for hierarchical tier types.	String

Derived Output

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

Python

arcpy.un.AddTier(in_utility_network, domain_network, name, rank, {topology_type}, {tier_group_name}, {subnetwork_field_name})

Name	Explanation	Data Type
in_utility_network	The utility network that contains the domain network where the tier will be added.	Utility Network; Utility Network Layer
domain_network	The domain network where the tier will be created.	String
name	The name of the new tier. The name must be unique in the entire utility network.	String
rank	The rank of the tier being added. The highest rank is the number 1.	Long
topology_type (Optional)	Specifies the topology type for the new tier. Subnetworks with radial and mesh topology types both support one or more subnetwork controllers. This parameter is disabled on the tool dialog box if the input domain network was created with a hierarchical tier definition and the topology type defaults to mesh. If the input domain network was created with a hierarchical tier definition, the default topology type is MESH. If the input domain network was created with a partitioned tier definition, the topology type parameter is required. Note: For tracing or subnetwork management, this parameter does not currently provide a difference in behavior. The functionality of this parameter is under development and will be applicable in a future release. RADIAL—The subnetworks will have a radial topology type. MESH—The subnetworks will have a mesh topology type. This is the default topology type for a tier created with a hierarchical tier definition.	String
tier_group_name (Optional)	The existing tier group to which the new tier will be added. This parameter is required for domain networks with a hierarchical tier definition.	String
subnetwork_field_name (Optional)	The name of the field where the subnetwork names for this tier will be stored. This is a system-maintained field that will be created the first time a tier is added to a tier group and reused for any additional tiers. For example, you have two tier groups: Distribution and Transmission. When you add a tier named system to the Distribution group and specify the subnetwork field name to be systemsubnet, the field is created. Next, you add a second tier named system to the Transmission group. This parameter will detect that the systemsubnet field should be used as the subnetwork field name. This parameter is required for hierarchical tier types.	String

Derived Output

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

Code sample

AddTier example 1 (Python window)

Create a tier in a hierarchical network named DistributionSystem with a MESH topology type.

import arcpy
arcpy.AddTier_un("Utility Network", "GasDistribution", "Distribution System", 
                 1, "MESH", "Distribution", "System")

AddTier example 2 (Python window)

Create a tier in a partitioned network named MediumVoltage with a RADIAL topology type.

import arcpy
arcpy.AddTier_un("Utility Network", "ElectricDistribution", "Medium Voltage", 
                 1, "RADIAL")

Environments

This tool does not use any geoprocessing environments.

Licensing information

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