Get a server-defined trace configuration for a given tier and modify its traversability scope, add new condition barriers and control what is included in the subnetwork trace result.
While some traces are built from an ad-hoc group of parameters, many are based on a variation of the trace configuration taken from the subnetwork definition. For example, an electrical trace will be based on the trace configuration of the subnetwork, but may add additional clauses to constrain the trace along a single phase. Similarly, a trace in a gas or electric design application may include features with a status of "In Design" that are normally excluded from trace results.
The sample loads with a server-defined trace configuration from a tier. Check or uncheck which options to include in the trace - such as containers or barriers. Use the selection boxes to define a new condition network attribute comparison, and then use 'Add' to add the it to the trace configuration. Tap 'Trace' to run a subnetwork trace with this modified configuration from a default starting location.
Example barrier conditions for the default dataset:
- 'Transformer Load' Equal '15'
- 'Phases Current' DoesNotIncludeTheValues 'A'
- 'Generation KW' LessThan '50'
- Create and load a
UtilityNetwork
with a feature service URL, then get an asset type and a tier by their names. - Populate the choice list for the comparison source with the non-system defined
Definition.NetworkAttributes
. Populate the choice list for the comparison operator with the enum values fromUtilityAttributeComparisonOperator
. - Create a
UtilityElement
from this asset type to use as the starting location for the trace. - Update the selected barrier expression and the checked options in the UI using this tier's
TraceConfiguration
. - When 'Network Attribute' is selected, if its
Domain
is aCodedValueDomain
, populate the choice list for the comparison value with itsCodedValues
. Otherwise, display a free-form textbox for entering an attribute value. - When 'Add' is clicked, create a new
UtilityNetworkAttributeComparison
using the selected comparison source, operator, and selected or typed value. Use the selected source'sNetworkAttribute.DataType
to convert the comparison value to the correct data type. - If the Traversability's list of
Barriers
is not empty, create aUtilityTraceOrCondition
with the existingBarriers
and the new comparison from Step 6. - When 'Trace' is clicked, create
UtilityTraceParameters
passing inUtilityTraceType.Subnetwork
and the default starting location. Set itsTraceConfiguration
with the modified options, selections, and expression; then run aUtilityNetwork.TraceAsync
. - When
Reset
is clicked, set the trace configurations expression back to its original value. - Display the count of returned
UtilityElementTraceResult.Elements
.
- CodedValueDomain
- UtilityAssetType
- UtilityAttributeComparisonOperator
- UtilityCategory
- UtilityCategoryComparison
- UtilityCategoryComparisonOperator
- UtilityDomainNetwork
- UtilityElement
- UtilityElementTraceResult
- UtilityNetwork
- UtilityNetworkAttribute
- UtilityNetworkAttributeComparison
- UtilityNetworkDefinition
- UtilityTerminal
- UtilityTier
- UtilityTraceAndCondition
- UtilityTraceConfiguration
- UtilityTraceOrCondition
- UtilityTraceParameters
- UtilityTraceResult
- UtilityTraceType
- UtilityTraversability
The Naperville electrical network feature service, hosted on ArcGIS Online, contains a utility network used to run the subnetwork-based trace shown in this sample.
Using utility network on ArcGIS Enterprise 10.8 requires an ArcGIS Enterprise member account licensed with the Utility Network user type extension. Please refer to the utility network services documentation.
category comparison, condition barriers, network analysis, network attribute comparison, subnetwork trace, trace configuration, traversability, utility network, validate consistency