Skip to main content

Export Circuits (Utility Network Tools)

Summary

Exports feature and connectivity information about the features and objects that compose circuits in a telecom domain network. The data is saved as separate .json files for each circuit in a specified output folder.

The exported data can be used for archiving or as input to other tools using ModelBuilder, script or model tools, or through integration with external third-party systems.

Note:

The export circuits operation is processed 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.

Learn more about exporting circuits

Usage

  • The Input Utility Network parameter value must reference a Utility Network Version value of 8 or later.

  • 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 connected ArcGIS Enterprise portal account must be the portal utility network owner.

    • 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.

  • When the Set export acknowledged parameter is checked, the following are required:

    • The network topology must be enabled.

    • The Input Utility Network parameter value must reference the default branch version.

Parameters

Label Explanation Data type

Input Utility Network

The utility network that contains the circuits that will be exported.

Utility Network; Utility Network Layer

Domain Network

The telecom domain network that contains the circuits that will be exported.

String

Set export acknowledged

Specifies whether the LASTEXPORTED attribute for the corresponding circuit in the Circuit table will be updated.

  • Checked—The LASTEXPORTED attribute for the corresponding circuit in the Circuit table will be updated. If the circuit has been marked for deletion (Status = Deleted), it will be removed from the utility network. The Input Utility Network parameter must reference the default version to use this option.

  • Unchecked—The LASTEXPORTED attribute for the corresponding circuit in the Circuit table will not be updated. This is the default.

Boolean

Output folder

The name and location of the output folder that will store the .json files created for each exported circuit.

Folder

Max Hops

(Optional)

The maximum number of hops between edges allowed in the path, excluding the start location. All edges and junction-junction connectivity associations are evaluated as having a fixed unit length of 1 on traversal. The default is 100.

Long

Include Containers

(Optional)

Specifies whether the container features will be included in the trace results.

  • Checked—Container features will be included in the trace results.

  • Unchecked—Container features will not be included in the trace results. This is the default.

Boolean

Include up to First Spatial Container

(Optional)

Specifies whether the containers returned will be limited to those encountered up to, and including, the first spatial container for each network element in the trace results. If no spatial containers are encountered but nonspatial containers are present for a given network element, all nonspatial containers will be included in the results. This parameter is only enabled when include_containers is set to INCLUDE_CONTAINERS.

  • Checked—Only containers encountered up to, and including, the first spatial container will be returned in the results when nested containment associations are encountered along the trace path. If no spatial containers exist, all nonspatial containers will be included in the results for a given network element.

  • Unchecked—All containers will be returned in the results. This is the default.

Boolean

Include Content

(Optional)

Specifies whether the trace will return content in container features in the results.

  • Checked—Content in container features will be included in the trace results.

  • Unchecked—Content in container features will not be included in the trace results. This is the default.

Boolean

Include Structures

(Optional)

Specifies whether structure features and objects will be included in the trace results.

  • Checked—Structure features and objects will be included in the trace results.

  • Unchecked—Structure features and objects will not be included in the trace results. This is the default.

Boolean

Include Barrier Features

(Optional)

Specifies whether the traversability barrier features will be included in the trace results. Traversability barriers are optional even if they have been preset in the subnetwork definition. This parameter does not apply to device features with terminals.

  • Checked—Traversability barrier features will be included in the trace results. This is the default.

  • Unchecked—Traversability barrier features will not be included in the trace results.

Boolean

Ignore Barriers At Starting Points

(Optional)

Specifies whether dynamic barriers in the trace configuration will be ignored for starting points.

  • Checked—Barriers at starting points will be ignored in the trace.

  • Unchecked—Barriers at starting points will not be ignored in the trace. This is the default.

Boolean

Validate Locatability

(Optional)

Specifies whether an error will be returned during a trace if nonspatial junction or edge objects are encountered without the necessary connectivity, containment, or attachment association in their association hierarchy. This parameter ensures that nonspatial objects returned by a trace or update subnetwork operation can be located through an association with features or other locatable objects.

  • Checked—The trace will return an error if unlocatable nonspatial junction or edge objects are encountered without the necessary connectivity, containment, or attachment association in their association hierarchy.

  • Unchecked—The trace will not check for unlocatable objects and will return results regardless of whether unlocatable objects are present in the association hierarchy of the traversed objects. This is the default.

Boolean

Run in asynchronous mode on the server

(Optional)

Specifies whether the export operation will process asynchronously when working with a utility network in an enterprise geodatabase.

  • Checked—Export operations will process asynchronously.

  • Unchecked—Export operations will process synchronously. This is the default.

Boolean

Condition Barriers

(Optional)

Sets a traversability barrier condition on features based on a comparison to a network attribute or check for a category string. A condition barrier uses a network attribute or network category, an operator and a type, and an attribute value. For example, stop a trace when a feature has the Device Status attribute equal to the specific value of Open. When a feature meets this condition, the trace stops. If you're using more than one attribute, you can use the Combine using parameter to define an And or an Or condition.

Learn more about using multiple conditional expressions

Value table columns:

  • Name—Filter by network attribute name.

  • Operator—Filter by an operator.

    • Is equal to—The attribute is equal to the value.

    • Does not equal—The attribute is not equal to the value.

    • Is greater than—The attribute is greater than the value.

    • Is greater than or equal to—The attribute is greater than or equal to the value.

    • Is less than—The attribute is less than the value.

    • Is less than or equal to—The attribute is less than or equal to the value.

    • Includes the values (bitwise AND equals the value)—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value).

    • Does not include the values (bitwise AND does not equal the value)—A bitwise AND operation in which not all of the bits in the value are present in the attribute (bitwise AND != value).

    • Includes any (bitwise AND equals True)—A bitwise AND operation in which at least one bit in the value is present in the attribute (bitwise AND == True).

    • Does not include any (bitwise AND equals False)—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False).

  • Type—Filter by a specific type.

    • Specific value—Filter by a specific value or network category.

    • Network attribute—Filter by a network attribute.

  • Value—Filter by a specific value.

  • Combine Using—Use this parameter to combine multiple condition barriers.

    • And—Combine the condition barriers.

    • Or—Use if either condition barrier is met.

