Add Diagram Template (Network Diagram Tools)

Summary

Adds a new diagram template to a network. A network diagram rule and layout definitions file (.ndbd) and a network diagram layer definition file (.ndld) can be imported.

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 Input Network parameter value must be from a database connection established as the database utility network owner or database trace network owner.

  • The connected ArcGIS Enterprise portal account must be the portal utility network owner or portal trace network owner.

  • This tool must be connected to the default version, which is expected to be public and not protected.

• Adding a new diagram template to a specified input network will create a template with no particular settings.

• When the tool runs with either no .ndld file or an empty .ndld file in input, the tool process automatically initializes a default diagram layer definition on the newly created template.

• The tool adds a layer definition ID 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 also improves the service start time.

Parameters

• Dialog
• Python

Label	Explanation	Data type
Input Network	The utility network or trace network to which the template will be added.	Utility Network; Trace Network
Diagram Template Name	The name of the output diagram template.	String
Rule and Layout Definitions File (Optional)	The network diagram rule and layout definitions file (.ndbd) that will be imported. This file can be created using the Export Diagram Template Definitions tool on an existing template.	File
Diagram Layer Definition File (Optional)	The diagram layer definition file (.ndld) that will be imported. This file can be created using the Export Diagram Template Definitions or Export Diagram Layer Definition tool on an existing template. When this parameter is not specified or loads an empty .ndld file, a default diagram layer definition is systematically initialized on the input diagram template.	File

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

Related topics

• An overview of the Configuration toolset
• Find a geoprocessing tool
• Introduction to diagram templates
• Import Diagram Template Definitions
• Alter Diagram Template
• Introduction to the diagram rule and layout definitions