Export Subnetwork (Utility Network Tools)

Summary

Exports subnetworks from a traditional domain network into a .json file. This tool also allows you to delete a row in the Subnetworks table as long as the Is deleted attribute is set to true. This indicates that the subnetwork controller has been removed from the subnetwork.

Note:

The export subnetwork operation processes asynchronously using the UtilityNetworkTools geoprocessing service when working with a utility network in an enterprise geodatabase. The UtilityNetworkTools service is preconfigured in the System folder for feature services that include a utility network. It has a longer time-out setting and is reserved for utility network geoprocessing tasks.

Learn more about exporting subnetworks

Usage

The subnetworks must be clean before they can be exported; run the Update Subnetwork tool first.
The parameters in the Trace Parameters category can only be used in Python.
The following requirements must be met when working with an enterprise geodatabase:
- The Input Utility Network parameter value must be from a utility network service.
- 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.
When the Set export acknowledged parameter is checked, the following must be true:
- The network topology must be enabled.
- Enterprise geodatabases have the following additional requirements:
  - This tool must be connected to the default version to run.
    - All other sessions connected to the default version are blocked from running validate or enable operations during the enable operation.
  - The connected ArcGIS Enterprise portal account must be the portal utility network owner.

Label	Explanation	Data type
Input Utility Network	The utility network that contains the subnetwork that will be exported.	Utility Network; Utility Network Layer
Domain Network	The domain network that contains the subnetwork.	String
Tier	The tier that contains the subnetwork.	String
Subnetwork Name	The name of the subnetwork that will be exported from the tier. Select a specific source to export the corresponding subnetwork information. When the Subnetworks table contains 10,000 or more records for a tier, the parameter's choice list is not populated and an empty field is provided for the subnetwork name.	String
Set export acknowledged	Specifies whether the `LASTACKEXPORTSUBNETWORK` attribute for the corresponding controller in the Subnetworks table and feature in the SubnetLine feature class will be updated. Checked—The `LASTACKEXPORTSUBNETWORK` attribute for the corresponding controller in the Subnetworks table will be updated. If the source has been marked for deletion (Is deleted = True), it will be deleted from the Subnetworks table. This option requires that the input utility network reference the default version. Unchecked—The `LASTACKEXPORTSUBNETWORK` attribute for the corresponding controller in the Subnetworks table will not be updated. This is the default.	Boolean
Output JSON	The name and location of the `.json` file that will be generated.	File
Condition Barriers (Optional)	Sets a traversability barrier condition on features based on a comparison to a network attribute or check for a category string. A condition barrier uses a network attribute or network category, an operator and a type, and an attribute value. For example, stop a trace when a feature has the `Device Status` attribute equal to the specific value of `Open`. When a feature meets this condition, the trace stops. If you're using more than one attribute, you can use the Combine using parameter to define an And or an Or condition. Learn more about using multiple conditional expressions Note: This parameter is only available for Python. Value table columns: Name—Filter by network attribute name. Operator—Filter by an operator. Is equal to—The attribute is equal to the value. Does not equal—The attribute is not equal to the value. Is greater than—The attribute is greater than the value. Is greater than or equal to—The attribute is greater than or equal to the value. Is less than—The attribute is less than the value. Is less than or equal to—The attribute is less than or equal to the value. Includes the values (bitwise AND equals the value)—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value). Does not include the values (bitwise AND does not equal the value)—A bitwise AND operation in which not all of the bits in the value are present in the attribute (bitwise AND != value). Includes any (bitwise AND equals True)—A bitwise AND operation in which at least one bit in the value is present in the attribute (bitwise AND == True). Does not include any (bitwise AND equals False)—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False). Type—Filter by a specific type. Specific value—Filter by a specific value or network category. Network attribute—Filter by a network attribute. Value—Filter by a specific value. Combine Using—Use this parameter to combine multiple condition barriers. And—Combine the condition barriers. Or—Use if either condition barrier is met.	Value Table
Function Barriers (Optional)	Sets a traversability barrier on features based on a function. Function barriers can be used to do such things as restrict how far the trace travels from the starting point, or set a maximum value to stop a trace. For example, the length of each line traveled is added to the total distance traveled so far. When the total length traveled reaches the value specified, the trace stops. Note: This parameter is only available for Python. Value table columns: Function—Filter by a function. Minimum—The minimum of the input values will be identified. Maximum—The maximum of the input values will be identified. Average—The average of the input values will be calculated. Count—The number of features will be identified. Add—The sum of the input values will be calculated. Subtract—The difference in the input values will be calculated. Subnetwork controllers and loops trace types do not support the subtract function. Attribute—Filter by a network attribute. Operator—Filter by an operator. Is equal to—The attribute is equal to the value. Does not equal—The attribute is not equal to the value. Is greater than—The attribute is greater than the value. Is greater than or equal to—The attribute is greater than or equal to the value. Is less than—The attribute is less than the value. Is less than or equal to—The attribute is less than or equal to the value. Includes the values (bitwise AND equals the value)—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value). Does not include the values (bitwise AND does not equal the value)—A bitwise AND operation in which not all of the bits in the value are present in the attribute (bitwise AND != value). Includes any (bitwise AND equals True)—A bitwise AND operation in which at least one bit in the value is present in the attribute (bitwise AND == True). Does not include any (bitwise AND equals False)—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False). Value—Filter by a specific value. Use Local Values—Boolean value to use local variables instead of a global variable.	Value Table
Include Barrier Features (Optional)	Specifies whether the traversability barrier features will be included in the trace results. Traversability barriers are optional even if they have been preset in the subnetwork definition. Checked—Traversability barriers will be included in the trace results. This is the default. Unchecked—Traversability barriers will not be included in the trace results.	Boolean
Apply Traversability To (Optional)	Specifies the type of traversability that will be applied. Traversability scope determines whether traversability is applied to junctions, edges, or both. For example, if a condition barrier is defined to stop the trace if `DEVICESTATUS` is set to `Open` and traversability scope is set to edges only, the trace will not stop even if the trace encounters an open device, because `DEVICESTATUS` is only applicable to junctions. In other words, this parameter indicates to the trace whether to ignore junctions, edges, or both. Note: This parameter is only available for Python. Both junctions and edges—Traversability will be applied to both junctions and edges. This is the default. Junctions only—Traversability will be applied to junctions only. Edges only—Traversability will be applied to edges only.	String
Propagators (Optional)	Specifies the network attributes to propagate as well as how that propagation will occur during a trace in a traditional domain network. Propagated class attributes denote the key values on subnetwork controllers that are disseminated to the rest of the features in the subnetwork. For example, in an electric distribution model, you can propagate the phase value. Note: This parameter is only available for Python. Value table columns: Attribute—Filter by a network attribute. Substitution Attribute—The field used for substitution. Function—Filter by a function. Operator—Filter by an operator. Value—Filter by a specific value.	Value Table
Include geometry (Optional)	Specifies whether geometry will be included in the results. Checked—Geometry will be included in the results. Unchecked—Geometry will not be included in the results. This is the default.	Boolean
Result Types (Optional)	Specifies the types of results that will be returned. Connectivity—Features that are connected through geometric coincidence or connectivity associations will be returned. Features—Feature-level information will be returned. Containment and attachment associations—Features that are associated through containment and structural attachment associations will be returned. Related records—Values from related objects will be returned for features in the subnetwork for the specified relationship class and field. Note: For enterprise geodatabases, this option requires ArcGIS Enterprise 11.5 or later.	String
Result Network Attributes (Optional)	The network attributes that will be included in the results.	String
Result Fields (Optional)	The fields from a feature class that will be returned as results. The values of the fields will be returned in the results for the features in the subnetwork. Value table columns: Feature Class—A feature or object class that participates in the utility network. Field Name—The name of a field from the feature or object class that will have its values returned in the results.	Value Table
Include domain descriptions (Optional)	Specifies whether domain descriptions will be included in the output `.json` file to communicate domain mapping for controllers, featureElements, connectivity, and associations. Checked—Domain descriptions will be included in the results. Unchecked—Domain descriptions will not be included in the results. This is the default.	Boolean
Related Record Fields (Optional)	The fields from related object classes that will be returned as results. The values of the fields will be returned in the results for the features in the subnetwork. Value table columns: Relationship Class—A relationship class that relates to a feature or object class that participates in the utility network. Field Name—The name of a field from the related object class that will have its values returned in the results.	Value Table
Include flow directions (Optional)	Specifies whether flow directions will be included in the output `.json` file. If included, the file will contain flow direction information derived from the subnetwork controllers for traversed lines, edge objects, the internal edges of devices with terminals, and connectivity associations. This parameter applies only to the Connectivity and Features result types options. Note: For enterprise geodatabases, this parameter requires ArcGIS Enterprise 12.1 or later. Checked—Flow directions will be included in the results. Unchecked—Flow directions will not be included in the results. This is the default.	Boolean
Include propagated values (Optional)	Specifies whether propagated values will be included in the output `.json` file for the exported subnetwork. This parameter is only applicable to the Features result type. Note: For enterprise geodatabases, this parameter requires ArcGIS Enterprise 12.1 or later. Checked—Propagated values will be included in the results. Unchecked—Propagated values will not be included in the results. This is the default.	Boolean

