Skip to content

Esri/di-utility-network-export-subnetwork-by-rest

Repository files navigation

di-utility-network-export-subnetwork-by-rest

This repo provides a no-code solution using ArcGIS Data Interoperability for ArcGIS Pro to automate Exporting Subnetwork for a Utility Network dataset published on an ArcGIS Enterprise platform on the most current UN version.

The original source of this no-code solution was first published in ArcGis Blog in the two-part blog series written by Jon De Rose and Renato Salvaleon.

Leveraging Data for External Systems - Automating Export Subnetwork using Data Interoperability
Part One
Part Two

You can still find the blog's workspace solution from part two of the blog or in this repo's UNv3 release page.

Features

Converts JSON result of an export subnetwork REST API call to the following outputs: Mobile GDB, File GDB, CAD and shapefile.

Limitations

  1. Utility Networks that are stored in file geodatabase or mobile geodatabases are out of scope.
  2. No filters or validation were made for Subnetworks where ISDIRTY = 1. If an attempt was made to export a dirty subnetwork, the JSON return on the Export Subnetwork HTTPCaller will return the following error code and message:
 "extendedCode": -2147208457, "message": "Dirty subnetwork cannot be exported.",

Solutions

  1. Export Subnetwork only
  2. Export Subnetwork plus customer fields
  3. Helper workspace template to use for populating your user parameters for Domain network, Tier name, Subnetwork name. The helper list will also generate a list of subnetwork to use for automating Export Subnetwork for your entire utility network dataset.

Note

The helper solution uses the ArcGIS Server feature service reader format which is new to Pro 3.1. The advantage of using this format is there is no JSON to parse and no max record counts and paging to consider. For earlier versions of Pro use the HTTPCaller configuring the query rest endpoint of the Layer: Subnetworks (ID: 500002).

Instructions

Solutions 1 and 2 will have instructions in their respective readme.md file. For the helper file, there is an annotation on the worksapce canvass to follow.

Requirements

  • Data Interoperability for ArcGIS Pro 3.1 or higher
  • ArcGIS Pro 3.1 or higher
  • Enterprise Utility Network with a schema of UNv6 or higher

Suggestions for modifying the solutions

  1. Enable both the Feature Cache and Feature Counts tools while authoring.
  2. Test small, test often at the beginning. Start with the reader first.
  3. Use the Play buttons on the canvass object as you tweak the existing solution, until you get to your destination datasets.
  4. When configuring your own utlity network for this solution, leave the existing format reader on the canvas and use the Add reader tool. After the schema hydrates connect to the existing transformer from which the original reader is connected to. Once the new feature types is connected to the transformer, you can delete the original reader from the navigation pane.
  5. When you are satisfied with the state of your solution, you can disable both Feature Cache and Feature Counts.
  6. If you are reauthoring your solution to have multiple outputs, test the solution one output format at a time.

Resources

Below are links to essential references used in the blogs.

Utility Network docs:

Utility Network blogs (latest on top):

Name and Link Pro/Enterprise Version Date
Network Integrations 3.1/11.1 6/13/2023
Parsing Utility Network JSON Files (Python) 3.1/11.1 8/31/2023
Adding Description to Export Subnetwork JSON blog 2.4 3/10/2020
Command line automation for Utility Network blog 2.1/10.6 6/5/2018
Web Trace tool Blog 2.1/10.6 2/28/2018

Data Interoperability doc and related Automation blogs

JSON tutorial references:

Issues

Find a bug or want to request a new feature? Please let us know by submitting an issue.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Licensing

Copyright 2023 Esri

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's license.txt file.

[](Esri Tags: Data Interoperability for ArcGIS Pro) [](Esri Tags: Utility Network)