Migrate To Utility Network (Utility Network Tools)

Summary

Creates a utility network in a mobile geodatabase using the provided data, schema, and mapping parameters to support basic editing and tracing workflows.

This tool automates the creation of a utility network using an organization's existing data. You can convert network data from a geometric network or nonnetwork data to generate a utility network in a mobile geodatabase while preserving the existing feature class schema.

Usage

For the Source Class and Standalone Classes parameters, all data must be from a geodatabase.
For the Include Related Classes and Include Attachments parameters, all relationships and attachments must use a Global ID primary key. Many-to-many and attributed relationships are not supported
For the Domain Networks parameter values, it is important to understand how the utility network manages networks in a traditional domain network to properly specify the Subnetwork Controller Type and Tier Definition parameter values. To learn more, see Types of subnetwork controllers and Tier definition.
For the Utility Network Mapping parameter, all editor tracking fields will be mapped to use the default fields: created_user, created_date, last_edited_user, and last_edited_date.
For the Utility Network Mapping parameter value, understanding the utility network feature classification will help you specify the various parameter values.

Label	Explanation	Data type
Output Folder	The location of the folder that will contain the output folder and mobile geodatabase specified in the Output Name parameter.	Folder
Service Territory Feature Class	The polygon feature class that will be used to create the utility network's geographical extent. Utility network features cannot be created outside of this extent.	Feature Set
Utility Network Name (Optional)	The name of the utility network. The default is Network.	String
Feature Dataset Name (Optional)	The name of the feature dataset containing the utility network. The default is UtilityNetwork.	String
Output Name (Optional)	The name of the output folder and the mobile geodatabase. The default is MigrationDatabase.	String
Utility Network Mapping (Optional)	The list of feature classes and the details that will be used to generate and map the asset groups and asset types for the utility network in the output geodatabase. Value table columns: Source Class—The source feature class that will be migrated to a utility network. Target Class—The target domain network class for each Source Class value. Asset Group—The name of the asset group created in the target domain network class. By default, this is assigned the name from Source Class. Asset Type—The subtype or field with a coded value domain that will be used to define the asset types for the asset group created in Target Class. If the data contains subtypes, or another field containing a coded value domain that can be used to meaningfully identify different types of equipment in the class, this can be specified as the field to be used for the asset type in Target Class. When a subtype field is specified for Asset Type, existing codes are maintained if all codes are between 1 and 1023. If a code falls outside this range, all asset types will be created using the subtype descriptions and an automatically incrementing number starting at 1. Is Controller—Specify whether the feature classes can act as sources or sinks in the domain network. This enables features belonging to this asset group to act as subnetwork controllers in the output domain network. Controller—The specified asset group and asset types are assigned the subnetwork controller network category and are eligible to define the origin of a subnetwork. If the source feature class participates in a geometric network, the values from the Ancillary Role field are used to determine which features for the asset group and asset type can serve as subnetwork controllers in the utility network. These features are output to the folder specified for the Output Location parameter in a controllers.csv file for later import into the output utility network. When no Ancillary Role field is present, subnetwork controllers can be set manually for the specified asset types in the output utility network. No Controller—The specified asset group and asset types are not assigned the subnetwork controller network category and are not eligible to participate as subnetwork controllers in the domain network.	Value Table
Domain Networks (Optional)	The name and properties for the domain network or networks that will be defined in the output utility network. Value table columns: Name—The name of the domain network. This describes the resource that the domain network manages and will prefix all network classes added to the domain network. Subnetwork Controller Type—The subnetwork controller type determines how the network resource flows through all subnetworks of a domain network. Specify whether resources originate from a point in the network (source) or flow toward a point in the network (sink). Source—If the domain network is defined with the source subnetwork controller type, a resource can only flow away from or exit subnetwork controllers, not toward or into them. Sink—If the domain network is defined with a sink subnetwork controller type, a resource can only flow toward and enter subnetwork controllers, not away from or exit them. Tier Definition—Specify the tier definition type for the domain network, either partitioned or hierarchical. A tier definition denotes the organization of the tiers relative to the rest of the network. Partitioned—Features in a domain network with a partitioned tier definition are independent and can only exist in one tier. Features can exist in one or multiple subnetworks. The relationship between tiers in partitioned domain networks is ordered and linear. For example, a transmission tier delivers the resource over a long distance, and a distribution tier serves the resource to the customer. Hierarchical—Features in a domain network with a hierarchical tier definition can be modeled in multiple types of subnetworks. For example, pressure zones and isolation zones can be defined in two tiers within a tier group. A gas or water feature can be part of both the pressure and isolation tiers.	Value Table
Standalone Classes (Optional)	The stand-alone classes that do not participate in the utility network that will be copied and placed in the output geodatabase.	Table
Load data (Optional)	Specifies whether data from the source classes will be loaded to the output utility network or only the schema from the source classes will be updated in the output utility network. Checked—Data from the source classes will be loaded to the output utility network. This is the default. Unchecked—Only the schema from the source classes will be updated in the output utility network. Data will not be loaded.	Boolean
Merge fields to utility network classes (Optional)	Specifies whether fields from the source classes will be merged and combined with the fields in the output utility network. Checked—Fields from the source classes will be merged and combined with the fields in the output utility network. This is the default. Unchecked—Fields from the source classes will not be merged and combined with the fields in the output utility network.	Boolean
Include related classes (Optional)	Specifies whether related classes from the source and stand-alone classes specified for copy will be included in the output utility network. Checked—Related classes for the source and stand-alone classes will be included in the output utility geodatabase. Unchecked—Related classes for the source and stand-alone classes will not be included in the output geodatabase. This is the default.	Boolean
Include attachments (Optional)	Specifies whether an attachment table will be created and attachments from the source classes will be included in the output geodatabase. Checked—Attachments will be migrated to the output geodatabase. Unchecked—Attachments will not be included in the output geodatabase. This is the default.	Boolean
Utility Network Version	Specifies the version of the utility network that will be created. Current—The latest version of the utility network that is compatible with the current ArcGIS Pro release will be created. This is the default. 7—A version 7 utility network will be created. 6—A version 6 utility network will be created. 5—A version 5 utility network will be created.	String

