Set Subnetwork Definition (Utility Network)

This ArcGIS 2.8 documentation has been archived and is no longer updated. Content and links may be outdated. See the latest documentation.

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 executed 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 execute the tool again.

  • The network topology must be disabled.

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

Parameters

LabelExplanationData 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 supports 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 option is only available for tiers in domain networks with a partitioned tier definition. Tiers in a domain network with a hierarchical tier definition always have this tier property checked to support disjoint subnetworks.

  • Checked—The input tier supports disjoint subnetworks.
  • Unchecked—The input tier does not support disjoint subnetworks. This is the default.

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.

Summaries components are as follows:

  • Function—Choose from a number of calculation functions.
  • 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.
  • Filter Type—Choose from a number of filter types.
  • Filter Value—Provide a specific value for the input filter attribute.
  • Summary Attribute—The field in the SubnetLine feature class that will persist the function result. Depending on the selected function and network attribute type, only the applicable type of user-added subnetwork attributes will be valid for this parameter. If a field to store the summary result does not exist in the SubnetLine feature class, the Add Field tool can be used to create one. A field can only support the result of one summary; therefore, each summary requires its own field in the SubnetLine feature class. See the following matrix of valid field types for the various functions:
    Matrix of valid field types for the summary attribute field based on the function chosen

The summaries 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 summaries Filter 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 summaries Filter Type value options are as follows:

  • Specific Value—Filter by a specific value.
  • Network Attribute—Filter by a network attribute.

  • AverageThe average of the input values.
  • CountThe number of features.
  • MaxThe maximum of the input values.
  • MinThe minimum of the input values.
  • AddThe sum of the input values.
  • SubtractThe difference of the input values. Subnetwork controllers and loops trace types do not support the subtract function.
  • Is equal toThe attribute is equal to the value.
  • Does not equalThe attribute is not equal to the value.
  • Is greater thanThe attribute is greater than the value.
  • Is greater than or equal toThe attribute is greater than or equal to the value.
  • Is less thanThe attribute is less than the value.
  • Is less than or equal toThe 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).
  • Specific valueFilter by a specific value.
  • Network attributeFilter by a network attribute.
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, 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.
  • Operator—Choose from a number of operators.
  • Type—Choose a specific value or network attribute from the value that is specified in the Name parameter.
  • 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.

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 barriersType value options are as follows:

  • Specific Value—Filter by a specific value.
  • Network Attribute—Filter by a network attribute.

  • Is equal toThe attribute is equal to the value.
  • Does not equalThe attribute is not equal to the value.
  • Is greater thanThe attribute is greater than the value.
  • Is greater than or equal toThe attribute is greater than or equal to the value.
  • Is less thanThe attribute is less than the value.
  • Is less than or equal toThe 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)
  • Specific valueFilter by a specific value.
  • Network attributeFilter by a network attribute.
  • AndCombine the condition barriers.
  • OrUse 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).

  • AverageThe average of the input values.
  • CountThe number of features.
  • MaxThe maximum of the input values.
  • MinThe minimum of the input values.
  • AddThe sum of the input values.
  • SubtractThe difference in the input values.Subnetwork controllers and loops trace types do not support the subtract function.
  • Is equal toThe attribute is equal to the value.
  • Does not equalThe attribute is not equal to the value.
  • Is greater thanThe attribute is greater than the value.
  • Is greater than or equal toThe attribute is greater than or equal to the value.
  • Is less thanThe attribute is less than the value.
  • Is less than or equal toThe 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 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. 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
Apply Traversability To
(Optional)

The type of traversability to enforce. Traversability scope dictates whether traversability is 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 edgesTraversability will be applied to both junctions and edges. This is the default.
  • Junctions onlyTraversability will be applied to junctions only.
  • Edges onlyTraversability will be applied to edges only.
String
Propagators
(Optional)
  • Propagate BITWISE_ANDCompare the values from one feature to the next.
  • Propagate MINGet the minimum value.
  • Propagate MAXGet the maximum value.
  • Is equal toThe attribute is equal to the value.
  • Does not equalThe attribute is not equal to the value.
  • Is greater thanThe attribute is greater than the value.
  • Is greater than or equal toThe attribute is greater than or equal to the value.
  • Is less thanThe attribute is less than the value.
  • Is less than or equal toThe 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 Table
Update Structure Network Containers
(Optional)

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

  • Checked—The structure network containers will be updated. This is the default.
  • Unchecked—The structure network containers will not be updated.

This parameter requires Utility Network Version 4 or later.

Boolean
Update Domain Network Containers
(Optional)

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

  • Checked—The domain network containers will be updated. This is the default.
  • Unchecked—The domain network containers will not be updated.

This parameter requires Utility Network Version 4 or later.

Boolean
Edit Mode For Default Version
(Optional)

Specifies the edit mode for subnetwork updates on the default version and with file geodatabases.

  • Without eventingEventing will not be used for subnetwork updates on the default version and in a file geodatabase. This edit mode updates the subnetwork name and propagated values in place. This is the default.
  • With eventingEventing will be used for subnetwork updates on the default version and in a file geodatabase. This edit mode executes 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.
Note:

This parameter requires Utility Network Version 4 or later.

String
Edit Mode For Named Version
(Optional)

Specifies the edit mode for subnetwork updates on a named version.

  • Without eventingEventing 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 eventingEventing will be used for subnetwork updates on named versions. This edit mode executes 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.
Note:

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

String
Valid Junctions
(Optional)

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

Note:

This parameter requires Utility Network Version 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 Utility Network Version 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 Utility Network Version 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 Utility Network Version 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.

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

This parameter requires Utility Network Version 5 or later.

Boolean
Include Containers
(Optional)

Specifies whether the container features and objects 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.

This parameter requires Utility Network Version 5 or later.

Boolean
Include Content
(Optional)

Specifies whether the trace will return content of containers in the 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.

This parameter requires Utility Network Version 5 or later.

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.

This parameter requires Utility Network Version 5 or later.

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, attachment, or connectivity association in their association hierarchy of the traversed objects. 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—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.

Note:

This parameter requires Utility Network Version 5 or later.

Boolean

Derived Output

LabelExplanationData 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