Frequently asked questions

Find answers to common questions about network diagrams.

Also, see the following topics for additional frequently asked questions:

General

Network diagrams

Diagram rule and layout definition on diagram templates

Diagram layer definition on diagram templates

General

What is Network Diagrams?

Network Diagrams is the ArcGIS Pro component to produce diagrams. It is installed as a core part of any utility network and trace network at its creation. It directly consumes the network topology, allowing a unique source of data to maintain and truth. Any network element existing in the network index can be represented in a network diagram.

How are network diagrams licensed?

Both the single-user and enterprise deployment of the network diagrams require an ArcGIS Desktop Standard or ArcGIS Desktop Advanced license.

The enterprise deployment pattern uses a service-based architecture and is configured and deployed using ArcGIS Pro and ArcGIS Enterprise. The network diagram templates are configured using a direct database connection in ArcGIS Pro and is later published to a feature service in Portal for ArcGIS for consumption.

License:

The active portal account must be licensed with the ArcGIS Advanced Editing user type extension to use Network Diagram services. However, starting with ArcGIS Enterprise 11.5, this user type extension is not required to search for stored network diagrams and open them, verify diagram properties, apply selection propagation commands from open diagram maps to network map, and conversely. However, the ArcGIS Advanced Editing user extension type remains required for any other operations; that is, for diagram creation, storing, update, editing, layout applying.

How can I write custom tools and buttons in the ArcGIS Pro SDK for .NET that work with network diagrams?

The ProConcepts Network Diagrams page provides an overview of the network diagram SDK. If you've never written custom code using the ArcGIS Pro SDK for .NET, see Build your first add-in. Network diagram public add-in samples are available under NetworkDiagram in ArcGIS Pro SDK community samples repository.

How can I work with a network diagram web service using ArcGIS REST API?

The network diagram service supports creating diagrams, working with layouts, and so on.

Learn more about the network diagram services

Network diagrams

What kind of network inputs are expected to create diagrams?

You can create network diagrams from utility or trace networks. The diagram generation process expects network features or network objects as diagram inputs. Starting with ArcGIS Pro 3.5 and ArcGIS Enterprise 11.5, you can also use trace locations currently specified in utility or trace network maps as diagram inputs.

Learn more about workflow to generate diagrams from network features and network objects

Learn more about workflow to generate diagrams from trace locations

Why is the New command unavailable in the Diagram group? Why can I no longer apply a layout to my open diagrams?

There may be an active edit session. Review the disabling conditions in the command's ScreenTip. See Utility Network tab for more information.

What are some troubleshooting tips for problems with storing, appending to, and extending a network diagram?

Verify the template name your diagram is based on. To do this, right-click the diagram layer in the Contents pane, click Properties, click the Diagram Properties tab, and verify the name specified for Diagram Template.

Then review the properties for that diagram template's name. To do this, right-click a utility network or trace network layer in the Contents pane and click Properties. On the network Layer Properties dialog box that appears, click the Network Diagrams tab and expand the Diagram Templates section. Identify the diagram template item in the list and verify the following:

  • Diagram Storage—If it is set to Disabled, you cannot store diagrams based on this template.
  • Diagram Extent—If it is set to Disabled, you cannot extend or append features to diagrams based on this template.

Also verify whether the All Layers mode is turned on or off for the diagram layer. Starting with ArcGIS Pro 2.6, the Dynamic On/Off, Extend, Overwrite, and Append buttons are unavailable when the All Layers mode is turned off.

Do network diagrams support the new nonspatial objects included with Utility Network version 4?

Yes. Starting with Utility Network version 4, a network diagram can represent both spatial features and nonspatial objects of a network.

Learn more about junction and edge objects in network diagrams

Do network diagrams support the new trace network included with ArcGIS Pro 2.6?

Yes. The network diagram elementary build process and the diagram rules have been updated to support trace network features. You can create custom diagram templates to generate diagrams from trace network features. You can configure diagram rules to use on these templates to build content for your diagrams. For example, you can configure templates to automate network tracing from a single or multiple input network features, automate the process of adding or discarding network features, reduce them, and so on.

Learn more about diagram templates

Can I generate network diagrams from trace network services?

Yes. Starting with ArcGIS Pro 2.7, the trace network is supported in an enterprise geodatabase and can be shared as a branch-versioned trace network dataset using services for feature access with ArcGIS Enterprise 10.9. Then you can generate network diagrams from published trace network services.

Can I rename a network diagram?

Yes. You can rename any publicly stored network diagram using the Alter Diagram Properties geoprocessing tool. When working with a utility network, the utility network owner has full rights on all diagrams related to the network, whether these diagrams are public, private, or protected. The only exceptions are subnetwork system diagram names, which are managed by the update subnetwork process and cannot be changed.

How are subnetwork system diagrams managed?

Subnetwork system diagrams are managed through subnetwork updates. You can set up subnetwork system diagrams when you define the subnetwork.

Learn more about subnetwork system diagrams

When working with a utility network or a trace network service, what happens to network diagrams when reconciling and posting versions?

The single-user model does not support versioned editing. In an enterprise geodatabase, however, the model is multiuser and branch versioned.

With branch versioning, user versions are reconciled with and posted to the default version.

There is no conflict management when reconciling network diagrams with the default version. All diagrams existing in the default and edited versions since the version was created are merged in the reconciled version.

Once reconcile completes, changes made to the reconciled network may result in dirty areas and cause some diagrams to appear inconsistent with the network editing space in the version. Some diagrams may be consistent with the network editing space but disjoined from their own diagram features or statistics. Before posting the version, it is recommended that you update all the reconciled diagrams. This ensures that the diagram statistics and feature geometries are up to date in the version before posting it. In addition, once that version is posted, there is limited impact to the default version when updating the diagrams.

Learn more about reconciling diagram edits and posting changes to the default version

How can I customize the columns of the diagrams list in the Find Diagrams pane?

In the diagram table list, click a column header and use the pop-up dialog box that appears to choose the columns you want to display or hide. Then use the up and down arrows on the right side to reorder the columns, and click OK. To sort diagram items by a particular column value, click the column header. On the pop-up dialog box that appears, choose Sort A to Z or Sort Z to A, and click OK.

After running the layout tool on my open diagram, why do I not see any changes?

Make sure there is no feature selected in the diagram. When you have a set of selected features in a diagram, the layout algorithm only applies to the selected features. When you apply a layout and there is only one feature selected in a diagram, most layout algorithms have no effect.

What do the consistency icons represent for a network diagram layer in the Contents pane, and how are they refreshed?

If you expect a consistency icon to appear next to your network diagram layer in the Contents pane and it doesn't, collapse and expand the diagram layer and increase the width of the Contents pane.

  • A red warning icon indicates that the diagram is inconsistent with the network editing space. In this case, you must validate the network topology, save the edits, and update the diagram.
  • An orange warning icon indicates that the diagram may be inconsistent with either the network topology space or its diagram template definition. In this situation, update the diagram.
  • A gray warning icon informs you about a diagram with inconsistent layers. You can either update the diagram so its network diagram layers are properly reinitialized, or for a stored diagram, close and reopen it.

Learn more about diagram consistency states

When working with a utility network or trace network service, what operations are supported for accessing network diagrams using a historical moment?

When you are connected to a historical moment, you can only do the following:

  • Generate temporary diagrams representing the network as it was at that moment.
  • Search for stored diagrams that existed at that moment and open them.

No other operations are supported on these diagrams.

Learn more about working with diagrams at historical moments

Why are there missing diagram features (holes) in the diagram view?

This issue is related to the diagram layer definition set up on the related diagram template and can be one of the following two situations:

  • Situation A—There are missing layers under the network diagram layer that prevent diagram features from being represented.
  • Situation B—All the expected layers under the network diagram layer exist but with specific scales or display filters that prevent some diagram features from being visible at any scale.

To identify your situation, do the following:

  1. When working with a utility network or trace network in an enterprise geodatabase, sign in to your ArcGIS Enterprise portal using the credentials of the portal utility network owner or portal trace network owner.
  2. Depending on the geodatabase you want to work with, do one of the following:
    • When working with a utility network or trace network in a file or mobile geodatabase, add the file or mobile geodatabase to the project.
    • When working with a utility network or trace network in an enterprise geodatabase, add the database connection file to the project or create one.
      Caution:

      Make sure the network is registered as branch versioned and you are connecting using the credentials of the database utility network owner or database trace network owner.

  3. Run Export Diagram Template Definitions to export your diagram template rule and layout definitions.
  4. Run Add Diagram Template to create a test temporary diagram template using the .ndbd file you exported in the previous step.
  5. Generate the diagram twice: once based on the diagram template with which you noted issues, DiagramWithBadLayerDef, and once with the new temporary diagram template you created above, DiagramWithDefaultLayerDef.
  6. Compare the contents of the two diagrams to identify the features that are missing in DiagramWithBadLayerDef and should be represented in DiagramWithDefaultLayerDef, even if they appear with basic default appearance settings.

Tip:

Starting with ArcGIS Pro 3.0, there is another workflow to quickly identify Situation A. Click Consistency on the Network Diagram tab. A gray warning icon Diagram with inconsistent layers appears next to the network diagram layer in the Contents pane, indicating that the diagram has inconsistent layers.

I have disconnected graphs in most of the diagrams I generated with my new diagram templates. Why?

When generating a diagram after you've selected network features in the geographic map using a selection tool, the result may be a set of network features that are all fully connected. This is true when your map references layers with display scales. In this case, run network traces and generate diagrams from the resulting traced features. However, the best way to generate diagrams is to use diagram templates configured to automatically run a trace rule at each diagram generation and update.

Why is the diagram view empty?

This occurs when a diagram template is configured to focus on particular network features and you didn't provide the expected features as input for the diagram generation. Review the template description under the Diagram Templates section on the Network Diagrams tab of the network Layer Properties dialog box. The network owner may have provided details in this table that can help you understand how each diagram template works. Otherwise, talk to the network owner who designed the diagram template.

What are the operations I can run when working with a utility network or trace network in a file or mobile geodatabase or a database connection to a utility network in an enterprise geodatabase, or when consuming a utility network service? What can be done by the standard user or network owner?

Network diagram configuration and management tasks are dependent on many factors, including the type of workspace connection and its permission level, the diagram type, the capabilities enabled on the diagram templates, and the connected database or portal account. The conditions and requirements you must meet when running diagram operations are detailed in Network diagram management tasks.

Is there a way to copy a network diagram? Is there a way to preview a network diagram after an update without processing the update?

There is no command to copy a network diagram. However, starting with ArcGIS Pro 3.0, you can re-create another network diagram that looks like the one you want to copy by running the following steps:

  1. Ensure that at least one map, among the maps currently open in your project, references the utility network or trace network associated with the diagram you want to copy.
  2. If the diagram is related to a particular data source version, switch this map data source to the same data source version.
  3. Activate the map referencing the source network diagram; that is, the one you want to copy.
  4. In the Contents pane, right-click the network diagram layer and click Properties.
    • On the Layer Properties dialog box that opens with the Diagram Properties tab as the active tab, retain the Diagram template property among the properties exposed under the General section.
    • Close the Layer Properties dialog box.
  5. Click the Search for Initial Diagram Features in Network Map drop-down arrow Search for Initial Diagram Features in Network Map and choose the network map in which the initial diagram features will be located and selected.
  6. Make this network map the active map. The initial diagram features are selected in it.
  7. Click the Utility Network or Trace Network tab in the ribbon.
  8. Click the New drop-down arrow in the Diagram group, and click the template item corresponding to the name you retained in step 4 in the drop-down list. A new diagram is created from the same initial diagram feature set.
  9. If the source diagram exists with a specific layout, click the Copy Layout drop-down arrow in the Layout group, and click the diagram map referencing this source diagram so its layout is imported to the newly created diagram.
Note:

If the source diagram is consistent when you run this workflow, the newly created diagram should look like a copy of that source diagram.

If the source diagram is inconsistent, the newly created diagram allows you to preview the update to the source diagram.

Is there a way to perform a trace analysis inside a diagram?

From a network diagram, you can use the following trace and analysis tools:

  • The Select Connected Diagram Features command Select Connected Diagram Features starts from diagram features that are currently selected in the diagram, retrieves any diagram features that directly connect those that are currently selected, and adds them to the current selection. Clicking this command several times allows you to isolate subsets of connected diagram features in dense areas.
  • The Select Related Contents command Select Related Contents allows you to visually check containment relations from diagram containers. In particular, it allows you to quickly analyze container hierarchy, isolate the set of diagram features that are related contents of specific diagram containers, and so on.

Note:

Select Connected Diagram Features and Select Related Content are commands available with ArcGIS Pro 3.0 and later.

In the past, my company used the ArcGIS Schematics extension to create and manage schematic diagrams. We had spent time editing these schematic diagrams. We recently migrated our network data to a utility network or a trace network. Is there an easy way to port our ArcGIS Desktop schematic diagrams to ArcGIS Pro network diagrams?

No, you cannot port ArcGIS Desktop schematic diagrams to ArcGIS Pro network diagrams. Once your network data migrated to a utility network or trace network, you have to configure new diagram templates and re-create the expected network diagrams from scratch. Next, there are a couple of cool sample commands that could help you porting your schematic diagram's layouts to your new network diagrams.

See Export and Import Diagram Geometry Commands.

There are diagram template items missing in the New and Use Trace Locations drop-down lists in the Diagram group on the utility network ribbon when consuming a utility network service while these templates are available when working with a direct connection to the related Enterprise geodatabase. Why?

If the missing diagram templates are set as subnetwork templates for any of your subnetworks, this is the expected behavior.

To verify a diagram template is set as subnetwork template, complete the following steps:

  1. Right-click the utility network in the Contents pane and click Properties.
  2. On the network Layer Properties dialog box that appears, click the Network Diagrams tab and expand the Diagram Templates section.
  3. Identify the diagram template item in the list and have a look to the Is System property.

    It is set to Yes if the template is used as a subnetwork template.

To no longer use a diagram template as a subnetwork template, complete the following steps:

  1. Load the Set Subnetwork Definition tool in the Geoprocessing pane window.
  2. Click the Browse button next to Input Utility Network drop-down list and browse to the .sde connection file that allows you to connect to the related Enterprise geodatabase.
  3. Then, search for each couple of settings Domain Network and Tier Name for which you see your diagram template among the Subnetwork Diagram Templates.
  4. Click Remove to the left of the template name.
  5. Since the same template can be set as the subnetwork diagram template for multiple subnetworks, repeat steps 3 and 4.
  6. Restart the related services.

To learn more about subnetwork diagram templates, see Subnetwork system diagrams and their specifics.

Diagram rule and layout definition on diagram templates

What are some tips to consider when configuring diagram template rules?

The recommendations and warnings that you must consider when configuring diagram rules on a diagram template are listed at the bottom of Diagram rules.

There are also specific recommendations for subnetwork diagram templates.

Is there an easy way to discard any linear containers during diagram building?

Yes. Starting with ArcGIS Pro 3.5, there is a new Remove linear containers option on the Alter Diagram Template tool that allows you to remove any linear containers in any diagram during its building, whether those linear containers were used as diagram inputs or related to content features or objects created in a network diagram during the elementary build or diagram rules phases.

While consuming a utility network or trace network service and generating a diagram based on a newly created diagram template, I receive an error saying the diagram template is not found. How can I solve this?

This is because the new template is not fully recognized on the server side. To solve this issue, restart the related network service. Even though the new template item appears in the New drop-down list in the Diagram group on the utility network ribbon, the related service must be restarted before using it from a network service layer.

I want to set up a general diagram template using a trace rule, but when I test my new template starting from network features or objects currently selected as inputs in my network map I am often receiving the following error message: Error 001890: Invalid subnetwork connectivity, multiple subnetwork controllers with different subnetwork names found.. What can I do to avoid such an error?

When generating a diagram from network features or objects selected as inputs using a diagram template configured with Trace rule, the specified Trace rule doesn't care about any starting point you may have set up in your network map. By default, it only considers the network elements you selected in your network map to start tracing. Then, if the template is not configured to focus on any specific starting points among the input network elements, the diagram creation process is going to start a trace from each of the input. Also, if there are terminals on one or more of them, it starts tracing from each terminal. Then, it raises an error if it detects incompatibility with the specified trace rule parameters and the starting points from which it tried tracing. To make your trace rule start from only the input network elements or terminals you expect and properly apply at diagram creation, you must use the Add Set Starting Point By Attribute Rule tool prior to the Trace rule when configuring a custom template. The Trace rule focuses only on the network elements and terminals among the selected inputs from which you want it to start tracing.

Even if you select a single network element as an input for your diagram creation, your trace rule may not only start tracing from this single input network element. Indeed, the network diagram building process specifics apply. Since each time the network diagram building process creates an element in the in-memory diagram graph, it maintains graph completeness and shows relations between contents and containers, the diagram graph may be not only composed of the single network element you selected as input at the time the Trace rule applies. This diagram graph may also reference the hierarchy of containers related to this single input network element if it is contained. This diagram graph may also reference the from and to junctions of any lines. Then, without specifying any starting point among all these diagram graph elements, the Trace rule you configured on your template will try tracing from each of them and can fail.

