Network diagram consistency

Existing diagrams may or may not be consistent.

Diagram consistency depends on the following:

  • The network topology space—Did the network topology space change since the last update of the diagram? Do those changes intersect the diagram geographical extent?
  • The network editing space—Do dirty areas exist on network features? If so, do those dirty areas impact diagram features (regardless of whether they are reduced or collapsed)?

The diagram consistency state can also automatically switch from consistent to inconsistent when the related diagram template is changed, for example, when changes are made to template properties or diagram rule and layout definitions.

Diagram consistency during user workflow

The next sections detail the diagram consistency life cycle during standard user workflow and explain how the consistency status is managed in the database, how it can be checked for a diagram; and the limitations of each status.

Diagram consistency life cycle

During standard user workflow, the diagram consistency changes depending on the operations occurring on the diagram, the network editing space, and the network topology space:

Diagram consistency state before the operationDoes not existConsistentInconsistent

Diagram creation

Consistent

NA

NA

Diagram update, overwrite, append

NA

Consistent

Consistent

Edits on network elements that are used to generate the diagram—regardless of whether those network elements are reduced or collapsed in the resulting diagram (see note below)

NA

Inconsistent

Inconsistent

Edits on network elements that are not used to generate the diagram

NA

Consistent

Inconsistent

Network topology validation on an extent that intersects the diagram geographical extent (1) or (2)

NA

Inconsistent

Inconsistent

Network topology validation on an extent that doesn't intersect the diagram geographical extent

NA

Consistent

Inconsistent

Network topology disabling

NA

Consistent

Inconsistent

Network topology reenabling

NA

Inconsistent

Inconsistent

Reconciling and posting versions resulting in dirty areas on network features related to the diagram

NA

Inconsistent

Inconsistent

The image below shows only the operations that change the diagram consistency from consistent to inconsistent or from inconsistent to consistent. It also differentiates consistency states between the network topology space and the network editing space.

Diagram consistency states

The following information relates to the operations shown in the image above:

  • Edits on network elements used in diagram refers to the following:
    • Edits on network features or network objects visibly represented in the diagram
    • Edits on network features or network objects aggregated (reduced or collapsed) in the diagram
    • Edits on connectivity, containment, or structural attachment associations relating to at least one network feature or network object used in the diagram
  • (1) Validate Topology—Validate topology on an extent that intersects the diagram geographical extent.
  • (2) Validate Topology—Validate topology after editing network elements that are used in the diagram.
  • (3) Update Diagram—The Update Diagram geoprocessing tool updates an inconsistent diagram to a consistent state. However, executing the Overwrite Diagram, Append Diagram, or Extend Diagram geoprocessing tool on an inconsistent diagram also changes its consistency state.

Diagram consistency in the database

The Consistency field in the database contains information about the network topology space. This field is systematically updated at the following times:

  • After the network topology is validated or re-enabled
  • After diagram generation, update, append, or overwrite

Note:

When edits that create or modify dirty areas occur on the network features or network objects, the Consistency field in the database does not update.

Diagram consistency errors and warnings

A consistency error or warning icon appears next to the diagram layer in the Contents pane when a diagram is inconsistent.

Diagram consistency errors and warnings when a diagram is opened

When the diagram is opened, the icon reflects the current consistency of the diagram. The system receives the Consistency field value from the database for the diagram as follows:

  • If it is inconsistent, the diagram opens with a warning icon May be inconsistent.
  • If it is consistent, the system checks the network editing space by identifying dirty areas on network features relative to edited network elements represented in the diagram, regardless of whether those network elements are reduced or collapsed in the diagram. If dirty areas exist, the diagram opens with an error icon Dirty features. Otherwise, no icon appears.

Diagram consistency errors and warnings for diagrams that are open in ArcGIS Pro

Icons for diagrams that are open in your ArcGIS Pro session may not reflect the current consistency, for example, operations you or another user performed during the ArcGIS Pro session may have made the diagrams you opened inconsistent. To check the current diagram consistency, click the Consistency button to update the consistency icons of the diagrams currently open in your project. This button is on the Network Diagram tab.

Consistency button on the Network Diagram tab

Diagram consistency errors and warnings next to diagram items in the Find Diagrams pane

The Find Diagrams pane only shows the Consistency field value stored in the database for each diagram. This means the following:

  • If the diagram is flagged in the database as consistent, no icon appears next to the diagram.
  • If the diagram is flagged in the database as inconsistent—that is, inconsistent with the network topology space—a warning icon May be inconsistent appears next to the diagram.

However, for diagrams that are inconsistent with the network editing space, no specific icon appears in the Find Diagrams pane. This means that a diagram that appears with no icon or with a warning icon in this pane may appear with an error icon Dirty features after you open it.

Limitations due to dirty areas and network topology state during user workflow

While working with your network diagrams, you may not be able to generate, update, overwrite, extend, or append features to your diagrams. These situations are likely caused by any of the following:

  • The network topology is invalid.
  • The features or objects currently selected in your network map do not belong to the network or they are related to nondirty areas.
  • The edits that occurred on the network.

The table below summarizes the possible network diagram operations based on the situation:

SituationConsistent diagram Update diagram Append features to diagram Overwrite diagram Generate a new diagram

Only nonnetwork elements are selected in the map.

NA

NA

No—The selection doesn't contain features or objects related to the active network.

No—The selection doesn't contain features or objects related to the active network.

No—The selection doesn't contain features or objects related to the active network.

Network features or objects that were used to generate the diagram have been edited—whether or not those network elements are reduced or collapsed in the resulting diagram.

Dirty features

No—The diagram currently contains network elements related to dirty areas.

No—The diagram currently contains network elements related to dirty areas.

Possible—Except from network elements related to dirty areas.

Possible—Except from any network elements related to dirty areas.

Network features or objects that were not used to generate the diagram have been edited.

Yes

Yes

Possible—Except from any network elements related to dirty areas.

Possible—Except from any network elements related to dirty areas.

Possible—Except from any network elements related to dirty areas.

The network topology has been partially validated on an extent that intersects the diagram geographical extent.

May be inconsistent

Yes

Possible—Except from any network elements related to dirty areas that may remain.

Possible—Except from any network elements related to dirty areas that may remain.

Possible—Except from any network elements related to dirty areas that may remain.

The network topology has been partially validated on an extent that doesn't intersect the diagram geographical extent.

Yes

Yes

Possible—Except from any network elements related to dirty areas that may remain.

Possible—Except from any network elements related to dirty areas that may remain.

Possible—Except from any network elements related to dirty areas that may remain.

The network topology has been disabled.

Yes

No—The network topology is invalid.

No—The network topology is invalid.

No—The network topology is invalid.

No—The network topology is invalid.

The network topology has been reenabled.

May be inconsistent

Yes

Yes

Yes

Yes

Versions have been reconciled and posted in the default version.

Possible—Depending on the network topology state (see note below).

Yes—If the network topology is valid.

Yes—If the network topology is valid.

Yes—If the network topology is valid.

Yes—If the network topology is valid.

Caution:

When working with a utility network stored in an enterprise geodatabase and you are reconciling and posting versions to the default version, even when the network topology is valid and all diagrams appear to be consistent, it is recommended that you update all diagrams. During the reconcile and post processes, diagrams may have been merged, and the diagram feature geometries or diagram statistics need to be updated.

Learn more about network diagrams reconcile and post processes

Diagram consistency after altering the related diagram template definition

The diagram consistency state may also be inconsistent after the database utility network owner runs configuration and administration geoprocessing tools such as Import Diagram Template Definitions or Alter Diagram Template or any Add <XXX> Rule tool or Add <XXX> Layout tool on the related diagram template.

This can happen when one of the following changes occurs to the related diagram template:

  • A new network diagram rule and layout definitions file (.ndbd) is imported
  • The diagram template rule and layout definitions are removed
  • The container margin size is changed
  • A diagram rule or diagram layout is added
  • A diagram rule or diagram layout is removed
  • A diagram rule or diagram layout is edited

After these changes, the Consistency field value switches to inconsistent in the database for all diagrams related to the altered template. Any diagram based on this template now opens with a consistency warning May be inconsistent until it is updated.

Tip:

When performing changes on a diagram template as the utility network owner, consider scripting a batch job to execute the Update Diagram geoprocessing tool on the impacted template. If you are working with a utility network in an enterprise geodatabase, the script must loop on each version for all versions in the geodatabase to maintain diagram consistency.

Related topics