Back to Top

Export Subnetwork (Utility Network)

In this topic

  1. Summary
  2. Usage
  3. Parameters
  4. Environments
  5. Licensing information

Summary

Exports subnetworks from a utility 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.

Learn more about exporting subnetworks

Usage

  • The subnetworks must be clean; run the Update Subnetwork tool first.

  • The parameters in the Trace Parameters category can only be executed via 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.

  • When the Set export acknowledged parameter is enabled, 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 when executed.
      • The connected ArcGIS Enterprise portal account must be the portal utility network owner.

  • At ArcGIS Pro 2.3, the following parameters are added: Include Geometry, Result Types, Result Network Attributes, and Result Fields. When these parameters are used, the output JSON file format will vary. These parameters require ArcGIS Enterprise 10.7 or later when used with an enterprise geodatabase. Review the output JSON response syntax.

Parameters

DialogPython

LabelExplanationData Type
Input Utility Network

The utility network that contains the subnetwork to export.

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 to export. Select a specific source to export the corresponding subnetwork information.

String
Set export acknowledged

Specifies whether the LASTACKEXPORTSUBNETWORK attribute for the corresponding controller in the Subnetworks table and feature in the SubnetLine feature class is updated.

  • Checked—Updates the LASTACKEXPORTSUBNETWORK attribute for the corresponding controller in the Subnetworks table. If the controller has been marked for deletion (Is deleted = True), it will be deleted from the Subnetworks table. This option requires the input utility network to reference the default version.
  • Unchecked—Does not update the LASTACKEXPORTSUBNETWORK attribute for the corresponding controller in the Subnetworks table. This is the default.

Boolean
Output JSON

The name and location of the JSON file to be generated.

File
Condition Barriers
(Optional)
Value Table
Function Barriers
(Optional)
Value Table
Include Barrier Features
(Optional)
Boolean
Apply Traversability To
(Optional)
  • Both junctions and edges —Apply traversability to both junctions and edges.
  • Junctions only —Apply traversability to only junctions.
  • Edges only —Apply traversability to only edges.
String
Propagators
(Optional)
Value Table
Include Geometry
(Optional)

Specifies whether to include the geometry in the results.

  • Checked—Include the geometry in the results.
  • Unchecked—Do not include the geometry in the results. This is the default.

Boolean
Result Types
(Optional)

Specifies the type of results to export.

  • Connectivity —Return features that are connected via geometric coincidence or connectivity associations. This is the default.
  • Features —Return feature-level information in the response.
  • Containment and attachment associations —Return features that are associated via containment and structural attachment associations.
Note:

For enterprise geodatabases, this parameter requires ArcGIS Enterprise 10.7 or later.

  • The containment and attachment associations option requires ArcGIS Enterprise 10.8.1 or later.

String
Result Network Attributes
(Optional)

The network attributes that will be included in the results.

Note:

For enterprise geodatabases, this parameter requires ArcGIS Enterprise 10.7 or later.

String
Result Fields
(Optional)

Fields from a feature class that will be returned as results. The values of the field will be returned in the results for the features in the subnetwork.

Note:

For enterprise geodatabases, this parameter requires ArcGIS Enterprise 10.7 or later.

Value Table

Derived Output

LabelExplanationData 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})
NameExplanationData Type
in_utility_network

The utility network that contains the subnetwork to export.

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 to export. 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 is updated.

  • ACKNOWLEDGE —Updates the LASTACKEXPORTSUBNETWORK attribute for the corresponding controller in the Subnetworks table. If the source has been marked for deletion (Is deleted = True), it will be deleted it from the Subnetworks table. This option requires the input utility network to reference the default version.
  • NO_ACKNOWLEDGE —Does not update the LASTACKEXPORTSUBNETWORK attribute for the corresponding controller in the Subnetworks table. This is the default.
Boolean
out_json_file

The name and location of the JSON file to 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, 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.

