Skip To Content ArcGIS for Developers Sign In Dashboard

Network Trace widget

(Added at v2.12)

The Network Trace widget is designed to call and interact with any geoprocessing service. The input should be a point feature or features, and the output can return polygon, polyline, or point features as results. For example this widget can be configured to use a geoprocessing service that traces a geometric network and returns an outage area and affected assets. To learn how to configure this widget to perform an isolation trace on a geometric network, visit the Water Outage template.

Configure the Network Trace widget

This widget can be set to open automatically when an app starts. To enable this feature, click the Open this widget automatically when the app starts button Open this widget automatically when the app starts on the widget, which turns it dark green.

  1. Hover over the widget and click the Configure this widget button Configure this widget to open the configuration properties dialog box.
  2. Optionally click Change widget icon and replace the default icon for this widget with an image of your own.

    A file explorer window appears, allowing you to choose a local image file to use as the widget icon.

  3. Select the Set button and provide the task URL for your geoprocessing service.

Configuration settings

There are four sections to consider when configuring the Network Trace widget: Project Settings, Input/Output, and General Settings.

Project Settings

The project settings are optional. If you configure these settings, you can define a project and save trace input and input results.

The Project Settings options are as follows:

  • Project polygon layer—This polygon layer must have Create, Delete, and Update editing capabilities and include a field called name (a string type field) and a field called globalid (a GlobalID type field).
  • Output parameter name—The output polygon layer or layers from the task URL.
  • Project point layer—This point layer must have Create, Delete, and Update editing capabilities and include a field called inputtype (a string type field) and a field called projectid (a GUID type field).

Input and Output

This tab provides options for configuring the input and output settings for the trace results.

  1. For each input parameter, set the type to flag, barrier, or skip, and specify the Tool Tip and symbol.
  2. For each output parameter, select any of the following options:
    1. Visible—Select the visible layers in the trace results that are checked. If Visible is not checked, the result layer will show the output parameter as unchecked in the trace result pane.
    2. Skippable—Allow features in this layer to be passed to the skip input parameter.
    3. CSV—Select the results to export to a .csv file.
  3. To save output parameters, select the drop-down arrow under the Save to Layer setting and select the layer.

    Note:
    If the project settings are not configured, the Save to Layer option is unavailable.

  4. For each output parameter, update the symbology by selecting the corresponding symbol.
  5. Select the Settings button Settings to update the label, Tool Tip, display text, and scale for the output results.

General settings

Set summaries on the trace results and set zoom settings.

  1. Add an input or output summary item to the summary text.
    1. Click the plus button Plus button to open Add Summary Items dialog box to open the Add Summary Items dialog box.
    2. Click the Inputs/Outputs parameter from the drop-down arrow.
    3. Select the Operators parameter and Fields parameter based on your desired summary text.

      Note:
      The count operator is based at the layer level and therefore is available for all input/output options. The sum, min, max, and mean operators are based at the field level and only show if a number field exists in the layer.

    4. Click Add to add the summary item to the text box.
    5. When finished, click Cancel or the plus button Plus button to open Add summary dialog to close the dialog box.
    6. Enable the Auto zoom after trace setting if desired.
  2. Select the Zoom option if you want the map to zoom to the trace results.

Use the Network Trace widget

When it's configured, this widget can be used by a water utility to determine an isolation area in the event of a main break. Open the Network Trace widget to display the Input tab and, optionally, the project drop-down arrow if configured.

  1. Add a flag location and, if required, a barrier.

    Note:
    Press the Control key to activate snapping.

    Add a flag to the Network Trace widget

  2. Click Run to start the trace.

    Click run

    The map zooms to the extent and displays the trace results.

  3. View the summary and the output results.

    Project name

  4. Click Save.

    Note:
    Project settings must be configured to save the trace.

  5. Provide the project name and any additional information in the project attributes pane.

    Click OK to save the new project

  6. Click OK to finish saving the results.