Title Build Starting Points
The Utility Network must be at least Schema Version 5.
BuildStartingPoints (in_utility_network, trace_config, starting_class, group_by_field, {expression}, {results_trace_config}, {trace_result_type}, {trace_results_output}, {trace_results_input}, {filter_classes}, {skip_found}, {compare_output_name}, out_utility_network, {remove_dup_groups})
| Parameter | Explanation | Data Type |
|---|---|---|
| in_utility_network |
Dialog Reference
<p>The utility network that will be used to trace.</p> |
GPUtilityNetworkLayer |
| trace_config |
Dialog Reference
<p>The utility network trace configuration used to define the trace parameters.</p> |
GPString |
| starting_class |
Dialog Reference
<p>The utility network starting points layer. A UN controlled layer can also be used, the center point of the line/polygon will be used as the starting point. For devices, a default terminal of 1 is used.</p> |
GPComposite |
| group_by_field |
Dialog Reference
<p>A field with a value to group the result locations for the batch trace. Select ObjectID or Global ID to make each set of results unique.</p> |
Field |
| expression (Optional) |
Dialog Reference
<p>The simple calculation expression used to limit the starting points used in a trace.</p> |
GPSQLExpression |
| results_trace_config (Optional) |
Dialog Reference
<p>The trace configuration to use in the result. If not provided, the trace configuration used to find the results will be used.</p> |
GPString |
| trace_result_type (Optional) |
Dialog Reference
<p>Determine how the results are stored.</p> |
GPBoolean |
| trace_results_output (Optional) |
Dialog Reference
<p>The results from the trace in the starting points featureclass format.</p> |
DEFeatureClass |
| trace_results_input (Optional) |
Dialog Reference
<p>The results from the trace in the Utility Network Starting Points featureclass format. If the row with the Global ID/Terminal ID exists, the ISDIRTY field will be updated. If the row does not exist, it will be inserted.</p> |
GPFeatureLayer |
| filter_classes (Optional) |
Dialog Reference
<p>Only store features in these classes. This is useful when tracing a line layer to build starting points. The tool loops over all input features and creates a starting point to trace. If the trace results the features used to trace, they can be skipped to increase performance. This filter allows you to return them and not store them in the result.</p> |
GPMultiValue |
| skip_found (Optional) |
Dialog Reference
<p>If a feature's global id was returned in a trace, do not trace that feature.</p> |
GPBoolean |
| compare_output_name (Optional) |
Dialog Reference
<p>On an update, compare the group by names. When running a batch process, it is best to pick this, but may insert more records instead of updating.</p> |
GPBoolean |
| GPUtilityNetworkLayer | ||
| remove_dup_groups (Optional) |
Dialog Reference
<p>Option to remove duplicate sets of results if they were discovered in a previous trace.</p> |
GPBoolean |
workspace