Utility Network Trace widget

The Utility Network Trace widget allows users to run traces in a utility network based on connectivity and traversability. Starting points define the location in the network where the trace begins, and barrier points mark the locations to stop the trace. The trace parameters are preset for each specific trace type. Users can run one trace or multiple traces concurrently and can visualize results on the connected map and as a list of selected features organized by asset groups and asset types.

Examples

Use this widget to support app design requirements such as the following:

  • You want to run an isolation trace to identify which system valves need to be closed to stop the flow of water and which customers will be affected by the ensuing water outage.
  • You want to run an upstream trace to search for possible contamination source locations in a stormwater system.
  • You want to run a connected trace in a branch version to check that newly edited features are connected as expected.
  • You want to run a subnetwork trace to validate whether subnetworks, such as circuits or zones, are defined or edited appropriately.

Usage notes

This widget requires connection to a Map widget. To run a trace, the Map widget must be connected to a 2D web map data source published with a utility network (version 5 or later) and shared named trace configurations (ArcGIS Enterprise 10.9 or later).

  • To create a utility network and publish a feature service using an Enterprise deployment, follow the steps for utility network creation and configuration.
  • Once you've published the feature service, you can use ArcGIS Pro to add named trace configurations and share them through a web map.

To use the widget with utility network services published at 11.1 or earlier, the user must be signed in with an ArcGIS Enterprise account with an assigned license for the ArcGIS Utility Network user type extension.

The network topology must be enabled, and the results of a trace are not guaranteed to be accurate if dirty areas are traced. The network topology for the area to be traced must be validated to reflect the most recent edits or updates made to the network.

The type of trace results depends on the named trace configurations shared through the web map. In the widget, the trace results can be returned as a selection or as graphics, or both (if aggregated geometry is set as a result type).

Note:

Running traces on map services is not supported.

Settings

The Utility Network Trace widget includes the following setting:

  • Source—Select a map widget. The connected web map must contain a utility network (version 5 or later) and shared named trace configurations (ArcGIS Enterprise 10.9 or later).
  • Trace Results—Customize the following trace result options for each map.
    • Result area—Turn on Create result area to generate a result area polygon with an information pop-up around the trace result elements. The polygon is an output data source that other widgets can use. You can customize the polygon with the following settings.
      • Color—Set the color of the result area polygon.
      • Show when trace completes—Display the result area polygon on the map when the user runs a trace.
      • Shape—Choose a shape for the polygon, either Convex Hull or Buffer. A convex hull is the smallest convex polygon enclosing all input features. A buffer is a polygon generated from an offset at each input feature's vertices. A convex hull is appropriate if you want to create one large result area encompassing trace results from disconnected areas, while buffers are appropriate if you want to create separate result areas for each trace result.
      • Distance—Provide a distance value and unit. If you choose the Buffer shape, the distance you provide here is the buffer offset. If you choose the Convex Hull shape, any distance you provide here is applied as a buffer on the convex hull.

Interaction options

The Utility Network Trace widget can generate an output data source that other widgets can use if you turn on Create result area in the widget's settings. This is useful if, for example, you want to users to view data about the result area in a Chart widget when they run a trace.

This widget supports message actions, which you can configure on the Action tab of the widget's settings. The Utility Network Trace widget can act as the source of the Record selection changes trigger to target the framework and other widgets.