Validate utility network topology

Demonstrates the workflow of getting the network state and validating the topology of a utility network.

Use case

Dirty areas are generated where edits to utility network features have not been evaluated against the network rules. Tracing across this area could result in an error or return inaccurate results. Validating the utility network updates the network topology with the edited feature data, maintaining consistency between the features and topology. Querying the network state allows you to determine if there are dirty areas or errors in a utility network, and if it supports network topology.

How to use the sample

Select a feature to make edits and then tap “Apply” to send edits to the server.

• Tap “Get state” to check if validate is required or if tracing is available.
• Tap “Validate” to validate network topology and clear dirty areas.
• Tap “Trace” to run a trace.

How it works

1. Create and load a Map with a web map item URL.
2. Load the UtilityNetwork from the web map and switch its ServiceGeodatabase to a new branch version.
3. Add LabelDefinitions for the fields that will be updated on a feature edit.
4. Add the UtilityNetwork.dirtyAreaTable to the map to visualize dirty areas or errors.
5. Set a default starting location and trace parameters to stop traversability on an open device.
6. Get the UtilityNetworkCapabilities from the UtilityNetworkDefinition and use these values to enable or disable the ‘Get State’, ‘Validate’, and ‘Trace’ buttons.
7. When an ArcGISFeature is selected for editing, populate the choice list for the field value using the field’s CodedValueDomain.codedValues.
8. When “Apply” is tapped, update the value of the selected feature’s attribute value with the selected CodedValue.code and call ServiceGeodatabase.applyEdits().
9. When “Get State” is tapped, call UtilityNetwork.state and print the results.
10. When “Validate” is tapped, get the current map extent and call UtilityNetwork.validateNetworkTopology(forExtent:executionType:).
11. When “Trace” is tapped, call UtilityNetwork.trace(using:) with the predefined parameters and select all features returned.
12. When “Clear” or “Cancel” are tapped, clear all selected features on each layer in the map and close the attribute picker.

Relevant API

• UtilityElement
• UtilityElementTraceResult
• UtilityNetwork
• UtilityNetworkCapabilities
• UtilityNetworkState
• UtilityNetworkValidationJob
• UtilityTraceConfiguration
• UtilityTraceParameters
• UtilityTraceResult

About the data

The Naperville electric feature service contains a utility network that can be used to query the network state and validate network topology before tracing. The Naperville electric webmap uses the same feature service endpoint and is shown in this sample. Authentication is required and handled within the sample code.

Additional information

Starting from 200.4, an Advanced Editing extension is required for editing a utility network in the following cases:

• Stand-alone mobile geodatabase that is exported from ArcGIS Pro 2.7 or higher
• Sync-enabled mobile geodatabase that is generated from an ArcGIS Enterprise Feature Service 11.2 or higher
• Web map or service geodatabase that points to an ArcGIS Enterprise Feature Service 11.2 or higher

Please refer to the “Advanced Editing” section in the extension license table in License and deployment for details.

Tags

dirty areas, edit, network topology, online, state, trace, utility network, validate