Skip to main content

Publish and consume services with a utility network

Publishing a service that contains a utility network and related network feature classes is necessary when working with enterprise geodatabases. There are various conditions and restrictions which apply to this process depending on the layers that are present in the map view, how you configure the service, and where you plan to consume the service. An analyzer enforces these conditions and restrictions, returning errors for conditions that prevent publishing and warnings for conditions that may limit how the service is consumed.

A published feature service that contains the utility network layer automatically includes the Utility Network and Network Diagram services to support trace analysis and network diagrams. See Utility Network services to learn more.

Prepare data for publishing

The layers you add to the map determine the capabilities of the published service. When you publish and consume a feature service that contains a utility network, the following conditions and prerequisites apply.

To prepare the environment for the publishing process, complete the following steps:

Prerequisite:

  1. Set the versioning type of the geodatabase connection to Branch before you add the utility network from the database connection to the map.

    1. Right-click the database connection in the Catalog pane, and click Geodatabase Connection Properties.

    2. On the Geodatabase Connection Properties dialog box, choose Branch under Versioning Type, and click OK.

    Note:

    Branch versions can only be edited using feature services. If the versioning type of the geodatabase connection is not set to branch versioning, you cannot publish a utility network.

    Learn more about working with branch versioned data

  2. Register the feature dataset as versioned by doing the following

    1. Right-click the feature dataset, and click Manage to open the Feature Dataset Properties dialog box.

    2. Check the Versioning check box, and ensure that Branch is chosen.

    3. Click OK to register the feature dataset as branch versioned.

      Learn more about registering a dataset as branch versioned

      The utility network feature dataset and nonspatial junction and edge object tables are registered as branch versioned.

  3. In the Catalog pane, right-click the utility network and click Add To New Map to add the utility network and its associated layers to a new map.

  4. Click Yes when prompted to add all classes that participate in the utility network to the map.

    Note:
    • While the service can still be consumed from the web, to consume the utility network in ArcGIS Pro, the map must contain all of the layers that participate in the network; otherwise, analyzer warning 24099 will be returned.

    • Definition queries and hidden fields set with the Visible layer field property are not supported; the analyzer returns error 00270 if either condition exists.

  5. Preserve layer IDs in the map document.

    It is recommended that you manually assign layer IDs before publishing if you intend to overwrite the web layer or service in the future. Otherwise, service sublayer IDs can potentially change when the web layer or service is overwritten. This can cause problems with web clients accessing these services referencing specific layer IDs. You can enable this with the Allow assignment of unique numeric IDs for sharing web layers setting on the Map Properties dialog box.

    1. In the Contents pane, right-click the map name and click Properties to open the map properties.

    2. On the Map Properties dialog box, on the General tab, check Allow assignment of unique numeric IDs for sharing web layers and click OK.

    Note:

    If you do not assign layer IDs manually, uncheck the Ensure map is set to allow assignment of unique IDs check box in the Share As Web Layer pane. If the box is checked, and the Allow assignment of unique numeric IDs for sharing web layers check box in Map Properties is not enabled, the analyzer returns an error. If the box is unchecked, the analyzer skips the check. See Configure a web feature layer to learn more.

Learn more about publishing branch versioned data

Publish the utility network as a feature service

To publish a utility network as a editable feature service that supports analytic functionality such as tracing and diagram creation, complete the following steps:

  1. Confirm that the map contains the utility network and all its associated layers.

    Note:

    The publishing map must not contain subtype group layers or tables. Additionally, do not change the configuration of the unique value renderer for the layers in the map. A renderer that references a field other than the asset group affects the subtype definition that controls the behavior and properties of the layer.

  2. On the Share tab, click the Web Layer drop-down menu , and click Publish Web Layer.

  3. In the Share As Web Layer pane, on the General tab, provide a name for the web layer.

    Optionally, provide values for the Summary and Tags parameters.

  4. Under Data and Layer Type, choose Map Image, and check the Feature check box under Reference registered data.

    This enables the Version Management setting on the Configuration tab under Configure Layers .

  5. Under Location, specify the Portal Folder and Server and Folder where you share the data.

    You can share to the root folder or create a folder.

  6. For Sharing Level, specify how you will share the utility network.

  7. On the Configuration tab, under Configure Layers , confirm that Version Management is enabled under Capabilities.

    Note:

    The Version Management option is not available if the Feature option is not enabled, or if the feature dataset that contains the utility network is not branch versioned.

  8. On the Configuration tab, under Layers, click the Configure Web Layer Properties button next to Feature to open Feature Properties.

  9. In Feature Properties, under Properties, check Allow update of true curves and Only allow true curve updates by true curve clients.

  10. To publish the utility network as a feature service for offline use,, check Enable sync under Operations, and choose a Version Creation option from the Sync drop-down list.

    Learn more about how to publish the utility network as a feature service for offline editing

  11. Click Analyze to identify potential issues or errors.

    Two types of analyzer messages appear on the Messages tab. Errors are issues you must fix before you can publish web layers. Warnings are issues that can affect performance, appearance, or data access. Double-click the error or warning for a solution or access to a help topic. Right-click the error or warning for suggestions on how to address the issue.

    Tip:

    You can register an enterprise geodatabase as a data store when publishing or analyzing the data. An analyzer error message appears in the Share As Web Layer pane if the database is not registered with the server. To register a geodatabase, click Options, and click Register Data Source with Server on the error message.

  12. Click Publish to publish the utility network.

  13. Add the utility network web layer to the map.

    Learn how to build effective maps for viewing and editing your utility network data