Derived output

Label	Explanation	Data type
Output Utility Network	The output utility network.	Utility Network
Output Controllers	The output subnetwork controllers.	File
Output Layer File	An output layer file containing subtype group layers for each class controlled by the utility network.	File
Data Loading Workspace	A data loading workspace mapping the source data to the output utility network. This can be used to enable reloading of data into an output utility network without the need to create another mobile geodatabase.	File

arcpy.un.MigrateToUtilityNetwork(output_folder, service_territory_feature_class, {utility_network_name}, {dataset_name}, {output_name}, {un_mapping}, {domain_networks}, {in_standalone_classes}, {load_data}, {merge_fields}, {include_related}, {include_attachments}, utility_network_version)

Name	Explanation	Data type
output_folder	The location of the folder that will contain the output folder and mobile geodatabase specified in the `output_name` parameter.	Folder
service_territory_feature_class	The polygon feature class that will be used to create the utility network's geographical extent. Utility network features cannot be created outside of this extent.	Feature Set
utility_network_name (Optional)	The name of the utility network. The default is Network.	String
dataset_name (Optional)	The name of the feature dataset containing the utility network. The default is UtilityNetwork.	String
output_name (Optional)	The name of the output folder and the mobile geodatabase. The default is MigrationDatabase.	String
un_mapping [un_mapping,...] (Optional)	The list of feature classes and the details that will be used to generate and map the asset groups and asset types for the utility network in the output geodatabase. Value table columns: `Source Class`—The source feature class that will be migrated to a utility network. `Target Class`—The target domain network class for each Source Class value. `Asset Group`—The name of the asset group created in the target domain network class. By default, this is assigned the name from Source Class. `Asset Type`—The subtype or field with a coded value domain that will be used to define the asset types for the asset group created in Target Class. If the data contains subtypes, or another field containing a coded value domain that can be used to meaningfully identify different types of equipment in the class, this can be specified as the field to be used for the asset type in Target Class. When a subtype field is specified for Asset Type, existing codes are maintained if all codes are between 1 and 1023. If a code falls outside this range, all asset types will be created using the subtype descriptions and an automatically incrementing number starting at 1. `Is Controller`—Specify whether the feature classes can act as sources or sinks in the domain network. This enables features belonging to this asset group to act as subnetwork controllers in the output domain network. `CONTROLLER`—The specified asset group and asset types are assigned the subnetwork controller network category and are eligible to define the origin of a subnetwork. If the source feature class participates in a geometric network, the values from the Ancillary Role field are used to determine which features for the asset group and asset type can serve as subnetwork controllers in the utility network. These features are output to the folder specified for the Output Location parameter in a controllers.csv file for later import into the output utility network. When no Ancillary Role field is present, subnetwork controllers can be set manually for the specified asset types in the output utility network. `NO_CONTROLLER`—The specified asset group and asset types are not assigned the subnetwork controller network category and are not eligible to participate as subnetwork controllers in the domain network.	Value Table
domain_networks [domain_networks,...] (Optional)	The name and properties for the domain network or networks that will be defined in the output utility network. Value table columns: `Name`—The name of the domain network. This describes the resource that the domain network manages and will prefix all network classes added to the domain network. `Subnetwork Controller Type`—The subnetwork controller type determines how the network resource flows through all subnetworks of a domain network. Specify whether resources originate from a point in the network (source) or flow toward a point in the network (sink). `SOURCE`—If the domain network is defined with the source subnetwork controller type, a resource can only flow away from or exit subnetwork controllers, not toward or into them. `SINK`—If the domain network is defined with a sink subnetwork controller type, a resource can only flow toward and enter subnetwork controllers, not away from or exit them. `Tier Definition`—Specify the tier definition type for the domain network, either partitioned or hierarchical. A tier definition denotes the organization of the tiers relative to the rest of the network. `PARTITIONED`—Features in a domain network with a partitioned tier definition are independent and can only exist in one tier. Features can exist in one or multiple subnetworks. The relationship between tiers in partitioned domain networks is ordered and linear. For example, a transmission tier delivers the resource over a long distance, and a distribution tier serves the resource to the customer. `HIERARCHICAL`—Features in a domain network with a hierarchical tier definition can be modeled in multiple types of subnetworks. For example, pressure zones and isolation zones can be defined in two tiers within a tier group. A gas or water feature can be part of both the pressure and isolation tiers.	Value Table
in_standalone_classes [in_standalone_classes,...] (Optional)	The stand-alone classes that do not participate in the utility network that will be copied and placed in the output geodatabase.	Table
load_data (Optional)	Specifies whether data from the source classes will be loaded to the output utility network or only the schema from the source classes will be updated in the output utility network. `LOAD`—Data from the source classes will be loaded to the output utility network. This is the default. `SCHEMA`—Only the schema from the source classes will be updated in the output utility network. Data will not be loaded.	Boolean
merge_fields (Optional)	Specifies whether fields from the source classes will be merged and combined with the fields in the output utility network. `MERGE`—Fields from the source classes will be merged and combined with the fields in the output utility network. This is the default. `DO_NOT_MERGE`—Fields from the source classes will not be merged and combined with the fields in the output utility network.	Boolean
include_related (Optional)	Specifies whether related classes from the source and stand-alone classes specified for copy will be included in the output utility network. `INCLUDE`—Related classes for the source and stand-alone classes will be included in the output utility geodatabase. `DO_NOT_INCLUDE`—Related classes for the source and stand-alone classes will not be included in the output geodatabase. This is the default.	Boolean
include_attachments (Optional)	Specifies whether an attachment table will be created and attachments from the source classes will be included in the output geodatabase. `INCLUDE`—Attachments will be migrated to the output geodatabase. `DO_NOT_INCLUDE`—Attachments will not be included in the output geodatabase. This is the default.	Boolean
utility_network_version	Specifies the version of the utility network that will be created. `CURRENT`—The latest version of the utility network that is compatible with the current ArcGIS Pro release will be created. This is the default. `VERSION_7`—A version 7 utility network will be created. `VERSION_6`—A version 6 utility network will be created. `VERSION_5`—A version 5 utility network will be created.	String