Condition barrier components are as follows:

  • Name—Choose to filter by any network attribute defined in the system.
  • Operator—Choose from a number of different operators.
  • Type—Choose a specific value or network attribute from the value that is specified in the name parameter.
  • Value—Set a specific value of the input attribute type that would cause termination based on the operator value.
  • Combine Using—Set this value if you have multiple attributes to add. You can combine them using an And or an Or condition.

The condition barrier operator values are as follows:

  • 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 where all bits in the value are present in the attribute (bitwise AND == value).
  • DOES_NOT_INCLUDE_THE_VALUES —A bitwise AND operation where not all of the bits in the value are present in the attribute (bitwise AND != value).
  • INCLUDES_ANY —A bitwise AND operation where at least one bit in the value is present in the attribute (bitwise AND == True).
  • DOES_NOT_INCLUDE_ANY —A bitwise AND operation where none of the bits in the value are present in the attribute (bitwise AND == False).

The condition barrier type options are as follows:

  • SPECIFIC_VALUE —Filter by a specific value.
  • NETWORK_ATTRIBUTE —Filter by a network attribute.

The Combine Using values are as follows:

  • AND —Combine the condition barriers.
  • OR —Use if either condition barrier is met.
Note:

This parameter is only available via Python.

Learn more about using multiple conditional expressions

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.

Function barrier components are as follows:

  • Function—Choose from a number of different calculation functions.
  • Attribute—Choose to filter by any network attribute defined in the system.
  • Operator—Choose from a number of different operators.
  • Value—Set a specific value of the input attribute type that, if discovered, will cause the termination.
  • Use Local Values—Calculate values in each direction as opposed to an overall global value. For example, use for a function barrier that is calculating the sum of Shape length where the trace terminates if the value is greater than or equal to 4. In the global case, after you have traversed two edges with a value of 2, you have already reached a shape length sum of 4, so the trace stops. If local values are used, the local values along each path change, so the trace goes farther.

  • TRUE —Use local values.
  • FALSE —Use global values. This is the default.

Possible values for the function barrier function options are as follows:

  • AVERAGE —The average of the input values.
  • COUNT —The number of features.
  • MAX —The maximum of the input values.
  • MIN —The minimum of the input values.
  • ADD —Add the values.
  • SUBTRACT —Subtract the values. Subnetwork controllers and loops trace types do not support the subtract function.

For example, the starting point feature has a value of 20. The next feature has a value of 30. If you use the minimum function, the result is 20, maximum is 30, add is 50, average is 25, count is 2, and subtract is -10.

The function barrier operator value options are as follows:

  • 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 where all bits in the value are present in the attribute (bitwise AND == value).
  • DOES_NOT_INCLUDE_THE_VALUES —A bitwise AND operation where not all of the bits in the value are present in the attribute (bitwise AND != value).
  • INCLUDES_ANY —A bitwise AND operation where at least one bit in the value is present in the attribute (bitwise AND == True).
  • DOES_NOT_INCLUDE_ANY —A bitwise AND operation where none of the bits in the value are present in the attribute (bitwise AND == False).
Note:

This parameter is only available via Python.

Value Table
include_barriers
(Optional)

Specifies whether the traversability barrier features are included in the trace results. Traversability barriers are optional even if they have been preset in the subnetwork definition.

  • INCLUDE_BARRIERS —Traversability barriers are included in the trace results. This is the default.
  • EXCLUDE_BARRIERS —Traversability barriers are not included in the trace results.
Note:

This parameter is only available via Python.

Boolean
traversability_scope
(Optional)

Specifies the type of traversability to enforce. Traversability scope dictates whether traversability is enforced at junctions, edges, or both. For example, if a condition barrier is defined to stop the trace if DEVICESTATUS is set to Open and the traversability scope is set to edges only, the trace would not stop even if the trace encounters an open device, because DEVICESTATUS is only applicable for junctions. In other words, this parameter indicates to the trace whether to ignore junctions, edges, or both.

  • BOTH_JUNCTIONS_AND_EDGES —Apply traversability to both junctions and edges.
  • JUNCTIONS_ONLY —Apply traversability to only junctions.
  • EDGES_ONLY —Apply traversability to only edges.
