Add Remove Feature Rule (Network Diagram)

Summary

Adds a diagram rule to automatically remove diagram features during diagram building based on an existing template. This rule removes diagram features based on different network source classes and object tables. You can constrain the removal of features based on connectivity.

Learn more about feature and nonspatial object removal in network 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 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.

• The Remove Feature rule is used to remove specific network features or network objects represented in diagrams. This rule removes these network elements by source class or object table and, optionally, filters them based on connectivity constraints, or their attributes.

  This tool is used to configure the Remove Feature rule so it removes either all diagram features that are based on specified network source classes and object tables or all diagram features except those based on the specified network source classes and object tables.

  By default, the Rule Process parameter is set to Include source classes (inverse_source_selection = "INCLUDE_SOURCE_CLASSES" in Python) and expects one or more network source classes or object tables with all their features or objects, respectively, to be systematically discarded in the generated diagram.

  When the Rule Process parameter is set to Exclude source classes (inverse_source_selection = "EXCLUDE_SOURCE_CLASSES" in Python), all network features and objects represented in the diagrams are removed except those based on the specified network source classes and object tables. Use this parameter to remove all features in diagrams except those representing electric transmission lines, for example, and to guarantee that diagrams showing only the electric transmission part of the network regardless of what the end user selects as input for the diagram generation will be returned.

• Starting with ArcGIS Pro 2.9, you can configure particular constraints based on connectivity so that the Remove Feature rule only applies to unconnected junctions or junctions connected to a single junction in the network diagram. These constraints can be set up to process network features or objects represented as diagram junctions or diagram containers.

• You can use this tool to configure automatic discard of diagram features based on network source classes or object tables that may be present among the input network features and objects set during diagram building. For example, when an area is selected without prefiltering any features and you want the diagram from this area to show only the primary equipment, you can configure a Remove Feature rule to automatically remove any secondary equipment that may be present in the input network elements set.

• When the Remove Feature rule is executed at the first position in the list of rules related to a template, it permanently deletes the initial diagram features, gaining space and improving performance for additional updates.

• If representing network linear containers and their related contents together in diagrams is confusing or of little interest, you can also use this tool to remove linear container edges from diagrams. In this case, the Remove Feature rule is typically executed at the end of the rule sequence.

• When the SystemJunctions class exists among the specified Network Sources parameter values, the rule is systematically applied to both system junctions and system junction objects.

Parameters

Dialog

Label	Explanation	Data Type
Input Network	The utility network or trace network containing the diagram template that will be modified.	Utility Network; Trace 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
Source Type	Specifies the geometry type of the source class or object table to be processed. Junctions only—Only junction source classes or object tables (network polygon source classes, network point source classes, or junction object tables) will be processed. Edges only—Only edge source classes or object tables (network line source classes or edge object tables) will be processed. Both junctions and edges—Both junction and edge types will be processed. This is the default.	String
Rule Process	Specifies how the specified network source classes and object tables will be processed. Exclude source classes—Features and objects based on the specified network source classes and object tables will not be removed, while other features and objects will be removed. Include source classes—Features and objects based on the specified network source classes and object tables will be removed. This is the default.	String
Network Sources	The network source class (or classes) and object table (or tables) that will be excluded or included depending on the rule process. By default, Rule Process parameter is set to Include source classes, and one or more network source classes or object tables will be processed. All diagram features related to network features and objects that belong to those classes and object tables will be removed. Note: When specifying the SystemJunctions class among the network source classes, the rule will systematically process both system junctions and system junction objects.	Table; Feature Class
Description (Optional)	The description of the rule.	String
Junctions must be unconnected	Specifies whether diagram junction and diagram container candidates must be unconnected to be removed. Checked—Diagram junction and diagram container candidates must be unconnected to be removed. Unchecked—Neither diagram junction nor diagram container candidates need to be unconnected to be removed. This is the default. Note: This parameter is active only when the Source Type parameter is set to Junctions only.	Boolean
Junctions must be connected to a single junction	Specifies whether diagram junction and diagram container candidates must be connected to a single diagram junction or diagram container to be removed. Checked—Diagram junction and diagram container candidates must be connected to a single diagram junction or diagram container to be removed. Unchecked—Neither diagram junction nor diagram container candidates need to be connected to a single diagram junction or diagram container to be removed. This is the default. Note: This parameter is active only when the Source Type parameter is set to Junctions only.	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

Python

arcpy.nd.AddRemoveFeatureRule(in_utility_network, template_name, is_active, source_type, inverse_source_selection, network_source, {description}, unconnected_junctions, one_connected_junction)

Name	Explanation	Data Type
in_utility_network	The utility network or trace network containing the diagram template that will be modified.	Utility Network; Trace 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
source_type	Specifies the geometry type of the source class or object table to be processed. JUNCTIONS—Only junction source classes or object tables (network polygon source classes, network point source classes, or junction object tables) will be processed. EDGES—Only edge source classes or object tables (network line source classes or edge object tables) will be processed. BOTH—Both junction and edge types will be processed. This is the default.	String
inverse_source_selection	Specifies how the specified network source classes and object tables will be processed. EXCLUDE_SOURCE_CLASSES—Features and objects based on the specified network source classes and object tables will not be removed, while other features and objects will be removed. INCLUDE_SOURCE_CLASSES—Features and objects based on the specified network source classes and object tables will be removed. This is the default.	String
network_source [network_source,...]	The network source class (or classes) and object table (or tables) that will be excluded or included depending on the rule process. By default, inverse_source_selection parameter is set to INCLUDE_SOURCE_CLASSES, and one or more network source classes or object tables will be processed. All diagram features related to network features and objects that belong to those classes and object tables will be removed. Note: When specifying the SystemJunctions class among the network source classes, the rule will systematically process both system junctions and system junction objects.	Table; Feature Class
description (Optional)	The description of the rule.	String
unconnected_junctions	Specifies whether diagram junction and diagram container candidates must be unconnected to be removed. MUST_BE_UNCONNECTED—Diagram junction and diagram container candidates must be unconnected to be removed. NO_CONSTRAINT—Neither diagram junction nor diagram container candidates need to be unconnected to be removed. This is the default. Note: This parameter is only used when the source_type parameter is set to JUNCTIONS.	Boolean
one_connected_junction	Specifies whether diagram junction and diagram container candidates must be connected to a single diagram junction or diagram container to be removed. MUST_BE_CONNECTED_TO_SINGLE_JUNCTION—Diagram junction and diagram container candidates must be connected to a single diagram junction or diagram container to be removed. NO_CONSTRAINT—Neither diagram junction nor diagram container candidates need to be connected to a single diagram junction or diagram container to be removed. This is the default. Note: This parameter is only used when the source_type parameter is set to JUNCTIONS.	Boolean

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

AddRemoveFeatureRule example (stand-alone script)

This sample script adds a Remove Feature rule to the MyTemplate1 template existing for a given network to remove all network features and objects, except the electric transmission lines, and to build diagrams that only focus on the electric transmission part of the network.

import arcpy
input_Network = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.Electric"
input_DiagramTemplate = "MyTemplate1"
input_DoNotRemoveThisClass = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.ElectricTransmissionLine"

arcpy.AddRemoveFeatureRule_nd(input_Network, input_DiagramTemplate, 
                              'ACTIVE', 'EDGES', 'EXCLUDE_SOURCE_CLASSES', 
                              input_DoNotRemoveThisClass)

Environments

This tool does not use any geoprocessing environments.

Licensing information

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