Add Diagram Feature Capability By Category Rule (Network Diagram)

Summary

Adds a diagram rule to assign a particular capability to diagram features according to network categories. This assignment occurs during the building of diagrams based on an existing template. This capability is used by other rules that are run later in the rule sequence. The diagram features that will be processed depend on whether they are tagged with specific network categories.

Learn more about the Add Diagram Feature Capability rule

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.

Note:

This tool only applies to diagram templates in Utility Network version 7 and later.

Usage

• This tool is not supported when working with a utility network service. You must use either a utility network in a file or mobile geodatabase, or a database connection to a utility 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.
  • The connected ArcGIS Enterprise portal account must be the portal utility network owner.
  • This tool must be connected to the default version, which is expected to be public and not protected.

• Use the Prevent related container from collapse or Allow related container to collapse option for the Capability parameter to flag content diagram features so they prevent or allow their related container to be collapsed by Collapse Container rules run later in the rule sequence. These are rules that are set up using the Add Collapse Container Rule, Add Collapse Container By Attribute Rule, or Add Collapse Container By Category Rule tool.

• Use the Prevent reduce junction or Allow reduce junction option for the Capability parameter to flag diagram junctions so they are discarded or allowed by Reduce Junction rules run later in the rule sequence. These are rules that are set up using the Add Reduce Junction Rule, Add Reduce Junction By Attribute Rule or Add Reduce Junction By Category Rule tool.

• The Add Diagram Feature Capability rule adds a specific capability to network features or network objects represented in the diagram so they are processed in a certain way by other diagram rules run later in the diagram building process. This tool allows you to configure the Add Diagram Feature Capability rule to run by network categories. This means that you can configure the addition of a specific capability to network features or network objects represented in the diagram depending on whether they are tagged with specific network categories.

Parameters

Dialog

Label	Explanation	Data Type
Input Network	The utility network containing the diagram template that will be modified.	Utility Network
Input Diagram Template	The name of the diagram template that will be modified.	String
Active	Specifies whether the rule will be active when generating and updating diagrams based on the specified template. Checked—The added rule will become active during the generation and update of any diagrams based on the input template. This is the default. Unchecked—The added rule will not become active during the generation or update of any diagrams based on the input template.	Boolean
Rule Process	Specifies how the network features or network objects that are tagged with the specified network categories will be processed. Exclude categories—The network features or network objects that are tagged with the specified categories will not be processed, while other network features and network objects will be processed. This is the default. Include categories—The network features or network objects that are tagged with the specified categories will be processed.	String
Categories	The network categories that will be excluded or included depending on the Rule Process parameter value. If the Rule Process parameter is set to Include categories, one or more network categories must be specified. The specified capability will be assigned to any diagram features that are related to network features and network objects that are tagged with the specified network categories. If the Rule Process parameter is set to Exclude categories, the specified capability will be assigned to any diagram features that are related to network features and network objects that are not tagged with the specified network categories.	String
Capability	Specifies the capability that will be assigned to the diagram features filtered out by categories at the end of the rule operation. The specified capability will be used by other rules that run later in the rule sequence. Prevent related container from collapse— All features filtered out by categories will be flagged to prevent their related container from being collapsed by Collapse Container rules that run later in the rule sequence. This is the default. Allow related container to collapse— All features filtered out by categories will be flagged to allow their related container to be collapsed by Collapse Container rules that run later in the rule sequence. Prevent reduce junction— All junctions filtered out by categories will be flagged to prevent reduction by Reduce Junction rules that run later in the rule sequence. Allow reduce junction— All junctions filtered out by categories will be flagged to allow reduction by Reduce Junction rules that run later in the rule sequence.	String
Description (Optional)	The description of the rule.	String

Derived Output

Label	Explanation	Data Type
Output Network	The updated utility network.	Utility Network
Output Diagram Template	The name of the diagram template.	String

Python

arcpy.nd.AddDiagramFeatureCapabilityByCategoryRule(in_utility_network, template_name, is_active, inverse_category_selection, category, capability, {description})

Name	Explanation	Data Type
in_utility_network	The utility network containing the diagram template that will be modified.	Utility Network
template_name	The name of the diagram template that will be modified.	String
is_active	Specifies whether the rule will be enabled when generating and updating diagrams based on the specified template. ACTIVE—The added rule will become enabled during the generation and update of any diagrams based on the input template. This is the default. INACTIVE—The added rule will not become enabled during the generation or update of any diagrams based on the input template.	Boolean
inverse_category_selection	Specifies how the network features or network objects that are tagged with the specified network categories will be processed. EXCLUDE_CATEGORIES—The network features or network objects that are tagged with the specified categories will not be processed, while other network features and network objects will be processed. This is the default. INCLUDE_CATEGORIES—The network features or network objects that are tagged with the specified categories will be processed.	String
category [category,...]	The network categories that will be excluded or included depending on the inverse_category_selection parameter value. If the inverse_category_selection parameter is set to INCLUDE_CATEGORIES, one or more network categories must be specified. The specified capability will be assigned to any diagram features that are related to network features and network objects that are tagged with the specified network categories. If the inverse_category_selection parameter is set to EXCLUDE_CATEGORIES, the specified capability will be assigned to any diagram features that are related to network features and network objects that are not tagged with the specified network categories.	String
capability	Specifies the capability that will be assigned to the diagram features filtered out by categories at the end of the rule operation. The specified capability will be used by other rules that run later in the rule sequence. PREVENT_TO_COLLAPSE_CONTAINER— All features filtered out by categories will be flagged to prevent their related container from being collapsed by Collapse Container rules that run later in the rule sequence. This is the default. ALLOW_TO_COLLAPSE_CONTAINER— All features filtered out by categories will be flagged to allow their related container to be collapsed by Collapse Container rules that run later in the rule sequence. PREVENT_TO_REDUCE_JUNCTION— All junctions filtered out by categories will be flagged to prevent reduction by Reduce Junction rules that run later in the rule sequence. ALLOW_TO_REDUCE_JUNCTION— All junctions filtered out by categories will be flagged to allow reduction by Reduce Junction rules that run later in the rule sequence.	String
description (Optional)	The description of the rule.	String

Derived Output

Name	Explanation	Data Type
out_utility_network	The updated utility network.	Utility Network
out_template_name	The name of the diagram template.	String

Code sample

AddDiagramFeatureCapabilityByCategoryRule example (stand-alone script)

Add a Diagram Feature Capability rule to the MyTemplate1 template to flag all subnetwork controllers so they prevent their container from being collapsed later. Since the Subnetwork Controller network category exists and is assigned to all subnetwork controllers in the network, you can also run the AddDiagramFeatureCapabilityByCategoryRule function to flag all subnetwork controllers so they prevent their related containers from collapsing.

import arcpy
input_Network = 'D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.Electric'
input_NetworkCategory = 'Subnetwork Controller'
input_DiagramTemplate = 'MyTemplate1'

arcpy.nd.AddDiagramFeatureCapabilityByAttributeRule(
    input_Network, input_DiagramTemplate, 'ACTIVE', 'INCLUDE_CATEGORIES',
    input_NetworkCategory, 'PREVENT_TO_COLLAPSE_CONTAINER')

Environments

This tool does not use any geoprocessing environments.

Licensing information

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