For more information about the specific steps required to use a utility network in a multiuser environment, see the Configure a multiuser environment example workflow.

Publish utility network feature classes without a utility network layer

When you share web feature layers for network feature classes without the utility network layer, fewer restrictions apply. This approach also limits your ability to work with the full functionality of a utility network in web, desktop, and mobile applications. When you do not need the full capabilities of the utility network, configure the active map view to include a subset of layers using definition queries, make a subset of fields visible, and so on. This lets an organization share services and maps with users who need limited access to a subset of utility network classes.

When the active map view does not contain the utility network layer, the following conditions apply for sharing:

  • The published feature service will not include the Utility Network or Network Diagram secondary services. Performing trace analysis or working with network diagrams will not be supported.

  • The map layers being published can support definition queries and hidden fields set using the Visible layer field property.

  • This feature service will behave in the same way as any other feature service. Edits still apply utility network behavior behind the service, such as dirty area creation, but the map does not display dirty areas.

  • Version Management is optional. You can enable it on the Configuration tab if your workflow requires branch versioning.

Learn more about how to share branch versioned layers

Publish the utility network as a feature service for offline editing

You can take utility network data offline from a web map to view, edit, or trace in ArcGIS Pro and ArcGIS Maps SDKs for Native Apps. Offline access supports workflows that run where internet connectivity is inconsistent or unavailable using offline map areas created ahead of time or by creating offline map areas on demand. To work with utility network data offline, enable the sync capability on all web layers. To do this, enable both editing and sync in the Feature Properties pane on the Configuration tab of the Share As Web Layer pane. With editing and sync enabled on the feature service, clients can edit a local copy of the data and synchronize when connectivity is available.

Note:

To publish and work with your utility network data offline, the Service territory feature class must be present in the published service.

Check Create a version for each downloaded map for Version Creation under the Sync drop-down arrow. This option lets you review edits and synchronize with a replica version.

Learn more about taking a utility network offline

Learn more about working with offline maps and branch versioned data

Workflow examples

To understand the requirements and conditions for working with services and utility network data, consider the following workflow examples:

Workflow Map contents Feature service contents View and work with dirty areas Trace and create network diagrams Minimum requirements for portal account
GIS editor Utility network dataset and all associated network layers Utility network and associated network features Yes Yes Professional or Professional Plus user type assigned the Publisher role
GIS analyst Utility network dataset and all associated network layers Utility network and associated network features Yes Yes Professional or Professional Plus user type assigned the Publisher role
Web viewer Requested network layers Specified network layers associated with the utility network No No Creator user type assigned the Publisher role with the Advanced Editing user type extension
Field editor, no tracing Requested network layers Specified network layers associated with the utility network No No Creator user type assigned the Publisher role with the Advanced Editing user type extension
Field editor, with tracing Utility network dataset and all associated network layers Utility network and associated network features No Yes Professional or Professional Plus user type assigned the Publisher role

GIS editor workflows

A GIS editor who performs maintenance edits on data in an electric distribution network needs to review the dirty areas and errors created by edits and validate the network topology to clean these. This workflow requires a feature service to be created with the utility network dataset and all associated network feature layers. The ArcGIS Pro project created for this user contains the utility network layer, domain network layers, and any associated layers that will be edited.

GIS analyst workflows

A GIS analyst performs tracing, other analysis, and map production. This workflow uses the same feature service and the same project configuration as the editor workflow.

Web and field access workflows

Casual users work in web maps and apps configured for specific tasks and workflows. These are usually created from feature services with a reduced set of layers targeted to address the user's workflow, and they can include definition queries or a reduced set of visible fields on some layers. For these view and query workflows, the web map can use a feature service without a utility network layer.

Field editor workflows

Field editors use Esri apps, or apps built by Esri partners using ArcGIS Maps SDKs for Native Apps, for field operations such as inventory, inspections, and valve shutoff. A workflow that requires tracing or network diagrams needs a web map backed by a feature service that includes the Utility Network and Network Diagram services. Simple field editing workflows can consume a web map with a feature service that has no utility network layer.