Validate Network Topology (Utility Network)

Summary

Validates features with dirty areas in the network topology of a utility network after edits have been made.

Learn more about validating a network topology

Usage

  • Inconsistencies between feature spatial edits and the network topology are marked with dirty areas.

  • When working with a utility network in an enterprise geodatabase, it is important to understand the validate operation is handled differently depending on the method used. The Validate command on the Utility Network tab uses synchronous processing, while the Validate Network Topology geoprocessing tool takes advantage of asynchronous processing.

    Dive-in:
    The asynchronous validation process uses the UtilityNetworkTools geoprocessing service. 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.

  • The network topology must be enabled.

  • When working with an enterprise geodatabase, the input utility network must be a utility network service.

  • When working with the Default version in an enterprise geodatabase, only a single session can run the validate operation at a time. While the validate operation is running, the network remains accessible for editing and tracing.

  • When you validate a network topology based on a specific extent, the dirty areas that intersect the specified extent are clipped. To learn more, see Network topology.

  • A trace is used during validate to discover which subnetworks were modified. The results from a validate operation return the name of any subnetwork that is marked as dirty along with its domain network and tier in the response. The output JSON for these Discovered Subnetworks values can be copied from the Message results in the details dialog box.

    • In situations where a subnetwork is dirty before the validate operation is run, the collection of discovered subnetworks will still contain the subnetworks modified by the validate operation.
    • When working with hierarchical networks, if all the subnetworks in a tier are dirty, the tier is not traced during the validate operation. When this scenario is encountered, dirty subnetworks in the tier are not returned in the collection.

  • Failures may be encountered that prevent a validate operation from completing. When this occurs, use the Rebuild Network Topology tool to rebuild the network topology and repair inconsistencies. Rebuilding the topology within the extent ignores dirty areas and applies to all features in the specified extent.

  • License:
    The active portal account must be assigned a license with the ArcGIS Advanced Editing user type extension to use this tool in an enterprise deployment.

Parameters

LabelExplanationData Type
Input Utility Network

The utility network for which the network topology will be validated.

Utility Network; Utility Network Layer
Extent
(Optional)

The geographical extent that will be used to validate the network topology.

  • Current Display Extent Map View—The extent will be based on the active map or scene. This option is only available when there is an active map.
  • Draw Extent Square and Finish—The extent will be based on a rectangle drawn on the map or scene. This option will create a feature class in the project geodatabase and add a layer to the map. The feature class will have the same coordinate system as the map.
    Note:

    This option is not available in the Environments dialog box. It is only available from a tool parameter with an extent data type or from the Environments tab on a tool dialog box.

    Note:

    When the Enable and disable editing from the Edit tab editing option is checked, you must enable editing on the Edit ribbon tab to draw the extent.

  • Extent of a Layer Layer—The extent will be based on an active map layer. Use the drop-down list to choose an available layer or use the Extent of data in all layers option to get the combined extent of all active map layers, excluding the basemap. This option is only available when there is an active map with layers.

    Each map layer has the following options:

    • All Features Select All—The extent of all features in the layer.
    • Selected Features Area from Selected Features—The extent of the selected features in the layer.
    • Visible Features Extent Indicator—The extent of visible features in the layer.
      Note:

      The extents from the Selected Features Area from Selected Features and Visible Features Extent Indicator options are only available for feature layers.

  • Browse Browse—The extent will be based on an existing dataset.
  • Intersection of Inputs Intersect—The extent will be based on the minimum or intersecting extent of all inputs. If no inputs overlap, a null extent with all zeros will result.
  • Union of Inputs Union—The extent will be based on the maximum or combined extent of all inputs.
  • Clipboard Paste—The extent can be copied to and from the clipboard.
    • Copy Extent Copy—Copies the extent coordinates and coordinate system to the clipboard.
    • Paste Extent Paste—Pastes the extent coordinates and, optionally, the coordinate system from the clipboard. If the clipboard values do not include a coordinate system, the extent will use the map’s coordinate system.
    Note:

    The extent coordinates are copied to and pasted from the clipboard using the same formatting and order as the ArcPy Extent object: x-min, y-min, x-max, y-max, and the spatial reference.

  • Reset Extent Reset—The extent will be reset to the default value.
  • Manually entered coordinates—The coordinates must be numeric values and in the active map's coordinate system.
    Caution:

    The map may use different display units than the entered coordinates. The use of a cardinal direction (N, S, E, W) is not supported. Use a negative value sign for south and west coordinates.

Extent

Derived Output

LabelExplanationData Type
Validated Network Topology

The validated utility network.

Utility Network
Output JSON

The subnetworks marked as dirty during the validation operation.

String

arcpy.un.ValidateNetworkTopology(in_utility_network, {extent})
NameExplanationData Type
in_utility_network

The utility network for which the network topology will be validated.

Utility Network; Utility Network Layer
extent
(Optional)

The geographical extent that will be used to validate the network topology. This parameter is similar to the Extent geoprocessing environment.

  • MAXOF—The maximum extent of all inputs will be used.
  • MINOF—The minimum area common to all inputs will be used.
  • DISPLAY—The extent is equal to the visible display.
  • Layer name—The extent of the specified layer will be used.
  • Extent object—The extent of the specified object will be used.
  • Space delimited string of coordinates—The extent of the specified string will be used. Coordinates are expressed in the order of x-min, y-min, x-max, y-max.
Extent

Derived Output

NameExplanationData Type
out_utility_network

The validated utility network.

Utility Network
out_json_payload

The subnetworks marked as dirty during the validation operation.

String

Code sample

ValidateNetworkTopology example (Python window)

Validate a network topology for the entire extent of a utility network named GridNetwork.

import arcpy
arcpy.un.ValidateNetworkTopology('GridNetwork', 'Default')

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics