Skip to main content

Set Subnetwork Definition (Utility Network Tools)

Summary

Sets the domain network tier's properties for a subnetwork in a utility network.

The types of features that participate in a tier can be restricted by defining valid asset types from the device, line, junction, edge object, and junction object classes. Defining valid asset types helps enforce data correctness by limiting the types of features that can participate in a subnetwork for a specific tier.

Configuration parameters are used to set properties when a trace is run on the subnetwork.

Learn more about setting the subnetwork definition

Learn more about subnetwork management

Learn more about tracing utility networks

Usage

  • This tool also allows you to set and alter the tier's subnetwork definition. To alter the values of the tier's subnetwork definition, modify the parameter values and run the tool again.

  • The network topology must be disabled.

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

    • The connected 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 validate or enable operations during the enable operation.

  • When defining summaries as part of the Subnetwork Trace Configuration parameter category, the Function and Attribute values filter the list of available fields for the summary attribute. The following matrix of valid field types can be used to define the Summary Attribute field based on the specified function and network attribute field type. For example, to create a summary to report the average from a network attribute type of long, you can create a field of type double on the SubnetLine feature class and specify it as the Summary Attribute field.

    Network attribute types matrix

    This is a matrix of valid field types for the summary attribute field based on the specified function.

Parameters

Label Explanation Data type

Input Utility Network

The input utility network that contains the tier's subnetwork.

Utility Network; Utility Network Layer

Domain Network

The domain network that contains the tier.

String

Tier Name

The name of the tier that contains the subnetwork.

String

Support Disjoint Subnetwork

Specifies whether the input tier will support disjoint subnetworks. Disjoint subnetworks are two or more subnetworks that belong to the same tier and have the same subnetwork name but are not traversable. This parameter is only available for tiers in domain networks with a partitioned tier definition. This parameter is set to SUPPORT_DISJOINT by default for tiers in a domain network with a hierarchical tier definition to support disjoint subnetworks.

  • Checked—The input tier will support disjoint subnetworks.

  • Unchecked—The input tier will not support disjoint subnetworks. This is the default except as noted.

Boolean

Valid Devices

(Optional)

The asset group/asset type pairs identified as valid devices for the subnetwork.

String

Valid Device Subnetwork Controllers

(Optional)

The asset group/asset type pairs identified as valid device subnetwork controllers in the subnetwork.

String

Valid Lines

(Optional)

The asset group/asset type pairs identified as valid lines for the subnetwork.

String

Aggregated Lines For SubnetLine Feature Class

(Optional)

The valid lines with geometry that will be aggregated to generate the SubnetLine features. This list is a subset of the values specified in the Valid Lines parameter.

String

Subnetwork Diagram Templates

(Optional)

The templates that will be used to generate subnetwork system diagrams for each subnetwork.

String

Summaries

(Optional)

Sets the Summary Attribute field to store function results when inserting or updating SubnetLine features. The summaries can be calculated on all the features in the subnetwork. Calculations can be filtered to apply only to network features with a particular attribute value or category.

Network attribute types matrix

This is a matrix of valid field types for the summary attribute field based on the specified function.

Value table columns:

  • Function—Calculation 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 of the input values will be calculated. Subnetwork controllers and loops trace types do not support the subtract function.

  • Attribute—Filter by a network attribute.

  • Filter Name—Filter by attribute name.

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

  • Filter Type—Filter by attribute type.

    • Specific value—Filter by a specific value.

    • Network attribute—Filter by a network attribute.

  • Filter Value—Filter by a specific value.

  • Summary Attribute—The field that will persist the function result.

Value Table

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.

Condition barrier components are as follows:

  • Name—Filter by any network attribute defined in the system, or select Category to use a network category.

  • Operator—Choose from a number of operators.

  • Type—Select Specific value or Network attribute for the type of value from the Name parameter that will serve as a barrier. The Type parameter must be set to Specific value when the Name parameter value is Category.

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

  • Combine using—Set this value if you have multiple conditions to add. You can combine them using an And or an Or condition.

The condition barriers Operator value options are as follows:

  • 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—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value).

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

  • Includes any—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—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False).

The condition barriers Type value options are as follows:

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

  • Network Attribute—Filter by a network attribute.

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

Function barrier components are as follows:

  • Function—Choose from a number of calculation functions.

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

  • Operator—Choose from a number of operators.

  • Value—Provide a specific value for 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, a function barrier that is calculating the sum of 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.

    • Checked—Local values will be used.

    • Unchecked—Global values will be used. This is the default.

The function barrier Function value options are as follows:

  • Minimum—The minimum of the input values.

  • Maximum—The maximum of the input values.

  • Add—The sum of the input values.

  • Average—The average of the input values.

  • Count—The number of features.

  • Subtract—The difference between the input values.

    Subnetwork controllers and loops trace types do not support the subtract function.

For example, the starting point feature has a value of 20. The next feature has a value of 30. If you use the minimum function, the result is 20, maximum is 30, add is 50, average is 25, count is 2, and subtract is -10.

The function barrier Operator value options are as follows:

  • 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—A bitwise AND operation in which all bits in the value are present in the attribute (bitwise AND == value).

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

  • Includes any—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—A bitwise AND operation in which none of the bits in the value are present in the attribute (bitwise AND == False).

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 in the input values will be calculated. Subnetwork controllers and loops trace types do not support the subtract function.

  • Attribute—Filter by a network attribute.

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

  • Value—Filter by a specific value.

  • Use Local Values—Boolean value to use local variables instead of a global variable.

Value Table

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.

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

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

Boolean

Apply Traversability To

(Optional)

Specifies the type of traversability that will be enforced. Traversability scope defines whether traversability will be enforced at 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.

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

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

  • 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)
Note:

This parameter is only available in Python.

Value table columns:

  • Attribute—Filter by a network attribute.

  • Substitution Attribute—The field that will be used for attribute substitution.

  • Function—Filter by a function.

  • Operator—Filter by an operator.

  • Value—Filter by a specific value.

  • Propagated Attribute—The name of the field in the network class that is used to store the calculated propagated values.

Value Table

Update Structure Network Containers

(Optional)

Specifies whether the update subnetwork process will update the supported subnetwork name attribute for structure network containers.

Note:

This parameter requires a Utility Network Version value of 4 or later.

  • Checked—The supported subnetwork name attribute for structure network containers will be updated. This is the default.

  • Unchecked—The structure network containers will not be updated.

Boolean

Update Domain Network Containers

(Optional)

Specifies whether the update subnetwork process will update the supported subnetwork name for domain network containers.

Note:

This parameter requires a Utility Network Version value of 4 or later.

  • Checked—The supported subnetwork name for domain network containers will be updated. This is the default.

  • Unchecked—The domain network containers will not be updated.

Boolean

Edit Mode For Default Version

(Optional)

Specifies the edit mode that will be used for subnetwork updates on the default version and with file and mobile geodatabases.

Note:

This parameter requires a Utility Network Version value of 4 or later.

  • Without eventing—Eventing will not be used for subnetwork updates on the default version or in a file or mobile geodatabase. This edit mode updates the subnetwork name and propagated values in place. This is the default.

  • With eventing—Eventing will be used for subnetwork updates on the default version and in a file or mobile geodatabase. This edit mode applies geodatabase behavior (for example, attribute rules, editor tracking, and so on) when the subnetwork is updated and updates the subnetwork name and propagated values for all applicable features and objects.

String

Edit Mode For Named Version

(Optional)

Specifies the edit mode that will be used for subnetwork updates on a named version.

Note:

This parameter requires a Utility Network Version value of 4 or later and is only applicable to enterprise geodatabases.

  • Without eventing—Eventing will not be used for subnetwork updates on named versions. This edit mode updates the subnetwork name and propagated values in place for features and objects edited in the version. This is the default.

  • With eventing—Eventing will be used for subnetwork updates on named versions. This edit mode applies geodatabase behavior (for example, attribute rules, editor tracking, and so on) when the subnetwork is updated and updates the subnetwork name and propagated values for all applicable features and objects.

String

Valid Junctions

(Optional)

The asset group/asset type pairs identified as valid junctions for the subnetwork.

Note:

This parameter requires a Utility Network Version value of 4 or later.

String

Valid Junction Objects

(Optional)

The asset group/asset type pairs identified as valid junction objects for the subnetwork.

Note:

This parameter requires a Utility Network Version value of 4 or later.

String

Valid Junction Object Subnetwork Controllers

(Optional)

The asset group/asset type pairs identified as valid junction object subnetwork controllers for the subnetwork.

Note:

This parameter requires a Utility Network Version value of 4 or later.

String

Valid Edge Objects

(Optional)

The asset group/asset type pairs identified as valid edge objects for the subnetwork.

Note:

This parameter requires a Utility Network Version value of 4 or later.

String

Manage IsDirty

(Optional)

Specifies whether the Is dirty attribute in the Subnetworks table will be managed by the update subnetwork operation. If no subnetwork controllers are defined for the tier, the NOT_MANAGE option is used by default.

Note:

This parameter requires a Utility Network Version value of 5 or later.

  • Checked—The Is dirty attribute will be managed by the update subnetwork operation. This is the default except as noted.

  • Unchecked—The Is dirty attribute will not be managed by the update subnetwork operation.

Boolean

Include Containers

(Optional)

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

This parameter requires a Utility Network Version value of 5 or later.

  • Checked—Container features and objects will be included in the trace results. The supported subnetwork name field on container features will be updated with the subnetwork name of the subnetwork it supports when used in conjunction with the update_structure_features and update_container_features parameters.

  • 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 in the results.

This parameter requires a Utility Network Version value of 5 or later.

  • Checked—Content of container features and objects will be included in the trace results. During an update subnetwork operation, the supporting subnetwork name field will be updated for content features returned by the trace.

  • Unchecked—Content of container features and objects will not be included in the trace results. The supporting subnetwork name is not updated for content features during the update subnetwork operation. This is the default.

Boolean

Include Structures

(Optional)

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

This parameter requires a Utility Network Version value of 5 or later.

  • Checked—Structure features and objects will be included in the trace results. During an update subnetwork operation, the supported subnetwork name field will be updated for structure network features associated with attachments returned by the trace.

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

Boolean

Validate Locatability

(Optional)

Specifies whether an error will be returned during a trace or update subnetwork operation if nonspatial junction or edge objects are encountered without the necessary 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.

Note:

This parameter requires a Utility Network Version value of 5 or later.

  • Checked—An error will be returned if unlocatable nonspatial junction or edge objects are encountered without the necessary 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

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