Label | Explanation | Data Type |
Asset Package
| The asset package that will be used to configure the schema and properties of a utility network. | Workspace |
Domain networks to apply
| The domain networks in the asset package that will be applied to the utility network. | Multiple Value |
Utility Network Name
| The utility network that will be configured with the asset package. | Utility Network |
Load data
(Optional) | Defines if data in the asset package is loaded into the utility network.
| Boolean |
Calculate Spatial Index and Analyze
(Optional) | If loading data into the utility network, this provides the option to calculate the spatial index and analyze the utility network. For certain enterprise database platforms, this can improve performance during enable topology. This parameter is applicable when creating a utility network in an enterprise geodatabase.
| Boolean |
Configurations to apply
(Optional) | Select the configuration options you want to apply to your utility network. This parameter is applicable when a D_Configurations table is present in your asset package. | Multiple Value |
Rename option
(Optional) | Select the rename option you want to apply to your utility network. This parameter is applicable when the D_Rename table is present in your asset package. | String |
Post Process
(Optional) | Post process runs three processes to enable topology, update subnetworks, and update Is Connected.
| Boolean |
Summary
Applies the domain network or networks, related layers, related tables, and properties of a utility network to an existing utility network.
Caution:
Close all maps in your project before running this tool.
Usage
For each version of ArcGIS Pro, this tool requires a specific version of the utility network. The following table shows the versions of the utility network at each ArcGIS Pro version.
ArcGIS Pro version Utility Network version 3.3.x
7
3.2.x
6
3.1.x
6
3.0.x
6
2.9.x
5
2.8.x
5
2.7.x
5
2.6.x
4
2.5.x
3
2.4.x
3
2.3.x
2
2.2.x
2
2.1.x
1
This tool adds all data in the asset package to the target, even if the records already exist. The schema is additive. When run against a configured utility network, only the schema additions will be applied. Existing properties are not removed or changed.
The network topology must be disabled.
If using an enterprise geodatabase the following notes apply:
- The connected ArcGIS Enterprise portal account must be the utility network owner.
- The connected enterprise geodatabase user must be the utility network owner.
- This tool should be executed when connected to the default version.
Parameters
arcpy.pt.AssetPackageToUtilityNetwork(asset_package, domain_networks, in_utility_network, {load_data}, {analyze}, {configurations}, {rename_field}, {post_process})
Name | Explanation | Data Type |
asset_package | The asset package that will be used to configure the schema and properties of a utility network. | Workspace |
domain_networks [domain_networks,...] | The domain networks in the asset package that will be applied to the utility network. In python, * can be passed in to select all domain networks. | Multiple Value |
in_utility_network | The utility network that will be configured with the asset package. | Utility Network |
load_data (Optional) | Defines if data in the asset package is loaded into the utility network.
| Boolean |
analyze (Optional) | If loading data into the utility network, this provides the option to calculate the spatial index and analyze the utility network. For certain enterprise database platforms, this can improve performance during enable topology. This parameter is applicable when creating a utility network in an enterprise geodatabase.
| Boolean |
configurations (Optional) | Select the configuration options you want to apply to your utility network. This parameter is applicable when a D_Configurations table is present in your asset package. In python, * can be passed in to select all configurations. | Multiple Value |
rename_field [rename_field,...] (Optional) | Select the rename option you want to apply to your utility network. This parameter is applicable when the D_Rename table is present in your asset package. | String |
post_process (Optional) | Post process runs three processes to enable topology, update subnetworks and update Is Connected. This parameter is applicable when creating a utility network in a file geodatabase.
| Boolean |
Code sample
Applies an asset package to a utility network.
arcpy.pt.AssetPackageToUtilityNetwork("C:/data/Water_AssetPackage.gdb", "C:/data/connection.sde/gis.SYSTEM/gis.WaterNetwork", "Structure;Water")
Applies an asset package to a utility network.
# Name: Apply_AssetPackage.py
# Description: Applies the asset package schema to the utility network
# Import system modules
import arcpy
# Set local variables
asset_package = "C:/data/Water_AssetPackage.gdb"
utility_network = "C:/data/connection.sde/gis.SYSTEM/gis.WaterNetwork"
domain_networks = ["Structure", "Water"]
load = False
analyze = False
configure = ["integrity", "compliance"]
rename = "Portuguese"
# When the target utility network is in an enterprise geodatabase, you need to sign in to Portal.
arcpy.SignInToPortal(portal_url=arcpy.GetActivePortalURL(), username='my_user', password='my_password')
# Apply the schema
arcpy.pt.AssetPackageToUtilityNetwork(asset_package, utility_network, domain_networks, load, analyze, configure, rename)