Set Circuit Properties (Utility Network Tools)

Summary

Sets the properties for circuits in a telecom domain network.

The circuit properties for a telecom domain network can be modified using this tool. Configuration parameters are used to define circuit properties which are honored when creating or modifying circuits, and when a trace is run on verify, export, and tracing.

Learn more about how to set or modify the circuit properties.

Usage

• This tool allows you to set and alter the circuit properties. To alter the values of a telecom domain network's circuit properties, modify the parameter values and run the tool again.

• The utility network dataset must be utility network version 8 or later and contain a telecom domain network.

• The network topology must be disabled.

• The following requirements must be met when working with an enterprise geodatabase:

  • The active ArcGIS Enterprise portal account must be the portal utility network owner.

  • The Input Utility Network parameter value must be from a database connection established as the database utility network owner.

  • This tool must be connected to the default version to run.

    • All other sessions connected to the default version are blocked from running verify or enable operations during an enable network topology operation.

Parameters

• Dialog
• Python

Label	Explanation	Data type
Input Utility Network	The input utility network that contains the circuit.	Utility Network; Utility Network Layer
Domain Network	The telecom domain network that will be updated.	String
Share circuit locations (Optional)	Specifies whether the features that are used to define the start and stop locations for a circuit can be shared between circuits. This applies to all start and stop locations which define a circuit. A junction or junction object must be assigned the Circuit Location network category to serve as the start or stop location for a circuit or circuit section; however, a line or edge object does not require the Circuit Location network category and can serve as the start or stop location when it does not have connectivity on both the From and To sides. Checked—A feature or object can be used to define more than one circuit Unchecked—A feature or object can only be used to define a single circuit. This is the default.	Boolean
Import circuits as clean (Optional)	Specifies whether circuit definitions will be imported to the Circuit table as Clean or Dirty. Checked—Imported circuits are created with STATUS = Clean and LASTVERIFIED = null. When the network topology is disabled, the STATUS field will not be updated, and circuits remain clean. Unchecked—Imported circuits are created with STATUS = Dirty. When the network topology is disabled, the STATUS field will be updated to Dirty for all circuits. This is the default.	Boolean
Max Hops (Optional)	The maximum number of hops between edges that will be 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 container features and objects traversed during the trace will be included in the trace results. Checked—Container features and objects will be included in the trace results. Unchecked—Container features and objects will not be included in the trace results. This is the default.	Boolean
Include content (Optional)	Specifies whether the trace will include content of containers traversed during the trace will be included in the trace results. Checked—Content of container features and objects will be included in the trace results. Unchecked—Content of container features and objects will not be included in the trace results. This is the default.	Boolean
Include structures (Optional)	Specifies whether structure features and objects with attachments to features traversed during the trace 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. 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
Validate locatability (Optional)	Specifies whether an error will be returned during a trace operation if nonspatial junction or edge objects are encountered without the necessary containment, attachment, or connectivity association in their association hierarchy of the traversed objects. This parameter ensures that nonspatial objects returned by a trace operation can be located through an association with features or other locatable objects. Checked—An error will be returned if nonspatial junction or edge objects are encountered without the necessary containment, attachment, or connectivity association in their association hierarchy of the traversed objects. 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
Summaries (Optional)	The Summary Attribute field that will store function results when verifying a circuit. The summaries can be calculated on all the features that compose the circuit. Calculations can be filtered to apply only to network features with a particular attribute value or category. Note: This parameter is not currently implemented and is reserved for future work. Value table columns: Function—Choose from a number of calculation functions. Minimum—The minimum of the input values. Maximum—The maximum of the input values. Average—The sum of the input values. Count—The average of the input values. Add—The number of features. Subtract—The difference between the input values. Attribute—Filter by any network attribute defined in the system. Filter Name—Filter the function results by attribute name. Filter Operator—Choose from a number of operators. 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)—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). Filter Type—Choose from a number of filter types. Specific value—Filter by a specific value. Network attribute—Filter by a network attribute. Filter Value—Provide a specific value for the input filter attribute. Summary Attribute—The field in the Circuit table that will persist the function result. Depending on the specified function and network attribute type, only the applicable type of user-added attributes will be valid for this parameter. If a field to store the summary result does not exist in the Circuit table, the Add Field tool can be used to create one. A field can only support the result of one summary; each summary requires its own field in the Circuit table. See the Usages section for a matrix of valid field types for the summary attribute field based on the specified function. Learn more about bitwise operators	Value Table
Condition Barriers (Optional)	The traversability barrier condition that will be set on features based on a comparison to a network attribute or a check for a category string. A condition barrier uses a network attribute, 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 column to define an And or an Or condition. Value table columns: Name—Filter by any network attribute or network category defined in the system. Operator—Choose from a number of operators. 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—Choose a specific value or network attribute from the name value. Specific value—Filter by a specific value or network category. Network attribute—Filter by a network attribute. Value—Provide a specific value for the input attribute type that would cause termination based on the operator value. Combine Using—Set this value if you have multiple attributes to add. You can combine them using an And or an Or condition. And—Combine the condition barriers. Or—Filter by a network attribute.	Value Table
Function Barriers (Optional)	Sets a traversability barrier on features based on a function. 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. For example, the length of each line traveled is added to the total distance traveled so far. When the total length traveled reaches the value specified, the trace stops. Value table columns: Function—Choose from a number of calculation functions. Minimum—The minimum of the input values. Maximum—The maximum of the input values. Average—The average of the input values. Count—The number of features. Add—The sum of the input values Subtract—The difference between the input values. Attribute—Filter by any network attribute defined in the system. Operator—Choose from a number of operators. 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). Value—Provide a specific value of the input attribute type that, if discovered, will cause the termination. Use Local Values—Calculate values in each direction as opposed to an overall global value. For example, use for a function barrier that is calculating the sum of a shape length in which the trace terminates if the value is greater than or equal to 4. In the global case, after you have traversed two edges with a value of 2, you have already reached a shape length sum of 4, so the trace stops. If local values are used, the local values along each path change, and the trace continues.	Value Table
Apply Traversability To (Optional)	Specifies the type of traversability that will be applied. Traversability scope determines whether traversability is applied to junctions, edges, or both. For example, if a condition barrier is defined to stop the trace if Device Status is equal to Open and traversability scope is set to edges only, the trace will not stop even if it encounters an open 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. Learn more about wavelength propagation Learn more about bitwise operators 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
User Attributes (Optional)	User-defined attribute fields in the circuit management tables that will mark a circuit as dirty when modified. Value table columns: Circuit Table—The circuit management table containing the user-defined attribute. Attribute Name—The name of a user-defined attribute which will mark the circuit as dirty when modified.	Value Table

Derived output

Label	Explanation	Data type
Updated Utility Network	The updated input utility network.	Utility Network

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics

• An overview of the Administration toolset
• Find a geoprocessing tool