ArcGIS Utility Network

Configure an Application to Trace a Utility Network

Since the release of the UtilityNetworkTrace widget in the ArcGIS API for JavaScript 4.22, we’ve been working to deliver this widget in our no-code app builders. With the March 2022 update of ArcGIS Online, this widget is now available in ArcGIS Instant Apps and ArcGIS Experience Builder.

Read along to learn about the prerequisites and how to publish a web map for tracing. Otherwise, jump directly to one of the topics below.

 

Prerequisites

The following requirements must be met to use UtilityNetworkTrace widget:

Create a utility network and a web map for tracing

The Utility Network Trace widget leverages the named trace configuration capability which allows you to add and store complex traces in a utility network service. These traces can be shared across an organization through web maps. Follow these steps to get started:

Step 1. Publish a feature service with the utility network to ArcGIS Enterprise

First, you need to create a utility network and publish a feature service using an Enterprise deployment (10.9 or later). Follow the steps for utility network creation and configuration.

If you need sample data and step-by-step guidance to publish your first utility network service, deploy one of the ArcGIS Solutions listed here.

Step 2. Add and share trace configurations

Once you’ve published the feature service to your Enterprise Portal, you can use ArcGIS Pro to trace the utility network and add named trace configurations.

First, add the utility network feature service to a new map in ArcGIS Pro and add trace configurations. To ensure your trace configurations are working as expected, test them in ArcGIS Pro before sharing them in your web map.

To include trace configurations in the definition of the map, set the named trace configurations as active from the Sharing pane of the Network Options dialog box.

 

Network Options dialog box
To include trace configurations in the definition of the map, set the named trace configurations as active from the Sharing pane of the Network Options dialog box.
Can't find the Network Options dialog box? Use the Command Search in the top ribbon.

ArcGIS Pro Command Search

Step 3. Publish a web map for tracing

Before publishing your map, you need to decide how you would like to interact with your utility network service and the trace results. Learn about the capabilities available in ArcGIS Enterprise vs ArcGIS Online for using the Utility Network Trace widget:

A – ArcGIS Enterprise: The Utility Network Trace widget is only available in Enterprise 11.0 (July 2022) in the Sidebar template of the Instant Apps, but not in Experience Builder. You can also use your web map and the Utility Network Trace widget in custom applications built with the ArcGIS API for JavaScript (2.22 or later) or the developer edition of ArcGIS Experience Builder 1.8 or later. See Use the widget with ArcGIS Enterprise.

Update July 22, 2022 – The Utility Network Trace widget is now available in the Sidebar template of the ArcGIS Instant Apps, in ArcGIS Enterprise 11.0.

OR

B – ArcGIS Online: To use the Utility Network Trace widget in the online editions of Instant Apps and Experience Builder, you need to publish your web map to an ArcGIS Online portal.

Once you are ready to publish your map, sign in to your targeted organization in ArcGIS Pro.

Click the Share tab and click Web Map on the ribbon in the Share As group.

 

You are now ready to start building applications with the Utility Network Trace widget.

 

Instant Apps small banner

Trace with the Sidebar Instant App template

Use the Sidebar template in the ArcGIS Instant Apps if you want to set up a quick application to start tracing.

Step 1. Create a new app

  1. Sign in to the ArcGIS Online account where your web map was published.
  2. On the My Content tab of the content page, click Create app and choose Instant Apps.
  3. Search for the Sidebar template and click Choose.
Create a new Instant App and select the Sidebar template
Create a new Instant App in your organization content and select the Sidebar template to get started.

Step 2. Add the web map and the widget

  1. In the Map settings, select the web map you published (must have a utility network feature service and trace configurations).
  2. In the Sidebar settings, enable the Utility network trace setting.
  3. Publish your app and start tracing!
Add the Utility Network Trace widget to the Sidebar and run traces on the utility network in your map.
Add the Utility Network Trace widget to the Sidebar and run traces on the utility network in your map.
Banner image

Trace with ArcGIS Experience Builder

Use ArcGIS Experience Builder if you want to configure an application with a customized layout and do more with the trace results.
The Utility Network Trace widget in Experience Builder is provided as beta.

Step 1. Create a new app

  1. Sign in to the ArcGIS Online account where your web map was published.
  2. From My Contents, click Create app and select Experience Builder.
  3. Click Create new and start from Blank or select a template that is Map centric such as Launchpad.
Create a new app using Experience Builder and select a Map centric template, such as Launchpad.
Create a new app using Experience Builder and select a Map centric template, such as Launchpad

Step 2. Add the web map and the widget

  1. For the Map widget data source, select the web map you published (must have a utility network feature service and trace configurations).
  2. Add the Utility Network Trace (beta) widget to the Widget Controller at the bottom of the page.
  3. Set the Source for the Utility Network Trace (beta) widget to the Map widget.
  4. Save and publish your application to start tracing now or configure more widgets to explore the trace results.
Add the web map you published (must have a utility network feature service and trace configurations) and the Utility Network Trace widget to the application.
Add the web map you published (must have a utility network feature service and trace configurations) and the Utility Network Trace widget to the application.

Step 3. Configure widgets to explore trace results

  1. Select the Table widget from the controller and click New sheet in the settings panel.
  2. Click Select data and choose a layer from your utility network feature service.
  3. Choose to display the Selected features for that data source and set which fields to show in the table.
Configure the Table widget to display the selected trace results.
Configure the Table widget to display the selected trace results.

4. To allow exporting the selected feature using the Table widget, you must Allow export for the feature layer data source on the Data panel and Enable data action in the Table widget Data action panel.

Enable data action in the Table widget to allow exporting the selected features.
Enable data action in the Table widget to allow exporting the selected features.

5. Unlock the layout and add a Text widget.

6. Configure expressions to show statistics from the trace results.

Add a Text widget to show dynamic selection statistics for the trace results.
Add a Text widget to show dynamic selection statistics for the trace results.

7. Click the Widget Controller and set the Behavior to Multiple and the Display type to Side by Side. This will allow you to open the Table and the Utility Network Trace widgets simultaneously.

Configure settings for the Widget Controller to display multiple widgets side by side.
Configure settings for the Widget Controller to display multiple widgets side by side.

8. Further customize your application and explore the results when you run traces.

 

Use the widget with ArcGIS Enterprise

The Utility Network Trace widget is only available in Enterprise 11.0 (July 2022) in the Sidebar template of the Instant Apps, but not in Experience Builder. To trace a utility network with maps from your ArcGIS Enterprise Portal, you can also build a custom application and import the widget from the ArcGIS API for JavaScript (2.22 or later), or you can use the developer edition of ArcGIS Experience Builder 1.8 or later (April 2022 release).

About the author

Alix works on the ArcGIS Utility Solutions team as a Product Engineer, leading the successful delivery of tools for utilities in ArcGIS Web AppBuilder, ArcGIS Experience Builder, and the ArcGIS API for JavaScript since 2019. Prior to her work at Esri, she facilitated the digital GIS transformation of a property and land management organization in New Zealand and coauthored Esri Learn lessons for Public Safety. She has a degree in GIS from Université de Sherbrooke (Québec, Canada).

Connect:
4 Comments
Oldest
Newest
Inline Feedbacks
View all comments

Next Article

Essential Configurations for Highly Scalable ArcGIS Online Web Applications (Viral Applications)

Read this article