Export Subnetwork (Utility Network)

This ArcGIS 2.8 documentation has been archived and is no longer updated. Content and links may be outdated. See the latest documentation.

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

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 edgesApply traversability to both junctions and edges.
  • Junctions onlyApply traversability to only junctions.
  • Edges onlyApply 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.

  • ConnectivityReturn features that are connected via geometric coincidence or connectivity associations. This is the default.
  • FeaturesReturn feature-level information in the response.
  • Containment and attachment associationsReturn 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

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics