Summary
Updates subnetwork information in the Subnetworks table, the SubnetLine feature class, and subnetwork system diagrams for the specified subnetworks. Also certain attributes are created or updated for subnetwork features. A record for any new subnetworks will be generated, the records for any deleted subnetworks will be removed, and the shape and information for any modified subnetworks will be updated.
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.
- If this tool is executed on the default version, the geometry, subnetwork name attribute, and propagated fields of the SubnetLine feature class are updated in place. If executed against 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 executes 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
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 prior to running this tool.
The network topology must be enabled.
No dirty areas exist that intersect with subnetwork features.
Syntax
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})
Parameter | 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 (Optional) | Specifies whether all subnetworks in the tier are updated. To update a subset of subnetworks in the tier, use the subnetwork_name parameter.
| Boolean |
subnetwork_name (Optional) | The name of the subnetworks to update. If all subnetworks will be updated using the all_subnetworks_in_tier parameter, this parameter is ignored. | String |
continue_on_failure (Optional) | Specifies whether to stop the update process if a subnetwork fails to update when updating multiple subnetworks.
| 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, 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:
The condition barrier Operator values are as follows:
The condition barrier type options are as follows:
The Combine Using values are as follows:
Note:This parameter is only available via Python. | 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. Function barrier components are as follows:
Possible values for the function barrier function options are as follows:
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:
Note:This parameter is only available via Python. | Value Table |
include_barriers (Optional) | Specifies whether the traversability barrier features are included in the trace results. Traversability barriers are optional even if they have been preset in the subnetwork definition.
Note:This parameter is only available via Python and ModelBuilder. | Boolean |
traversability_scope (Optional) | Specifies 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 DEVICESTATUS is equal to Open and traversability scope is set to edges only, the trace would not stop even if the trace encounters an open device, because the DEVICESTATUS is only applicable for junctions. In other words, this parameter indicates to the trace whether to ignore junctions, edges, or both.
Note:This parameter is only available via Python and ModelBuilder. | 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. 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. Propagators components are as follows:
Possible values for the propagators function are as follows:
The propagator operator values are as follows:
Note:This parameter is only available via Python and ModelBuilder. | Value Table |
Derived Output
Name | Explanation | Data Type |
out_utility_network | The updated utility network. | Utility Network |
Code sample
Update a specific subnetwork named RMT004.
import arcpy
arcpy.UpdateSubnetwork_un("Utility Network", "ElectricDistribution",
"Medium Voltage", "SPECIFIC_SUBNETWORK", "RMT004",
"CONTINUE_ON_FAILURE")
Update all subnetworks in the Medium Voltage tier.
import arcpy
arcpy.UpdateSubnetwork_un("Utility Network", "ElectricDistribution",
"Medium Voltage", "ALL")
Environments
Licensing information
- Basic: No
- Standard: Yes
- Advanced: Yes