Derived output

Name	Explanation	Data type
out_utility_network	The output utility network.	Utility Network
out_controller	The output subnetwork controllers.	File
out_layer_file	An output layer file containing subtype group layers for each class controlled by the utility network.	File
out_loading_workspace	A data loading workspace mapping the source data to the output utility network. This can be used to enable reloading of data into an output utility network without the need to create another mobile geodatabase.	File

Code sample

MigrateToUtilityNetwork example (Python window)

Use the MigrateToUtilityNetwork function to create a source-based hierarchical water domain network from source classes in an existing geometric network in the LocalGovernment.gdb. Asset types are defined for various feature classes such as WaterLine and asset types for the wNetworkStructure asset group are specified as controllers.

arcpy.un.MigrateToUtilityNetwork(r"C:\temp", r"C:\temp\LocalGovernment.gdb\wServiceBoundary", "Network", "UtilityNetwork", "MigrationDatabase", r"C:\temp\LocalGovernment.gdb\WaterDistribution\wConstructionLine StructureLine wConstructionLine # #;C:\temp\LocalGovernment.gdb\WaterDistribution\wControlValve WaterDevice wControlValve # #;C:\temp\LocalGovernment.gdb\WaterDistribution\wCasing StructureLine wCasing # #;C:\temp\LocalGovernment.gdb\WaterDistribution\wCurbStopValve WaterDevice wCurbStopValve # #;C:\temp\LocalGovernment.gdb\WaterDistribution\wFitting WaterDevice wFitting FITTINGTYPE #;C:\temp\LocalGovernment.gdb\WaterDistribution\wHydrant WaterDevice wHydrant # #;C:\temp\LocalGovernment.gdb\WaterDistribution\wLateralLine WaterLine wLateralLine LINETYPE #;C:\temp\LocalGovernment.gdb\WaterDistribution\wMain WaterLine wMain # #;C:\temp\LocalGovernment.gdb\WaterDistribution\wNetworkStructure WaterDevice wNetworkStructure STRUCTTYPE true;C:\temp\LocalGovernment.gdb\WaterDistribution\wPump WaterDevice wPump # #;C:\temp\LocalGovernment.gdb\WaterDistribution\wSamplingStation WaterJunction wSamplingStation # #;C:\temp\LocalGovernment.gdb\WaterDistribution\wServiceConnection WaterDevice wServiceConnection SERVICETYPE #;C:\temp\LocalGovernment.gdb\WaterDistribution\wStructure StructureBoundary wStructure STRUCTTYPE #;C:\temp\LocalGovernment.gdb\WaterDistribution\wSystemValve WaterDevice wSystemValve # #;C:\temp\LocalGovernment.gdb\WaterDistribution\wTestStation WaterDevice wTestStation # #", "Water SOURCE HIERARCHICAL", r"C:\temp\LocalGovernment.gdb\WaterDistribution\wAbandonedLine;C:\temp\LocalGovernment.gdb\WaterDistribution\wAbandonedPoint;C:\temp\LocalGovernment.gdb\WaterDistribution\wConstructionLine;C:\temp\LocalGovernment.gdb\WaterDistribution\wElevationPt;C:\temp\LocalGovernment.gdb\WaterDistribution\wPressureZone", "LOAD", "MERGE", "INCLUDE", "DO_NOT_INCLUDE", "VERSION_7")

Environments

This tool does not use any geoprocessing environments.

Licensing information

Basic: No
Standard: Yes
Advanced: Yes

Migrate To Utility Network (Utility Network Tools)

Summary

Usage

Parameters

Derived output

Environments

Licensing information

Related topics