Title Batch Trace
Iterate through the starting points to trace the utility network and use the results.
This tool uses a with starting point information to trace the utility network. The starting points are optionally grouped so set of starting points is used in each trace.
The trace results can be used to select features in a map, calculate values on results, create connectivity and element files or save the aggregated geometry with summary information.
The starting points layer uses a field to determine if a row is a starting point and/or barrier. A feature as a starting point and filter barrier is useful in a connected trace to determine all the items between the starting points.
The starting points table requires the following fields:
- FEATUREGLOBALID: GUID
- TERMINALID: Short
- PERCENTALONG: Double
BatchTrace (in_utility_network, trace_locations, result_types, trace_config, {expression}, {output_folder}, {key_field}, {summary_store_field}, {fields}, {calc_on_start})
Parameter | Explanation | Data Type |
---|---|---|
in_utility_network |
Dialog Reference
The utility network that will be used to trace. There is no python reference for this parameter. |
GPUtilityNetworkLayer |
trace_locations |
Dialog Reference
The table from which to load starting points for trace. There is no python reference for this parameter. |
GPTableView |
result_types |
Dialog Reference
Specifies the type of results that will be returned by the trace.
There is no python reference for this parameter. |
GPString |
trace_config |
Dialog Reference
The utility network trace configuration used to define the trace parameters or a field with trace configurations. There is no python reference for this parameter. |
GPString |
expression (Optional) |
Dialog Reference
The simple calculation expression used to limit the starting points used in a trace. There is no python reference for this parameter. |
GPSQLExpression |
output_folder (Optional) |
Dialog Reference
The location of the output json files and mobile geodatabase with the aggregated geometry. This parameter is only applicable for the Aggregated Geometry, Elements or Connectivity result type. There is no python reference for this parameter. |
DEFolder |
key_field (Optional) |
Dialog Reference
Field used to group starting points and barriers. When specified, records with the same value will used for a single trace. By default, a trace is run for every starting point. There is no python reference for this parameter. |
Field |
summary_store_field (Optional) |
Dialog Reference
Optional field used to store summary results on the starting points. There is no python reference for this parameter. |
GPString |
fields (Optional) |
Dialog Reference
The mapping of starting points field to network source field. This parameter is only applicable for the Calculation result type. Mapping components are as follows:
There is no python reference for this parameter. |
GPValueTable |
calc_on_start (Optional) |
Dialog Reference
If specified, the calculate will also update the features the starting points are placed on. There is no python reference for this parameter. |
GPBoolean |
There are no code samples for this tool.
There are no tags for this item.
There are no credits for this item.
There are no access and use limitations for this item.