Export subnetworks

The Export Subnetwork tool is used to export the information (controllers, features, objects, containers, attachments, etc.) which defines a subnetwork to a .json file. This information can then be used by external systems such as outage management and asset tracking programs.

The Export Subnetwork tool also allows you to purge subnetworks from the utility network. This is done by deleting rows from the Subnetworks table where the Is deleted attribute value is true. An Is deleted attribute value of true indicates that the subnetwork controller has been logically deleted and removed from the subnetwork. You can purge a subnetwork from a utility network using the Export Subnetwork tool when all subnetwork controllers associated with the subnetwork have been logically deleted and the Set export acknowledged parameter is checked. When these criteria are met, all corresponding rows representing the controllers for the subnetwork are physically deleted from the Subnetworks table, the subnetwork is purged from the network, and no output .json file is created.

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.

For more information, see Export subnetwork information.

Requirements

To export a subnetwork, 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.
• The name provided for the Subnetwork Name parameter must be a clean subnetwork which has been updated.
• The network topology must be enabled.
• To use the Set export acknowledged parameter, the following must are required:
  • The Input Utility Network parameter value must reference the default branch version.
  • When working with an enterprise geodatabase, the connected ArcGIS Enterprise portal account must be the portal utility network owner.

Export a subnetwork

To export a subnetwork, complete the following steps:

1. On the Analysis tab, click Tools to open the Geoprocessing pane.
2. In the Geoprocessing pane, search for and select Export Subnetwork.
3. For the Input Utility Network parameter, specify a utility network.
4. For the Domain Network parameter, specify a domain network from the drop-down menu.
5. For the Tier parameter, specify a tier from the drop-down menu.
6. For the Subnetwork Name parameter, select the subnetwork from the drop-down menu to export.
7. Optionally, check the Set export acknowledged parameter to delete the record for any subnetwork controllers in the subnetworks table that have been removed as a subnetwork controller.

   Using this parameter requires the default version.

8. For the Output JSON parameter, specify a name and a location for the .json file that will be created.

Note:

The remaining parameters are optional subnetwork details to include in the output .json file.
9. Optionally, for the Include geometry parameter, specify whether feature geometry will be included in the output .json file.
10. Optionally, for the Include domain descriptions parameter, specify whether domain descriptions will be included in the output .json file to communicate domain mapping for controllers, featureElements, connectivity, and associations.

    Note:

    For enterprise geodatabases, the Include domain descriptions parameter requires ArcGIS Enterprise 10.9.1 or later.

11. Optionally, for the Result Types parameter, specify the types of results that will be returned:
    • Connectivity—A connectivity graph of network features in a subnetwork that are connected through geometric coincidence or connectivity associations will be returned.
    • Features—Feature-based information in the response for network features in the subnetwork will be returned.
    • Containment and attachment associations—Network features that are associated through containment and structural attachment associations will be returned.

      Note:

      For enterprise geodatabases, this option requires ArcGIS Enterprise 10.8.1 or later.

    • Related records—Fields from related objects will be returned for features in the subnetwork.

      Note:

      For enterprise geodatabases, this option requires ArcGIS Enterprise 11.5 or later.

12. Optionally, for the Result Network Attributes parameter, select the network attributes to be included in the results.
13. Optionally, for the Result Fields parameter, specify the Feature Class and Field Name attribute field values to be included in the results.
14. Optionally for the Related Record Fields parameter, specify the Relationship Class and Field Name attribute field values from the related objects to be included in the results.
15. Click Run.

Information about the specified subnetwork is exported from the utility network to a .json file. If the Set export acknowledged parameter was checked, rows in the Subnetworks table that were marked as logically deleted are now permanently deleted from the network.

Learn more about the JSON response syntax of the exported subnetwork