Display Name: Trace
Description: Returns selected features in a trace network based on connectivity or traversability from the specified starting points.
Category:
Help URL: https://gis.waukesha-wi.gov/server/rest/directories/arcgisoutput/Tools/Trace_GPServer/Tools_Trace/Trace.htm
Execution Type: esriExecutionTypeAsynchronous
Parameters:
Parameter: in_trace_network
Data Type: GPString
Display Name Input Trace Network
Description: The trace network on which the trace will be run. When working with an enterprise geodatabase, an input trace network must be from a feature service; a trace network from a database connection is not supported.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: L2TestTraceNetwork_Trace_Network Trace Network
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ L2TestTraceNetwork_Trace_Network Trace Network ]
Parameter: trace_type
Data Type: GPString
Display Name Trace Type
Description: Specifies the type of trace to execute.Connected—A connected trace that begins at one or more starting points and spans outward along connected features will be used.Upstream—An upstream trace that discovers features upstream from a location in the network will be used. This type of trace requires the flow direction to be set.Downstream—A downstream trace that discovers features downstream from a location in the network will be used. This type of trace requires the flow direction to be set.Shortest path—A shortest path trace that finds the shortest path between two starting points in the network regardless of flow direction will be used. The cost of traversing the path is determined based on the network attribute set for the Shortest Path Network Attribute Name parameter.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: CONNECTED
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ CONNECTED, UPSTREAM, DOWNSTREAM, SHORTEST_PATH ]
Parameter: starting_points
Data Type: GPString
Display Name Starting Points
Description: A feature layer created using the Starting Points tab in the Trace Locations pane, or a table or feature class containing one or more records that represent the starting points of the trace. The TN_Temp_Starting_Points feature class is used by default and is generated in the default geodatabase of the project when you create starting points using the Starting Points tool in the Trace Locations pane.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Trace\TN_Temp_Starting_Points
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ TraceResults\L1cow_pub_test_UNOWNER_SManholeTest, TraceResults\L0cow_pub_test_UNOWNER_SGravityMainTest, TN_Temp_Starting_Points, cow_pub_test.UNOWNER.SManholeTest, cow_pub_test.UNOWNER.SGravityMainTest, L2TestTraceNetwork_Trace_Network Trace Network\Point Errors, L2TestTraceNetwork_Trace_Network Trace Network\Line Errors, L2TestTraceNetwork_Trace_Network Trace Network\Dirty Areas, L2TestTraceNetwork_Trace_Network Trace Network\System Junctions ]
Parameter: barriers
Data Type: GPFeatureRecordSetLayer
Display Name Barriers
Description: A table or feature class containing one or more features that represent the barriers of the trace that prevent the trace from traversing beyond that point. The TN_Temp_Barriers feature class is used by default and is generated in the default geodatabase of the project when you create barriers using the Barriers tab in the Trace Locations pane.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPoint
HasZ: true
HasM: true
Spatial Reference: 103191
(6609)
Fields:
-
OBJECTID
(
type: esriFieldTypeOID, alias: OBJECTID
)
-
LAYERID
(
type: esriFieldTypeInteger, alias: LAYERID
)
-
GLOBALID
(
type: esriFieldTypeGlobalID, alias: GLOBALID, length: 38
)
-
LAYERNAME
(
type: esriFieldTypeString, alias: LAYERNAME, length: 255
)
-
SOURCEID
(
type: esriFieldTypeInteger, alias: SOURCEID
)
-
FEATUREGLOBALID
(
type: esriFieldTypeGUID, alias: FEATUREGLOBALID, length: 38
)
-
FEATUREOID
(
type: esriFieldTypeInteger, alias: FEATUREOID
)
-
PERCENTALONG
(
type: esriFieldTypeDouble, alias: PERCENTALONG
)
-
DISPLAYNAME
(
type: esriFieldTypeString, alias: DISPLAYNAME, length: 255
)
Features: None.
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: path_direction
Data Type: GPString
Display Name Path Direction
Description: Specifies the direction of the trace path. The cost of traversing the path is determined by the Shortest Path Network Attribute Name parameter value. This parameter is only honored when running a Shortest path trace type.NO_DIRECTION—The path between the two starting points, regardless of the direction of flow, will be used. This is the default.PATH_UPSTREAM—The upstream path between the two starting points will be used.PATH_DOWNSTREAM—The downstream path between the two starting points will be used.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: NO_DIRECTION
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ NO_DIRECTION, PATH_UPSTREAM, PATH_DOWNSTREAM ]
Parameter: shortest_path_network_attribute_name
Data Type: GPString
Display Name Shortest Path Network Attribute Name
Description: The name of the network attribute used to calculate the path. When running a shortest path trace type, the shortest path is calculated using a numeric network attribute such as shape length. Cost and distance based paths can both be achieved. This parameter is required when running a shortest path trace.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: include_barriers
Data Type: GPBoolean
Display Name Include Barrier Features
Description: Specifies whether the traversability barrier features will be included in the trace results.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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: validate_consistency
Data Type: GPBoolean
Display Name Validate Consistency
Description: Specifies whether an error will be returned if dirty areas are encountered in any of the traversed features. This is the only way to guarantee a trace is passing through features with consistent status in the network. To remove dirty areas, validate the network topology.Checked—The trace will return an error if dirty areas are encountered in any of the traversed features. This is the default.Unchecked—The trace will return results regardless of whether dirty areas are encountered in any of the traversed features.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: ignore_barriers_at_starting_points
Data Type: GPBoolean
Display Name Ignore Barriers At Starting Points
Description: Specifies whether barriers in the trace configuration will be ignored for starting points.Checked—Barriers at starting points will be ignored in the trace.Unchecked—Barriers at starting points will not be ignored in the trace. This is the default.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: allow_indeterminate_flow
Data Type: GPBoolean
Display Name Allow Indeterminate Flow
Description: Specifies whether features with indeterminate or uninitialized flow will be traced. This parameter is only honored when running an upstream or downstream trace.Checked—Features with indeterminate or uninitialized flow direction will be traced.Unchecked—Features with indeterminate or uninitialized flow direction will not be traced. This is the default.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: traversability_scope
Data Type: GPString
Display Name Apply Traversability To
Description: Specifies the type of traversability that will be applied. Traversability scope determines whether traversability is applied to junctions, edges, or both. For example, in a network of recreational trails, if a condition barrier is defined to stop a trace if a surfacetype attribute contains a value of gravel and the traversability scope is set to junctions only, the trace will not stop even if it encounters an edge feature with this value in the surfacetype field, because the surfacetype attribute is only applicable to edges.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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: BOTH_JUNCTIONS_AND_EDGES
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Options
Choice List: [ BOTH_JUNCTIONS_AND_EDGES, JUNCTIONS_ONLY, EDGES_ONLY ]
Parameter: result_types
Data Type: GPMultiValue:GPString
Display Name Result Types
Description: Specifies the type of results that will be returned by the trace.Selection— The trace results will be returned as a selection set on the appropriate network features. This is the default.Aggregated Geometry— The trace results will be aggregated by geometry type and stored in feature classes displayed in layers in the active map.Network Layers—The trace results will be added to feature layers as a selection set in a group layer.Connectivity—The trace results will be returned as a connectivity graph in a specified output .json file. This option enables the Output JSON parameter.Elements—The trace results will be returned as feature-based information in a specified output .json file. This option enables the Output JSON parameter.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: [
NETWORK_LAYERS
]
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Options
Choice List: [ SELECTION, AGGREGATED_GEOMETRY, NETWORK_LAYERS, ELEMENTS ]
Parameter: selection_type
Data Type: GPString
Display Name Selection Type
Description: Specifies how the selection will be applied and what to do if a current selection exists.New selection—The resulting selection will replace the current selection. This is the default.Add to the current selection—The resulting selection will be added to the current selection if one exists. If no selection exists, this is the same as the new selection option.Remove from the current selection—The resulting selection will be removed from the current selection. If no selection exists, this option has no effect.Select subset from the current selection—The resulting selection will be combined with the current selection. Only records that are common to both remain selected.Switch the current selection—The resulting selection will be switched. Results that were selected are removed from the current selection, while results that were not selected are added to the current selection. If no selection exists, this is the same as the new selection option.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: NEW_SELECTION
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Options
Choice List: [ NEW_SELECTION, ADD_TO_SELECTION, REMOVE_FROM_SELECTION, SUBSET_SELECTION, SWITCH_SELECTION ]
Parameter: clear_all_previous_trace_results
Data Type: GPBoolean
Display Name Clear All Previous Trace Results
Description: Specifies whether content will be truncated from or appended to the feature classes chosen to store aggregated geometry. This parameter is only applicable to the aggregated geometry result type.Checked—The feature classes storing aggregated trace geometry will be truncated. Only the output geometry from the current trace operation will be written. This is the default.Unchecked—The output geometry from the current trace operation will be appended to the feature classes storing aggregated geometry.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Options
Parameter: trace_name
Data Type: GPString
Display Name Trace Name
Description: The name of the trace operation. This value is stored in the TRACENAME field of the output feature class to assist with identification of the trace results. This parameter is only applicable to the aggregated geometry result type.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Options
Parameter: aggregated_points
Data Type: GPFeatureRecordSetLayer
Display Name Aggregated Points
Description: An output multipoint feature class containing the aggregated result geometry. By default, the parameter is populated with a system-generated feature class named Trace_Results_Aggregated_Points that will be stored in the project's default geodatabase.This feature class will be created automatically if it does not exist. An existing feature class can also be used to store aggregated geometry. If a feature class other than the default is used, it must be a multipoint feature class and contain a string field named TRACENAME. This parameter is only applicable to the aggregated geometry result type.
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryMultipoint
HasZ: true
HasM: false
Spatial Reference: 103191
(6609)
Fields:
-
OID
(
type: esriFieldTypeOID, alias: OID
)
-
TRACENAME
(
type: esriFieldTypeString, alias: TRACENAME, length: 255
)
Features: None.
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Options
Parameter: aggregated_lines
Data Type: GPFeatureRecordSetLayer
Display Name Aggregated Lines
Description: An output polyline feature class containing the aggregated result geometry. By default, the parameter is populated with a system-generated feature class named Trace_Results_Aggregated_Lines that will be stored in the project's default geodatabase.This feature class will be created automatically if it does not exist. An existing feature class can also be used to store aggregated geometry. If a feature class other than the default is used, it must be a polyline feature class and contain a string field named TRACENAME. This parameter is only applicable to the aggregated geometry result type.
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPolyline
HasZ: true
HasM: false
Spatial Reference: 103191
(6609)
Fields:
-
OID
(
type: esriFieldTypeOID, alias: OID
)
-
TRACENAME
(
type: esriFieldTypeString, alias: TRACENAME, length: 255
)
-
Shape_Length
(
type: esriFieldTypeDouble, alias: Shape_Length
)
Features: None.
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Options
Parameter: updated_trace_network
Data Type: GPString
Display Name Updated Trace Network
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:
Parameter: out_network_layer
Data Type: GPString
Display Name Output Group Layer Name
Description: The name of the output group layer that contains feature layers with selection sets of features returned by the trace. The layer provides access to work with the output of a trace in ModelBuilder and Python.This parameter is only applicable to the network layers result type.
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Options
Parameter: use_trace_config
Data Type: GPBoolean
Display Name Use Trace Configuration
Description: Specifies whether an existing named trace configuration will be used to populate the parameters of the Trace tool.Checked—An existing named trace configuration will be used to define the properties of the trace. All parameters except Trace Configuration Name, Starting Points, and Barriers will be ignored.Unchecked—An existing named trace configuration will not be used to define the properties of the trace. This is the default.This parameter requires Trace Network Version 2 or later.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: trace_config_name
Data Type: GPString
Display Name Trace Configuration Name
Description: The name of the trace configuration that will be used to define the properties of the trace. This parameter is only active when the Use Trace Configuration parameter is checked.This parameter requires Trace Network Version 2 or later.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: out_json_file
Data Type: GPDataFile
Display Name Output JSON
Description: The name and location of the .json file that will be generated.
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category: Advanced Options
Parameter: esri_out_feature_service_name
Data Type: GPString
Display Name Output Feature Service Name
Description: The name of the optional feature service to create on the federated server containing the result of this tool. If no name is specified an output feature service will not be created.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:
Supported Operations:
Submit Job
Child Resources:
Metadata