Update Subnetwork (Utility Network Tools)

Summary

Updates subnetwork information in the Subnetworks table, the SubnetLine feature class, and subnetwork system diagrams for the specified subnetworks.

For the Subnetworks table, this tool changes the status of associated subnetwork controllers to clean (the Is dirty attribute is set to False). If validate consistency failures or subnetwork errors are discovered during tool operation, the status of the associated subnetwork controllers will be marked invalid (the Is dirty attribute is set to Invalid). In the SubnetLine feature class, a record for new subnetworks will be generated, the records for deleted subnetworks will be removed, and the shape and information for modified subnetworks will be updated. Certain attributes will also be created or updated for subnetwork features.

If the update subnetwork policy for a tier is configured so the Is dirty attribute is not managed, the update subnetwork operation can be used to delete rows in the Subnetworks table when the Is deleted attribute is set to true.

Learn more about how to update subnetworks

Usage

The following requirements must be met when working with an enterprise geodatabase:
- The utility network must be registered as branch versioned.
- The input utility network must be from a utility network service.
- The update subnetwork operation can be used on the default version to delete rows in the Subnetworks table for tiers that do not manage the Is dirty attribute.
- If this tool is run on the default version, the geometry, subnetwork name attribute, and propagated fields of the SubnetLine feature class will be updated in place. If this tool is run on a named version, the default behavior (without events) limits updates to features and objects edited in the version. The edit mode can be changed to use events (with events). This option runs geodatabase behavior and can be set in the subnetwork definition for both the default version and named versions.
  
  Learn more about the edit mode used by the Update Subnetwork tool
- Only update a subnetwork using a single process at a time. Do not run the tool with the All subnetworks in tier parameter checked when running multiple processes. This may result in a failure when two processes attempt to update the same subnetwork at the same time.
- 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.
This tool is supported for use with traditional domain networks only.
This tool creates or updates network diagrams for the updated subnetworks if a diagram template was specified when setting the subnetwork definition.
Any edits must be saved before running this tool.
The network topology must be enabled.
No dirty areas exist that intersect with subnetwork features.

Label	Explanation	Data type
Input Utility Network	The utility network that contains the subnetwork.	Utility Network; Utility Network Layer
Domain Network	The domain network that contains the subnetwork.	String
Tier	The tier that contains the subnetwork.	String
All subnetworks in tier	Specifies whether all subnetworks in the tier will be updated. To update a subset of subnetworks in the tier, use the Subnetwork Name parameter. Checked—All subnetworks in the tier will be updated. This option uses asynchronous processing to update the subnetworks using the system UtilityNetworkTools geoprocessing service. The service is reserved for utility network geoprocessing tasks and has a longer default timeout setting. Unchecked—Only the subnetworks that are specified in the Subnetwork Name parameter will be updated. This is the default.	Boolean
Subnetwork Name (Optional)	The name of the subnetwork that will be updated from the tier. If the All subnetworks in tier parameter is checked, this parameter is ignored. When the subnetworks table contains 10,000 or more records for a tier, the parameter's choice list is not populated and an empty field is provided for the subnetwork name.	String
Continue on failure (Optional)	Specifies whether the update process will stop if a subnetwork fails to update when updating multiple subnetworks. Checked—The update process will not stop if a subnetwork failure occurs; it will continue. Unchecked—The update process will stop if a subnetwork failure occurs. 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 Note: This parameter is only available for Python. 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. Note: This parameter is only available for Python. Value table columns: Function—Filter by a function. Min—The minimum of the input values will be identified. Max—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 applied. Traversability scope determines whether traversability will be applied to junctions, edges, or both. For example, if a condition barrier is defined to stop the trace if `DEVICESTATUS` 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 `DEVICESTATUS` is only applicable to junctions. In other words, this parameter indicates to the trace whether to ignore junctions, edges, or both. Note: This parameter is only available for Python. 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 in a traditional domain network. Propagated class attributes denote the key values on subnetwork controllers that are disseminated to the rest of the features in the subnetwork. For example, in an electric distribution model, you can propagate the phase value. Note: This parameter is only available for 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.	Value Table