Value Table

Function Barriers

(Optional)

Sets a traversability barrier on features based on a function to restrict the circuit trace used to filter the circuits that will be exported. Function barriers can be used to do such things as restrict how far the trace travels from the starting point, or set a maximum value to stop a trace. This can be used to constrain the circuits that will be exported. For example, consider a scenario where you want to export circuits with a length greater than 1 kilometer. A function barrier could be used to only export the specified circuits when the total length exceeds 1,000 meters.

Value table columns:

  • Function—Filter by a function.

    • Minimum—The minimum of the input values will be identified.

    • Maximum—The maximum of the input values will be identified.

    • Average—The average of the input values will be calculated.

    • Count—The number of features will be identified.

    • Add—The sum of the input values will be calculated.

    • Subtract—The difference between the input values will be calculated.

  • Attribute—Filter by a network attribute.

  • Operator—Filter by an operator.

    • Is equal to—The function result is equal to the value.

    • Does not equal—The function result is not equal to the value.

    • Is greater than—The function result is greater than the value.

    • Is greater than or equal to—The function result is greater than or equal to the value.

    • Is less than—The function result is less than the value.

    • Is less than or equal to—The function result is less than or equal to the value.

    • Includes the values (bitwise AND equals the value)—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value).

    • Does not include the values (bitwise AND does not equal the value)—A bitwise AND operation in which not all of the bits in the value are present in the attribute (bitwise AND != value).

    • Includes any (bitwise AND equals True)—A bitwise AND operation in which at least one bit in the value is present in the attribute (bitwise AND == True).

    • Does not include any (bitwise AND equals False)—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False).

  • Value—Filter by a specific value.

  • Use Local Values—Boolean value that uses local variables instead of a global variable.

Value Table

Apply Traversability To

(Optional)

Specifies whether traversability barriers will be applied to junctions, edges, or both. For example, if a condition barrier is defined to stop the trace if Device Status is equal to Proposed and traversability scope is set to edges only, the circuit trace will not stop—even if it encounters a proposed device—because Device Status is only applicable to junctions. In other words, this parameter indicates to the trace whether to ignore junctions, edges, or both.

  • Both junctions and edges—Traversability will be applied to both junctions and edges. This is the default.

  • Junctions only—Traversability will be applied to junctions only.

  • Edges only—Traversability will be applied to edges only.

String

Propagators

(Optional)

Specifies the network attributes to propagate as well as how that propagation will occur during a trace. Propagated class attributes denote the key values on features in a network that are disseminated to the rest of the features in the circuit. For example, in a telecom domain network, you can propagate wavelengths values from features defined as circuit locations.

Note:

This parameter is only available for Python.

Value table columns:

  • Attribute—Filter using any network attribute defined in the system.

  • Substitution Attribute—Substitution is not supported with telecom domain networks.

  • Function—Wavelength propagation supports use of the function PROPAGATED_BITWISE_AND.

  • Operator—Choose from the operators INCLUDES_ANY and DOES_NOT_INCLUDE_ANY for wavelength propagation.

  • Value—Provide a specific value for the input attribute type that would cause termination based on the operator value.

Value Table

Include geometry

(Optional)

Specifies whether geometry will be included in the results.

  • Checked—Geometry will be included in the results.

  • Unchecked—Geometry will not be included in the results. This is the default.

Boolean

Include domain descriptions

(Optional)

Specifies whether domain descriptions will be included in the output .json file to communicate domain mapping for circuits. This parameter does not apply to the circuits result types option.

  • Checked—Domain descriptions will be included in the results.

  • Unchecked—Domain descriptions will not be included in the results. This is the default.

Boolean

Synthesize Geometries

(Optional)

Specifies whether geometries will be inferred and created (synthesized) for nonspatial junction and edge objects traversed as part of a circuit trace when using the circuits result types option.. The include_geometry parameter must also be true to include geometry in the output .json file.

  • Checked—Geometries will be inferred and created for the traversed nonspatial junction and edge objects in the output .json file.

  • Unchecked—Geometries will not be synthesized for the traversed nonspatial junction and edge objects. This is the default.

Boolean

Result Types

(Optional)

Specifies the types of results that will be returned.

  • Connectivity—Features that are connected through geometric coincidence or connectivity associations will be returned. This is the default.

  • Features—Feature-level information will be returned. This is the default.

  • Containment and attachment associations—Features that are associated through containment and structural attachment associations will be returned.

  • Circuits—The circuit definition will be returned with the option to include path connectivity information and geometry for each section in the circuit.

String

Result Network Attributes

(Optional)

The network attributes that will be included in the results when using the Features result types option.

String

Result Fields

(Optional)

The fields from a feature class that will be returned as results when using the Features result types option. The values of the fields will be returned in the results for the features in the circuit.

Value table columns:

  • Feature Class—A feature or object class that participates in the utility network.

  • Field Name—The name of a field from the feature or object class that will have its values returned in the results.

Value Table

Derived output

Label Explanation Data type

Updated Utility Network

The updated utility network.

Utility Network

Updated Workspace

The updated workspace.

Utility Network

Output Circuits Table

The output table containing information about the exported circuits.

Value Table

Environments

This tool does not use any geoprocessing environments.

Licensing information

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