Configure the Network Trace widget

The Network Trace widget allows you to quickly trace a network. For example, when configured this widget can be used by a water utility to determine an isolation area in the event of a main break. In order to use the Network Trace widget, a geoprocessing service with a point input or inputs is needed.

To configure the Network Trace widget, complete the following steps:

  1. Add a new network trace widget to your web application, and edit the widget.
  2. Set the Task URL by selecting Add Service URL and adding the URL to your geoprocessing service.
  3. Browse to the list of input parameters, select an input, and update the following for each of your inputs:
    Parameter Description
    Tooltip Description of input presented to the user.
    Type Defines if the input is a flag, barrier, or skip location in the geoprocessing service.
    Symbol Symbol used to display the input to the user.
  4. Browse to the list of output parameters, select an output, and configure the following for each of your outputs:
    Parameter Description
    Label The text that will be displayed for each result section.
    Skippable Setting to allow features in this layer to be passed to the input parameter that has a type of Skip. For example, this parameter can be used to bypass valves in a water utility isolation trace.
    Unique ID field A unique ID field is required to allow the feature to be skipped. Do not use OBJECTID as the unique ID field. This option is only visible when Skippable is checked.
    Tooltip Description of output presented to the user.
    Display text Text used to describe each feature within a specific results overview. Along with text, the attribute information can be included in the display text by using the {FieldName} syntax.
    Min scale The minimum scale the results will be suppressed.
    Max scale The max scale the results will be suppressed.
    Export to CSV Defines if the results will be saved to a CSV file.
    Save to layer Defines if the result is saved to a layer in the map. When save to layer is enabled, you will then have the option to define the target layer. The Target Layer parameter defines the layer in your map that will contain the features when the network trace results are saved.
    Symbol Symbol used to display the output results to the user.
  5. Browse to the summary parameter and configure the following:
    Parameter Description
    Summary Settings Select a input or output, a field and an operator to perform on that field to construct your summary text. Count and SkipCount operators do not use a field.
    Summary Text Using the Summary Settings and free form text, construct the text you want to display as a summary of your trace.
  6. Browse to the overview parameter and configure the following for the overview results:
    Parameter Description
    Visible Defines if the overview area is visible when the results are returned.
    Buffer Distance The distance the results of the trace will be buffered.
    Buffer Type The type of buffer to create the outage area. Options are Convex Hull or Buffer.
    Unit The unit of measure to create the overview area.
    Min scale The minimum scale the results will be suppressed.
    Max scale The max scale the results will be suppressed.
    Save to layer Defines if the output overview area is saved to a layer in the map. When save to layer is enabled, you will then have the option to define the target layer. The Target Layer parameter defines the layer in your map that will contain the output polygon when the network trace results are saved.
    Target layer Select the polygon layer to save the overview in. Only visible when Save to layer is checked.
    Save summary options When are saving the overview area, you have the option of storing the count of each output into a field in the overview record. Select the fields and parameters you wish to store.
    Symbol Symbol used to display the output results to the user.
  7. Browse to the other parameter and configure the following miscellaneous properties for the widget:
    Parameter Description
    Image The image used to highlight a selected result to the user. To specify your own image, click the image and select your image.
    Image height The height of the highlight image (in pixels).
    Image width The width of the highlight image (in pixels).
    Timeout The number of milliseconds the image will highlight the selected result before the animation times out.
    Display text The display text for the run trace button.
    Auto zoom after trace Option to auto zoom the map to the overview area or results after the trace.
Top