Derived output

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

arcpy.un.ExportSubnetwork(in_utility_network, domain_network, tier, subnetwork_name, export_acknowledged, out_json_file, {condition_barriers}, {function_barriers}, {include_barriers}, {traversability_scope}, {propagators}, {include_geometry}, {result_types}, {result_network_attributes}, {result_fields}, {include_domain_descriptions}, {related_record_fields}, {include_flow_directions}, {include_propagated_values})

Name	Explanation	Data type
in_utility_network	The utility network that contains the subnetwork that will be exported.	Utility Network; Utility Network Layer
domain_network	The domain network that contains the subnetwork.	String
tier	The tier that contains the subnetwork.	String
subnetwork_name	The name of the subnetwork that will be exported from the tier. Select a specific source to export the corresponding subnetwork information.	String
export_acknowledged	Specifies whether the `LASTACKEXPORTSUBNETWORK` attribute for the corresponding controller in the Subnetworks table and feature in the SubnetLine feature class will be updated. `ACKNOWLEDGE`—The `LASTACKEXPORTSUBNETWORK` attribute for the corresponding controller in the Subnetworks table will be updated. If the source has been marked for deletion (Is deleted = True), it will be deleted from the Subnetworks table. This option requires that the input utility network reference the default version. `NO_ACKNOWLEDGE`—The `LASTACKEXPORTSUBNETWORK` attribute for the corresponding controller in the Subnetworks table will not be updated. This is the default.	Boolean
out_json_file	The name and location of the `.json` file that will be generated.	File
condition_barriers [[Name, Operator, Type, Value, Combine Using],...] (Optional)	Sets a traversability barrier condition on features based on a comparison to a network attribute or check for a category string. A condition barrier uses a network attribute or network category, an operator and a type, and an attribute value. For example, stop a trace when a feature has the `Device Status` attribute equal to the specific value of `Open`. When a feature meets this condition, the trace stops. If you're using more than one attribute, you can use the Combine using parameter to define an And or an Or condition. Learn more about using multiple conditional expressions Note: This parameter is only available for Python. Value table columns: `Name`—Filter by network attribute name. `Operator`—Filter by an operator. `IS_EQUAL_TO`—The attribute is equal to the value. `DOES_NOT_EQUAL`—The attribute is not equal to the value. `IS_GREATER_THAN`—The attribute is greater than the value. `IS_GREATER_THAN_OR_EQUAL_TO`—The attribute is greater than or equal to the value. `IS_LESS_THAN`—The attribute is less than the value. `IS_LESS_THAN_OR_EQUAL_TO`—The attribute is less than or equal to the value. `INCLUDES_THE_VALUES`—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value). `DOES_NOT_INCLUDE_THE_VALUES`—A bitwise AND operation in which not all of the bits in the value are present in the attribute (bitwise AND != value). `INCLUDES_ANY`—A bitwise AND operation in which at least one bit in the value is present in the attribute (bitwise AND == True). `DOES_NOT_INCLUDE_ANY`—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False). `Type`—Filter by a specific type. `SPECIFIC_VALUE`—Filter by a specific value or network category. `NETWORK_ATTRIBUTE`—Filter by a network attribute. `Value`—Filter by a specific value. `Combine Using`—Use this parameter to combine multiple condition barriers. `AND`—Combine the condition barriers. `OR`—Use if either condition barrier is met.	Value Table
function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (Optional)	Sets a traversability barrier on features based on a function. Function barriers can be used to do such things as restrict how far the trace travels from the starting point, or set a maximum value to stop a trace. For example, the length of each line traveled is added to the total distance traveled so far. When the total length traveled reaches the value specified, the trace stops. Note: This parameter is only available for Python. Value table columns: `Function`—Filter by a function. `MIN`—The minimum of the input values will be identified. `MAX`—The maximum of the input values will be identified. `AVERAGE`—The average of the input values will be calculated. `COUNT`—The number of features will be identified. `ADD`—The sum of the input values will be calculated. `SUBTRACT`—The difference in the input values will be calculated. Subnetwork controllers and loops trace types do not support the subtract function. `Attribute`—Filter by a network attribute. `Operator`—Filter by an operator. `IS_EQUAL_TO`—The attribute is equal to the value. `DOES_NOT_EQUAL`—The attribute is not equal to the value. `IS_GREATER_THAN`—The attribute is greater than the value. `IS_GREATER_THAN_OR_EQUAL_TO`—The attribute is greater than or equal to the value. `IS_LESS_THAN`—The attribute is less than the value. `IS_LESS_THAN_OR_EQUAL_TO`—The attribute is less than or equal to the value. `INCLUDES_THE_VALUES`—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value). `DOES_NOT_INCLUDE_THE_VALUES`—A bitwise AND operation in which not all of the bits in the value are present in the attribute (bitwise AND != value). `INCLUDES_ANY`—A bitwise AND operation in which at least one bit in the value is present in the attribute (bitwise AND == True). `DOES_NOT_INCLUDE_ANY`—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False). `Value`—Filter by a specific value. `Use Local Values`—Boolean value to use local variables instead of a global variable.	Value Table
include_barriers (Optional)	Specifies whether the traversability barrier features will be included in the trace results. Traversability barriers are optional even if they have been preset in the subnetwork definition. `INCLUDE_BARRIERS`—Traversability barriers will be included in the trace results. This is the default. `EXCLUDE_BARRIERS`—Traversability barriers will not be included in the trace results.	Boolean
traversability_scope (Optional)	Specifies the type of traversability that will be applied. Traversability scope determines whether traversability is applied to junctions, edges, or both. For example, if a condition barrier is defined to stop the trace if `DEVICESTATUS` is set to `Open` and traversability scope is set to edges only, the trace will not stop even if the trace encounters an open device, because `DEVICESTATUS` is only applicable to junctions. In other words, this parameter indicates to the trace whether to ignore junctions, edges, or both. `BOTH_JUNCTIONS_AND_EDGES`—Traversability will be applied to both junctions and edges. This is the default. `JUNCTIONS_ONLY`—Traversability will be applied to junctions only. `EDGES_ONLY`—Traversability will be applied to edges only.	String
propagators [[Attribute, Substitution Attribute, Function, Operator, Value],...] (Optional)	Specifies the network attributes to propagate as well as how that propagation will occur during a trace in a traditional domain network. Propagated class attributes denote the key values on subnetwork controllers that are disseminated to the rest of the features in the subnetwork. For example, in an electric distribution model, you can propagate the phase value. Note: This parameter is only available for Python. Value table columns: `Attribute`—Filter by a network attribute. `Substitution Attribute`—The field used for substitution. `Function`—Filter by a function. `Operator`—Filter by an operator. `Value`—Filter by a specific value.	Value Table
include_geometry (Optional)	Specifies whether geometry will be included in the results. `INCLUDE_GEOMETRY`—Geometry will be included in the results. `EXCLUDE_GEOMETRY`—Geometry will not be included in the results. This is the default.	Boolean
result_types [result_types,...] (Optional)	Specifies the types of results that will be returned. `CONNECTIVITY`—Features that are connected through geometric coincidence or connectivity associations will be returned. `FEATURES`—Feature-level information will be returned. `CONTAINMENT_AND_ATTACHMENT_ASSOCIATIONS`—Features that are associated through containment and structural attachment associations will be returned. `RELATED_RECORDS`—Values from related objects will be returned for features in the subnetwork for the specified relationship class and field. Note: For enterprise geodatabases, this option requires ArcGIS Enterprise 11.5 or later.	String
result_network_attributes [result_network_attributes,...] (Optional)	The network attributes that will be included in the results.	String
result_fields [[Feature Class, Field Name],...] (Optional)	The fields from a feature class that will be returned as results. The values of the fields will be returned in the results for the features in the subnetwork. Value table columns: `Feature Class`—A feature or object class that participates in the utility network. `Field Name`—The name of a field from the feature or object class that will have its values returned in the results.	Value Table
include_domain_descriptions (Optional)	Specifies whether domain descriptions will be included in the output `.json` file to communicate domain mapping for controllers, featureElements, connectivity, and associations. `INCLUDE_DOMAIN_DESCRIPTIONS`—Domain descriptions will be included in the results. `EXCLUDE_DOMAIN_DESCRIPTIONS`—Domain descriptions will not be included in the results. This is the default.	Boolean
related_record_fields [[Feature Class, Field Name],...] (Optional)	The fields from related object classes that will be returned as results. The values of the fields will be returned in the results for the features in the subnetwork. Value table columns: `Relationship Class`—A relationship class that relates to a feature or object class that participates in the utility network. `Field Name`—The name of a field from the related object class that will have its values returned in the results.	Value Table
include_flow_directions (Optional)	Specifies whether flow directions will be included in the output `.json` file. If included, the file will contain flow direction information derived from the subnetwork controllers for traversed lines, edge objects, the internal edges of devices with terminals, and connectivity associations. This parameter applies only to the `CONNECTIVITY` and `FEATURES` result types options. Note: For enterprise geodatabases, this parameter requires ArcGIS Enterprise 12.1 or later. `INCLUDE_FLOW_DIRECTIONS`—Flow directions will be included in the results. `EXCLUDE_FLOW_DIRECTIONS`—Flow directions will not be included in the results. This is the default.	Boolean
include_propagated_values (Optional)	Specifies whether propagated values will be included in the output `.json` file when running a subnetwork-based trace. This parameter is only applicable to the `FEATURES` result type. Note: For enterprise geodatabases, this parameter requires ArcGIS Enterprise 12.1 or later. `INCLUDE_PROPAGATED_VALUES`—Propagated values will be included in the results. `EXCLUDE_PROPAGATED_VALUES`—Propagated values will not be included in the results. This is the default.	Boolean

Derived output

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

Code sample

ExportSubnetwork example (Python window)

Export the corresponding subnetwork information for a source named RMT002 to a .json file with domain descriptions included.

import arcpy
arcpy.un.ExportSubnetwork("Utility Network", "ElectricDistribution",
                          "Medium Voltage", "RMT002", "ACKNOWLEDGE",
                          "C:\\Temp\\RMT002clean.json", None, None,
                          "INCLUDE_BARRIERS", "BOTH_JUNCTIONS_AND_EDGES",
                          None, "INCLUDE_GEOMETRY", "FEATURES", None, None,
                          "INCLUDE_DOMAIN_DESCRIPTIONS", "INCLUDE_FLOW_DIRECTIONS")

Environments

This tool does not use any geoprocessing environments.

Licensing information

Basic: No
Standard: Yes
Advanced: Yes

Export Subnetwork (Utility Network Tools)

Summary

Note:

Usage

License:

Parameters

Note:

Note:

Note:

Note:

Note:

Note:

Note:

Derived output

Environments

Licensing information

Related topics