Add Trace Configuration (Trace Network Tools)

Summary

Creates a named trace configuration in the trace network.

Named trace configurations allow you to configure and store the properties of complex traces for reuse and sharing. Named trace configurations created in a utility network can be consumed in ArcGIS Pro using the Trace tool or the Named Configurations tab in the Trace pane. When working in an enterprise deployment, these can also be shared through a web map and consumed by web and field apps.

Learn more about how to add a trace configuration

Usage

• The input trace network must be version 2 or later.

• When working with an enterprise geodatabase, the input trace network must be from a trace network service.

• The connected portal account is set as the creator of the named trace configuration.

  • Operating system authentication is used to store the creator of a trace configuration when working with a single-user deployment of the trace network.

  License:

  Organization members must be assigned a license for the ArcGIS Advanced Editing user type extension to use this tool in an enterprise deployment.

Parameters

• Dialog
• Python

Label	Explanation	Data type
Input Trace Network	The trace network that will contain the new named trace configuration.	Trace Network; Trace Network Layer
Trace Configuration Name	The name for the named trace configuration.	String
Trace Type	Specifies the type of trace that will be configured. 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 uses flow direction. Downstream—A downstream trace that discovers features downstream from a location in the network will be used. This type of trace uses flow direction. 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.	String
Description (Optional)	The description of the named trace configuration.	String
Tags (Optional)	A set of tags used to identify the named trace configuration. The tags can be used in searches and indexing.	String
Path Direction (Optional)	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. Upstream path—The upstream path between the two starting points will be used. Downstream path—The downstream path between the two starting points will be used.	String
Shortest Path Network Attribute Name (Optional)	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.	String
Include Barrier Features (Optional)	Specifies whether 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.	Boolean
Validate Consistency (Optional)	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.	Boolean
Ignore Barriers At Starting Points (Optional)	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.	Boolean
Allow Indeterminate Flow (Optional)	Specifies whether features that have indeterminate or uninitialized flow will be traced. This parameter is only honored when running an upstream or downstream trace. Checked—Features that have indeterminate or uninitialized flow direction will be traced. Unchecked—Features that have indeterminate or uninitialized flow direction will not be traced. This is the default.	Boolean
Condition Barriers (Optional)	Sets a traversability barrier condition on features based on a comparison to a network attribute. 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 Code attribute equal to the specific value of ArtificialPath. When a feature meets this condition, the trace stops. If you're using more than one attribute, you can use the Combine Using component to define an And or an Or condition. 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. Type—Filter by a specific type. Specific value—Filter by a specific value. Network attribute—Filter by a network attribute. Value—Filter by a specific value. Combine Using—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, for example, to restrict how far the trace travels from the starting point or to 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. Value table columns: Function—Filter by a function. Min—The minimum of the input values. Max—The maximum of the input values. Average—The average of the input values. Count—The number of features. Add—The sum of the values. Subtract—The difference between the values. 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. Value—Filter by a specific value. Use Local Values—Boolean value to use local variables instead of a global variable.	Value Table
Apply Traversability To (Optional)	Specifies whether traversability will be 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. In other words, this parameter indicates to the trace whether to ignore junctions, ignore edges, or include both junctions and edges in the trace. 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
Functions (Optional)	The calculation function that will be applied to the trace results. Value table columns: Function—Filter by a function. Min—The minimum of the input values. Max—The maximum of the input values. Average—The average of the input values. Count—The number of features. Add—The sum of the values. Subtract—The difference between the values. Attribute—Filter by a network attribute Filter Name—Filter by attribute name. Filter 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. Filter Type—Filter by attribute type. Specific value—Filter by a specific value. Network attribute—Filter by a network attribute. Filter Value—Filter by a specific value. Function Name—The name for the alias to describe the function result.	Value Table
Output Conditions (Optional)	The types of features that will be returned based on a network attribute. For example, in a trace configured to filter out everything but tap features, any traced features that do not have the Tap attribute assigned to them will not be included in the results. Any traced features that do will be returned in the result selection set. If using more than one attribute, you can use the Combine Using option to define an And or an Or condition. 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. Type—Filter by a specific type. Specific value—Filter by a specific value. Network attribute—Filter by a network attribute. Value—Filter by a specific value. Combine Using—Combine multiple conditions. And—Combine the conditions. Or—Use if either condition is met.	Value Table
Result Types (Optional)	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.	String

Derived output

Label	Explanation	Data type
Updated Trace Network	The updated trace network.	Trace Network

Environments

This tool does not use any geoprocessing environments.

Licensing information

• Basic: No
• Standard: Yes
• Advanced: Yes

Related topics

• An overview of the Trace Configuration toolset
• Find a geoprocessing tool