Summary
Adds a diagram rule to automatically represent connectivity associations during the building of diagrams based on an existing template. This rule processes connectivity associations in which both the from and to junctions are currently represented in the diagrams.
Learn more about adding connectivity associations to diagrams
Caution:
This tool is a configuration and administration tool.
Note:
This tool impacts the consistency of any existing diagrams based on the input diagram template. All of the existing diagrams become inconsistent and open with a consistency warning icon 
until they are updated.
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 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.
-
Connectivity associations are not drawn by default in a network map. The Add Connectivity Associations rule allows you to generate diagrams in which connectivity associations are systematically drawn each time the related from and to junctions are present in the diagram at the time the rule executes. They display as straight diagram edges between the from and to diagram junctions they connect.
Consider the diagram template's rule sequence before adding an Add Connectivity Associations rule, because it is time consuming. The Add Connectivity Associations rule should only be set on templates when the completeness of the diagram graph regarding connectivity associations is not already guaranteed by other diagram rules. For example, if the template is already configured to run a Trace rule, there is no reason to specify an Add Connectivity Associations rule, since connectivity associations will be returned by the trace.
Syntax
arcpy.nd.AddConnectivityAssociationsRule(in_utility_network, template_name, is_active, {description})| Parameter | Explanation | Data Type |
in_utility_network | The utility network or trace network containing the diagram template to modify. | Utility Network; Trace Network |
template_name | The name of the diagram template to modify. | String |
is_active | Specifies whether the rule will be enabled when generating and updating diagrams based on the specified template.
| Boolean |
description (Optional) | The description of the rule. | String |
Derived Output
| Name | Explanation | Data Type |
| out_utility_network | The updated utility network or trace network. | Utility Network; Trace Network |
| out_template_name | The name of the diagram template. | String |
Code sample
The following script creates a template similar to the Basic template in a given network.
import arcpy
input_Network = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.Electric"
input_DiagramTemplate = "SameAsBasicTemplate"
arcpy.AddDiagramTemplate_nd(input_Network, input_DiagramTemplate)
arcpy.AlterDiagramTemplate_nd(input_Network, input_DiagramTemplate,
input_DiagramTemplate, "NOT_DEFAULT_TEMPLATE",
"DO_NOT_REMOVE_RULES_AND_LAYOUTS",
"KEEP_VERTICES", "0.3 Meters")
arcpy.AddConnectivityAssociationsRule_nd(input_Network,
input_DiagramTemplate, "ACTIVE")
arcpy.AddStructuralAttachmentsRule_nd(input_Network,
input_DiagramTemplate, "ACTIVE")Environments
Licensing information
- Basic: No
- Standard: Yes
- Advanced: Yes