Enable Network Topology (Utility Network)

Summary

Enables a network topology for a utility network.

A network topology is needed for analytic operations such as tracing and network diagrams. A network topology can also be enabled to find error features.

Learn more about how to enable a network topology

Usage

  • Some network configuration tasks can only be performed before the network topology is enabled for the first time. See Utility network management tasks for tasks specific to this tool and the required network topology state.

  • All utility network features classes must have a spatial index.

  • When working with an enterprise geodatabase the following are requirements:

    • If the Input Utility Network is from a database connection, the connection must be established as the database utility network owner.

    • The connected ArcGIS Enterprise portal account must be the portal utility network owner.
    • This tool must be connected to the default version when executed.
    • The utility network must be registered as branch versioned.
    • The utility network must be in a nonversioned state to use the Only generate errors advanced option.

Parameters

LabelExplanationData Type
Input Utility Network

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

Utility Network; Utility Network Layer
Maximum number of errors
(Optional)

The maximum number of errors before the process of enabling the network topology will stop, and errors will be recorded in the errors table. The default value is 10000.

Caution:

Increasing the maximum number of errors value will increase the length of time to enable the topology. Setting a value higher than the default value of 10000 is not recommended.

Long
Only generate errors
(Optional)

Specifies whether the topology will be enabled or only network errors will be generated.

  • Checked—The utility network will only be evaluated for network errors. The topology will not be enabled. If you are working with an enterprise geodatabase, the data cannot be registered as versioned. This allows you to inspect and fix errors in the network until you are ready to enable the topology.
  • Unchecked—The topology will be enabled and any errors that exist will generate dirty areas with errors. This is the default.
Boolean

Derived Output

LabelExplanationData Type
Updated Utility Network

The updated utility network.

Utility Network

arcpy.un.EnableNetworkTopology(in_utility_network, {max_number_of_errors}, {only_generate_errors})
NameExplanationData Type
in_utility_network

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

Utility Network; Utility Network Layer
max_number_of_errors
(Optional)

The maximum number of errors before the process of enabling the network topology will stop, and errors will be recorded in the errors table. The default value is 10000.

Caution:

Increasing the maximum number of errors value will increase the length of time to enable the topology. Setting a value higher than the default value of 10000 is not recommended.

Long
only_generate_errors
(Optional)

Specifies whether the topology will be enabled or only network errors will be generated.

  • ONLY_ERRORSThe utility network will only be evaluated for network errors. The topology will not be enabled. If you are working with an enterprise geodatabase, the data cannot be registered as versioned. This allows you to inspect and fix errors in the network until you are ready to enable the topology.
  • ENABLE_TOPOThe topology will be enabled and any errors that exist will generate dirty areas with errors. This is the default.
Boolean

Derived Output

NameExplanationData Type
out_utility_network

The updated utility network.

Utility Network

Code sample

EnableNetworkTopology example 1 (Python window)

Enable the network topology for a utility network called MyNetwork and set the maximum number of errors to 500 using the EnableNetworkTopology tool.

import arcpy
arcpy.EnableNetworkTopology_un('MyNetwork', 500)
EnableNetworkTopology example 2 (Python window)

Only generate errors for a utility network called MyNetwork using the EnableNetworkTopology tool.

import arcpy
arcpy.EnableNetworkTopology_un('MyNetwork', '', 'ONLY_ERRORS')

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics