Skip to main content

Alter Diagram Template (Network Diagram Tools)

Summary

Alters the properties of a diagram template.

This tool supports the following specific diagram template property alterations:

  • Changing the name of the template

  • Setting a template as the default template

  • Removing the rule and layout definitions

  • Resetting the diagram layer definition to the default

  • Specifying the way the template works with vertices along input network edges

  • Specifying whether reflexive connectivity associations are kept for the generated diagrams

  • Specifying whether linear containers must be removed from the generated diagrams

  • Defining the margin size between containers and their contents

  • Defining the radius of the reflexive connectivity associations

  • Disabling the storage capability for those diagrams

  • Enabling the extend diagram capabilities

  • Specifying whether the template is associated with a specific telecom domain

  • Specifying whether the aggregations must be persisted during the diagram building

Note:

Changing the size of the container margin or removing the diagram rule and layout definitions causes the Consistency field value in the database to switch to inconsistent for any existing diagram based on the input diagram template. All of these diagrams remain inconsistent and open with a consistency warning icon until they are updated.

Caution:

This tool is a configuration and administration tool.

Usage

  • This tool is not supported when working with a utility network or trace network service. You must use either a utility network or trace network in a file or mobile geodatabase, or a database connection to a utility network or trace network in an enterprise geodatabase. When working with an enterprise geodatabase, the following are requirements:

  • The network data element specified for the Input Network parameter must be from either a utility network or trace network in a file or mobile geodatabase, or a database connection to a utility network or trace network in an enterprise geodatabase.

  • Initializing vertices along diagram edges at diagram generation and managing them at diagram display is time consuming. To avoid impacting performance, check the Keep initial vertices on edges parameter only when needed. For example, if the template is configured to apply an automatic diagram layout at generation, check this parameter for the Relative Mainline and Partial Overlapping Edges diagram layouts. The other diagram layout types don't use vertices on diagram edges during their operation; they use diagram junction positions.

  • Starting with ArcGIS Pro 2.6, this tool systematically initializes a default diagram layer definition for the input diagram template if it doesn't already exist.

  • When configuring a model to set up new rule and layout definitions for a diagram template, run the Alter Diagram Template tool with the Remove the diagram template rule and layout definitions parameter checked at the beginning of the model. This will cause the model to reinitialize the template properties to their default settings.

  • Starting with Enterprise 12.1, the persistence of the aggregations during diagram building can be turned off. Persisting aggregations allows to keep track of network features and network objects which are collapsed, reduced or removed during diagram building. However, it impacts diagram creation and update time and can also grandly increase the dataset size. When this persistence has a limited interest for user workflows, the Persist aggregations option can be unchecked.

Parameters

Label Explanation Data type

Input Network

The utility network or trace network of the diagram template that will be altered.

Utility Network; Trace Network

Input Diagram Template

The name of the diagram template that will be altered.

String

New Template Name

(Optional)

The new name of the template.

String

Default template

(Optional)

Specifies the default status of the input template. The default template is used when generating a diagram if no template is specified.

  • Checked—The input diagram template will be the default template.

  • Unchecked—The input diagram template will not be the default template. This is the default.

Boolean

Remove the diagram template rule and layout definitions

(Optional)

Specifies whether the template rule and layout definitions will be removed.

  • Checked—The rule and layout definitions related to the input diagram template will be removed.

  • Unchecked—The rule and layout definitions related to the input diagram template will not be removed. This is the default.

Boolean

Keep initial vertices on edges

(Optional)

Specifies how vertices along the GIS edges will be managed in the diagrams based on the template.

Note:

For performance quality, check the Keep initial vertices on edges option only when needed. If the template is configured to run an automatic layout at diagram generation, for example, checking this option makes sense for the Relative Mainline and Partial Overlapping Edges diagram layouts. The other diagram layouts don't use diagram edges geometry.

  • Checked—All vertices that display along GIS edges will be preserved on the associated edges in each network diagram based on the template.

  • Unchecked—Diagram edges will be drawn as straight lines between their connected junctions. This is the default.

Boolean

Container Margin

(Optional)

The minimum distance between the center of any junctions inside the container and the container border.

Linear Unit

Enable diagram storage

(Optional)

Specifies whether the diagrams based on the template can be stored.

  • Checked—The diagrams based on the template can be stored. This is the default.

  • Unchecked—The diagrams based on the template cannot be stored.

Boolean

Enable to extend diagram

(Optional)

Specifies whether the diagrams based on the template can be extended.

  • Checked—The diagrams based on the template can be extended by connectivity, traversability, containment, or attachment.

  • Unchecked—The diagrams based on the template cannot be extended. This is the default.

Boolean

Description

(Optional)

The description of the template.

String

Reset the diagram template layer definition to default

(Optional)

Specifies whether the diagram template layer definition will be reset to the default.

  • Checked—The diagram layer definition related to the input diagram template will be reset to the default (removed).

    Note:

    A layer definition ID will be added to the template. This ID helps the network owner to control how diagram layer definitions are shared between diagram templates and improve this sharing. For a published utility network or trace network service, this ID will also improve the service startup time.

  • Unchecked—The diagram layer definition related to the input diagram template will not be removed. This is the default.

Boolean

Keep reflexive connectivity associations

(Optional)

Specifies whether reflexive connectivity associations will be kept at diagram building

  • Checked—Reflexive connectivity associations will be kept at diagram building. This is the default.

  • Unchecked—Reflexive connectivity associations will be systematically removed at diagram building.

Boolean

Remove linear containers

(Optional)

Specifies whether linear containers will be removed at the completion of the diagram building.

  • Checked—Linear containers will be removed at the completion of the diagram building.

  • Unchecked—Linear containers in the generated diagram will be kept. This is the default.

Boolean

Reflexive Edge Radius

(Optional)

The minimum radius of the reflexive connectivity association edges. For multiple reflexive connectivity association edges on a junction, the reflexive edge radius increases 0.5 at each level.

Linear Unit

Associate template to telecom domain

(Optional)

Specifies whether the template will be associated to a telecom domain.

  • Checked—The template will be associated to a telecom domain. It will automatically apply when generating circuit diagrams from the Find Circuits pane.

  • Unchecked—The template will be not associated to any telecom domain. This is the default.

Boolean

Telecom Domain Name

(Optional)

The name of the telecom domain the template will be associated with.

String

Persist aggregations

(Optional)

Specifies whether the aggregated diagram features must be persisted during the diagram building.

  • Checked—The aggregations will be persisted during the diagram building. This is the default.

  • Unchecked—The aggregations will be not persisted during the diagram building.

Boolean

Derived output

Label Explanation Data type

Output Network

The updated utility network or trace network.

Utility Network; Trace Network

Output Diagram Template

The name of the diagram template.

String

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: No
  • Standard: Yes
  • Advanced: Yes