With versions prior to ArcGIS Pro 3.5, the build process could only start from the network features or objects you selected in your network map. Starting with ArcGIS Pro 3.5, diagram generation process can also start from the trace locations currently specified in your network map; that is, from starting points, and potentially by considering barriers. This new workflow is recommended when the template you choose for the diagram generation is configured with a Trace rule. If the trace locations existing in the network map fit the Trace rule configured on the template, the diagram creation completes without error.

Learn more about Trace and Set Starting Point rules

Learn more about workflow to generate diagrams from network features and network objects

Learn more about workflow to generate diagrams from trace locations

Diagram layer definition on diagram templates

How can I set definitions for the layers under my network diagram layers?

Initializing a diagram layer definition for your diagrams occurs at the diagram template level when running the Create Diagram Layer Definition geoprocessing tool. This tool expects a network diagram layer as input from an active network map in which all layers are set up to connect the network source classes using a database connection.

See Initialize a custom diagram layer definition on a template for details.

How do I troubleshoot the following error when running a diagram template geoprocessing model in ModelBuilder: Rules that add elements cannot be set up after rules that can create aggregated elements?

Ensure that there are no rules to reduce or collapse elements before rules that add elements. Verify that the Alter Diagram Template tool you set up at the beginning of the model is configured with the Remove the diagram template rule and layout definitions box checked.

Also, before running the model, select the first tool in the sequence, click Validate on the ModelBuilder tab, and click Run to be sure you start the sequence from the beginning.

How can I remove existing sublayers under my diagram layers, add and configure new labels or change symbols on some sublayers, and make these changes to my diagram template?

This workflow starts with a test diagram that you generate or open using a database connection to your utility network in an enterprise geodatabase, or a utility network or trace network in a file or mobile geodatabase; that is, the open diagram cannot be created or opened from a utility network service. Then, from each layer under the network diagram layer, set the appearance and labeling settings in the same way you do when working with GIS layers. You can also remove any unnecessary layers. Then complete the following steps:

  1. Run Export Diagram Layer Definition with the network diagram layer you just modified as input.

    This allows you to export this new network diagram layer definition into an .ndld file.

  2. Run Import Diagram Template Definitions on your template with the .ndld file obtained after step 1, so this new network diagram layer definition applies to all diagrams based on that template.

See Remove existing diagram sublayers or customize settings on existing diagram sublayers.

Is it possible to add new diagram sublayers or overwrite settings on some existing diagram sublayers while preserving others?

Yes. Starting with ArcGIS Pro 2.7, you can meet more needs and expectations when refining your diagram layer definition. Here are some examples:

  • Report the appearance changes that happened on one layer in your network map to your network diagrams.
  • Add new layers to represent the junction or edge objects in your network diagrams since such objects are now part of your network.
  • Include an additional point layer to represent the network container polygons that you've just configured to be collapsed now in your network diagrams.
  • Switch from standard layer to subtype group layer—or vice versa—on some of the additional sublayers you have under your network diagram layers.

Such changes are available when you run the Create Diagram Layer Definition geoprocessing tool with the Overwrite all layers option unchecked.

See Add new diagram sublayers or overwrite settings on existing diagram sublayers.

Is it possible to manage annotation layers with network diagrams?

Network diagrams don't support annotations. Nothing prevents you to set up the labels you want on your diagram features using the Standard Label Engine or the Maplex Label Engine and make this labeling customisation apply by default for any newly opened diagram. However, this labeling customization cannot be done through annotations. There are many reasons for this. First of all, when opening a network diagram, there is no way to query the annotations in the annotation class that are related to the only diagram features in the active diagram. Moreover, after applying a diagram layout, the diagram feature geometry changes, but the annotation positions don't, and so are no longer properly placed regarding the feature new geometries.

How can I add labels on reduction edges or make reduction edge symbols vary according attributes in my network diagrams?

Starting with ArcGIS Pro 3.3 and Utility Network Version 7 or Trace Network Version 4, network diagrams supports a new field called Info in diagram feature classes. This text field can be filled in and managed using custom add-ins based on the Network Diagrams API available with ArcGIS Pro SDK for .NET, to store complex information aggregated in diagrams, such as information derived from network features or network objects, that is not easy to manage using ArcGIS Arcade functions. Then, this information can be used for custom rendering or labeling of diagram features, in particular, on reduction edges.