Note:

This parameter is only available via Python.

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. 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.

Propagators components are as follows:

  • Attribute—Filter by any network attribute defined in the system.
  • Substitution Attribute—Use a substituted value instead of bitset network attribute values. Substitutions are encoded based on the number of bits in the network attribute being propagated. A substitution is a mapping of each bit in phase to another bit. For example, for Phase AC, one substitution could map bit A to B, and bit C to null. In this example, the substitution for 1010 (Phase AC) is 0000-0010-0000-0000 (512). The substitution captures the mapping so you know that Phase A was mapped to B and Phase C was mapped to null, and not the other way around (that is, Phase A was not mapped to null and Phase C was not mapped to B).
  • Function—Choose from a number of calculation functions.
  • Operator—Choose from a number of operators.
  • Value—Provide a specific value for the input attribute type that would cause termination based on the operator value.

Possible values for the propagators function are as follows:

  • PROPAGATED_BITWISE_AND —Compare the values from one feature to the next.
  • PROPAGATED_MIN —Get the minimum value.
  • PROPAGATED_MAX —Get the maximum value.

The propagator operator values are as follows:

  • 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 where all bits in the value are present in the attribute (bitwise AND == value).
  • DOES NOT INCLUDE_THE_VALUES —A bitwise AND operation where not all of the bits in the value are present in the attribute (bitwise AND != value).
  • INCLUDES_ANY —A bitwise AND operation where at least one bit in the value is present in the attribute (bitwise AND == True).
  • DOES_NOT_INLCUDE_ANY —A bitwise AND operation where none of the bits in the value are present in the attribute (bitwise AND == False).
Note:

This parameter is only available via Python.

Value Table
include_geometry
(Optional)

Specifies whether to include the geometry in the results.

  • INCLUDE_GEOMETRY —Include the geometry in the results.
  • EXCLUDE_GEOMETRY —Do not include the geometry in the results. This is the default.
Note:

For enterprise geodatabases, this parameter requires ArcGIS Enterprise 10.7 or later.

Boolean
result_types
[result_types,...]
(Optional)

Specifies the type of results to export.

  • CONNECTIVITY —Return features that are connected via geometric coincidence or connectivity associations. This is the default.
  • FEATURES —Return feature-level information in the response.
  • CONTAINMENT_AND_ATTACHMENT_ASSOCIATIONS —Return features that are associated via containment and structural attachment associations.
Note:

For enterprise geodatabases, this parameter requires ArcGIS Enterprise 10.7 or later.

  • The containment and attachment associations option requires ArcGIS Enterprise 10.8.1 or later.

String
result_network_attributes
[result_network_attributes,...]
(Optional)

The network attributes that will be included in the results.

Note:

For enterprise geodatabases, this parameter requires ArcGIS Enterprise 10.7 or later.

String
result_fields
[[Feature Class, Field Name],...]
(Optional)

Fields from a feature class that will be returned as results. The values of the field will be returned in the results for the features in the subnetwork.

Note:

For enterprise geodatabases, this parameter requires ArcGIS Enterprise 10.7 or later.

Value Table

Derived Output

NameExplanationData 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.

import arcpy
arcpy.ExportSubnetwork_un("Utility Network", "ElectricDistribution", 
                          "Medium Voltage", "RMT002", "ACKNOWLEDGE", 
                          "C:\\Temp\\RMT002clean.json")

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics

  • An overview of the Utility Network toolbox
  • Find a geoprocessing tool
  • Trace
  • Update Is Connected
  • Update Subnetwork
  • Validate Network Topology

Feedback on this topic?

In this topic
  1. Summary
  2. Usage
  3. Parameters
  4. Environments
  5. Licensing information