Derived output

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

arcpy.un.UpdateSubnetwork(in_utility_network, domain_network, tier, all_subnetworks_in_tier, {subnetwork_name}, {continue_on_failure}, {condition_barriers}, {function_barriers}, {include_barriers}, {traversability_scope}, {propagators})

Name	Explanation	Data type
in_utility_network	The utility network that contains the subnetwork.	Utility Network; Utility Network Layer
domain_network	The domain network that contains the subnetwork.	String
tier	The tier that contains the subnetwork.	String
all_subnetworks_in_tier	Specifies whether all subnetworks in the tier will be updated. To update a subset of subnetworks in the tier, use the `subnetwork_name` parameter. `ALL_SUBNETWORKS_IN_TIER`—All subnetworks in the tier will be updated. This option uses asynchronous processing to update the subnetworks using the system UtilityNetworkTools geoprocessing service. The service is reserved for utility network geoprocessing tasks and has a longer default timeout setting. `SPECIFIC_SUBNETWORK`—Only the subnetworks that are specified in the `subnetwork_name` parameter will be updated. This is the default.	Boolean
subnetwork_name (Optional)	The name of the subnetwork that will be updated from the tier. If the `all_subnetworks_in_tier` parameter is set to `ALL_SUBNETWORKS_IN_TIER`, this parameter is ignored.	String
continue_on_failure (Optional)	Specifies whether the update process will stop if a subnetwork fails to update when updating multiple subnetworks. `CONTINUE_ON_FAILURE`—The update process will not stop if a subnetwork failure occurs; it will continue. `STOP_ON_FAILURE`—The update process will stop if a subnetwork failure occurs. This is the default.	Boolean
condition_barriers [[Name, Operator, Type, Value, Combine Using],...] (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 Note: This parameter is only available for Python. 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`—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). `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 [[Function, Attribute, Operator, Value, Use Local Values],...] (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. Note: This parameter is only available for Python. Value table columns: `Function`—Filter by a function. `MIN`—The minimum of the input values will be identified. `MAX`—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`—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`—Filter by a specific value. `Use Local Values`—Boolean value to use local variables instead of a global variable.	Value Table
include_barriers (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. `INCLUDE_BARRIERS`—Traversability barriers will be included in the trace results. This is the default. `EXCLUDE_BARRIERS`—Traversability barriers will not be included in the trace results.	Boolean
traversability_scope (Optional)	Specifies the type of traversability that will be applied. Traversability scope determines whether traversability will be applied to junctions, edges, or both. For example, if a condition barrier is defined to stop the trace if `DEVICESTATUS` 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 `DEVICESTATUS` 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 [[Attribute, Substitution Attribute, Function, Operator, Value],...] (Optional)	Specifies the network attributes to propagate as well as how that propagation will occur during a trace in a traditional domain network. Propagated class attributes denote the key values on subnetwork controllers that are disseminated to the rest of the features in the subnetwork. For example, in an electric distribution model, you can propagate the phase value. Note: This parameter is only available for 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.	Value Table

Derived output

Name	Explanation	Data type
out_utility_network	The updated utility network.	Utility Network

Code sample

UpdateSubnetwork example 1 (Python window)

Update a specific subnetwork named RMT004.

import arcpy
arcpy.un.UpdateSubnetwork("Utility Network", "ElectricDistribution",
                          "Medium Voltage", "SPECIFIC_SUBNETWORK", "RMT004",
                          "CONTINUE_ON_FAILURE")

UpdateSubnetwork example 2 (Python window)

Update all subnetworks in the Medium Voltage tier.

import arcpy
arcpy.un.UpdateSubnetwork("Utility Network", "ElectricDistribution",
                          "Medium Voltage", "ALL_SUBNETWORKS_IN_TIER")

Environments

This tool does not use any geoprocessing environments.

Licensing information

Basic: No
Standard: Yes
Advanced: Yes

Update Subnetwork (Utility Network Tools)

Summary

Usage

License:

Parameters

Note:

Note:

Note:

Note:

Derived output

Environments

Licensing information

Related topics