Add Reduce Junction Rule (Network Diagram)

Summary

Adds a diagram rule to automatically reduce diagram junctions during diagram building based on an existing template. This tool reduces junctions based on several network junction source classes and object tables according to the number of other junctions to which they are connected.

Learn more about the reduction of junctions in 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.

• The Reduce Junction rule is used to simplify the diagram graph while preserving the topology.

  This tool allows the configuration of a Reduce Junction rule to reduce junctions based on different network junction classes and object tables according to the number of their adjacent junctions—that is, the number of junctions to which they are connected and, optionally, to particular attributes on their adjacent edges.

  You can configure this tool to reduce either all diagram features that are based on specified network junction source classes and object tables or all diagram features except those based on the specified network junction source classes and object tables.

  When this tool is configured with Rule Process set to Exclude source classes (rule_process = "EXCLUDE_SOURCE_CLASSES" in Python) and no junction source classes or object tables are specified, it works on each junction in the processed diagram regardless of its junction source class or object table. It can be configured to reduce all unconnected junctions in the diagrams, for example.

  By default, this tool is configured with Rule Process set to Include source classes (rule_process = "INCLUDE_SOURCE_CLASSES" in Python) and expects one or more junction source classes or object tables to be processed.

  Learn more about reductions in diagrams

• When the SystemJunctions class exists among the specified Junction Sources parameter (junction_source in Python) 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 to modify.	Utility Network; Trace Network
Input Diagram Template	The name of the diagram template to modify.	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 (Optional)	Specifies how the specified junction source classes and object tables will be processed. Exclude source classes —Junctions based on the specified source classes and object tables will not be processed, while other junctions will be processed. Include source classes —Only junctions based on the specified source classes and object tables will be processed. This is the default.	String
Junction Sources (Optional)	A list of the network junction source class (or classes) and object table (or tables) that will be excluded or included depending on the rule process. When Rule Process is set to Include source classes (inverse_source_selection = "INCLUDE_SOURCE_CLASSES" in Python), the default, one or more network junction source classes or object tables will be processed. All diagram junctions related to network junctions that belong to those source classes and object tables are reduction candidates. Note: The Add Reduce Junction Rule tool will process the junction source classes and object tables in the order of this list, from the junction class or table with the highest priority—the first class or table in the list—to the junction class or table with the lowest priority—the last class or table in the list. When Rule Process is set to Exclude source classes (inverse_source_selection = "EXCLUDE_SOURCE_CLASSES" in Python), no particular junction source class or object table must be specified. In this case, all junctions in the generated diagrams, regardless of their source class or object table, will be reduced. Note: When specifying the SystemJunctions class among the network junction source classes, the rule will systematically process both system junctions and system junction objects.	Table; Feature Class
Reduce Junctions With (Optional)	Specifies the number of junction connections that will be considered for reduction. Maximum two connected junctions —Junctions with two or less connections will be considered. In this case, a specific process will be executed according to the number of candidate junction connections that will be reduced. This is the default. Minimum three connected junctions —Junctions with three or more connections will be considered. In this case, upstream traces will be executed to determine whether candidate junction connections will be reduced.	String
Reduce if unconnected (Optional)	Specifies whether each unconnected network diagram junction candidate will be reduced. This parameter is only active when Reduce Junctions With is set to Maximum two connected junctions. Checked—Unconnected network diagram junction candidates will be reduced. Each junction will be removed. Unchecked—Unconnected network diagram junction candidates will not be reduced; they will be kept. This is the default.	Boolean
Reduce if connected to a single junction (Optional)	Specifies whether each network diagram junction reduction candidate that is connected to a single junction will be reduced. This parameter is only active when Reduce Junctions With is set to Maximum two connected junctions. Checked—Network diagram junction reduction candidates that are connected to a single junction will be reduced. Each junction and its incident edge will be reduced onto its single connected junction. Unchecked—Network diagram junction reduction candidates that are connected to a single junction will not be reduced; they will be kept. This is the default.	Boolean
Reduce if connected to 2 different junctions (Optional)	Specifies whether each network diagram junction reduction candidate that is connected to two other junctions will be reduced. This parameter is only active when Reduce Junctions With is set to Maximum two connected junctions. Checked—Network diagram junction reduction candidates that connect two other junctions will be reduced. Each junction and its incident edges will be reduced onto a super span edge (the reduction edge). This is the default. Unchecked—Network diagram junction reduction candidates that connect two other junctions will not be reduced; they will be kept.	Boolean
Edge Attribute Names (Optional)	The alias of the edge attributes adjacent to the junction reduction candidate. The junction will be reduced only when all of its adjacent edges have the same values for each specified attribute alias.	String
Description (Optional)	The description of the rule.	String

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.AddReduceJunctionRule(in_utility_network, template_name, is_active, {inverse_source_selection}, {junction_source}, {connectivity_options}, {unconnected_junctions}, {one_connected_junction}, {two_connected_junctions}, {edges_attributes}, {description})

Name	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. 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_source_selection (Optional)	Specifies how the specified junction source classes and object tables will be processed. EXCLUDE_SOURCE_CLASSES —Junctions based on the specified source classes and object tables will not be processed, while other junctions will be processed. INCLUDE_SOURCE_CLASSES —Only junctions based on the specified source classes and object tables will be processed. This is the default.	String
junction_source [junction_source,...] (Optional)	A list of the network junction source class (or classes) and object table (or tables) that will be excluded or included depending on the rule process. When Rule Process is set to Include source classes (inverse_source_selection = "INCLUDE_SOURCE_CLASSES" in Python), the default, one or more network junction source classes or object tables will be processed. All diagram junctions related to network junctions that belong to those source classes and object tables are reduction candidates. Note: The Add Reduce Junction Rule tool will process the junction source classes and object tables in the order of this list, from the junction class or table with the highest priority—the first class or table in the list—to the junction class or table with the lowest priority—the last class or table in the list. When Rule Process is set to Exclude source classes (inverse_source_selection = "EXCLUDE_SOURCE_CLASSES" in Python), no particular junction source class or object table must be specified. In this case, all junctions in the generated diagrams, regardless of their source class or object table, will be reduced. Note: When specifying the SystemJunctions class among the network junction source classes, the rule will systematically process both system junctions and system junction objects.	Table; Feature Class
connectivity_options (Optional)	Specifies the number of junction connections that will be considered for reduction. MAX_2_CONNECTED_JUNCTIONS —Junctions with two or less connections will be considered. In this case, a specific process will be executed according to the number of candidate junction connections that will be reduced. This is the default. MIN_3_CONNECTED_JUNCTIONS —Junctions with three or more connections will be considered. In this case, upstream traces will be executed to determine whether candidate junction connections will be reduced.	String
unconnected_junctions (Optional)	Specifies whether each unconnected network diagram junction candidate will be reduced. This parameter is only enabled when connectivity_options = "MAX_2_CONNECTED_JUNCTIONS". REDUCE_UNCONNECTED_JCT —Unconnected network diagram junction candidates will be reduced. Each junction will be removed. KEEP_UNCONNECTED_JCT —Unconnected network diagram junction candidates will not be reduced; they will be kept. This is the default.	Boolean
one_connected_junction (Optional)	Specifies whether each network diagram junction reduction candidate that is connected to a single junction will be reduced. This parameter is only enabled when connectivity_options = "MAX_2_CONNECTED_JUNCTIONS". REDUCE_JCT_TO_1JCT —Network diagram junction reduction candidates that are connected to a single junction will be reduced. Each junction and its incident edge will be reduced onto its single connected junction. KEEP_JCT_TO_1JCT —Network diagram junction reduction candidates that are connected to a single junction will not be reduced; they will be kept. This is the default.	Boolean
two_connected_junctions (Optional)	Specifies whether each network diagram junction reduction candidate that is connected to two other junctions will be reduced. This parameter is only enabled when connectivity_options = "MAX_2_CONNECTED_JUNCTIONS". REDUCE_JCT_TO_2JCTS —Network diagram junction reduction candidates that connect two other junctions will be reduced. Each junction and its incident edges will be reduced onto a super span edge (the reduction edge). This is the default. KEEP_JCT_TO_2JCTS —Network diagram junction reduction candidates that connect two other junctions will not be reduced; they will be kept.	Boolean
edges_attributes [edges_attributes,...] (Optional)	The alias of the edge attributes adjacent to the junction reduction candidate. The junction will be reduced only when all of its adjacent edges have the same values for each specified attribute alias.	String
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

AddReduceJunctionRule example (Python window)

Add a Reduce Junction rule to the MyTemplate1 template that exists for a given network to systematically reduce any electric system junctions and miscellaneous junctions that are unconnected or connected to two other junctions.

import arcpy

input_Network = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.Electric"
input_DiagramTemplate = "MyTemplate1"
input_JunctionClassToReduce1 = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.UN_112_SystemJunctions"
input_JunctionClassToReduce2 = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.ElectricDistributionJunction"

arcpy.AddReduceJunctionRule_nd(
    input_Network, input_DiagramTemplate, "ACTIVE", 
    'INCLUDE_SOURCE_CLASSES', 
    input_JunctionClassToReduce1 + ";" + input_JunctionClassToReduce2, 
    "MAX_2_CONNECTED_JUNCTIONS", "REDUCE_UNCONNECTED_JCT", "KEEP_JCT_TO_1JCT", 
    "REDUCE_JCT_TO_2JCTS")

AddReduceJunctionRule example 2 (Python window)

Add a Reduce Junction rule to the MyTemplate2 template that exists for a given network to systematically reduce any miscellaneous junctions when they connect two other junctions and their adjacent edges have the same values for the Asset type and Phases couple of attributes.

import arcpy

input_Network = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.Electric"
input_DiagramTemplate = "MyTemplate2"
input_JunctionClassToReduce1 = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.ElectricDistributionJunction"
input_Alias1 = "Asset type"
input_Alias2 = "Phases"

arcpy.AddReduceJunctionRule_nd(
    input_Network, input_DiagramTemplate, "ACTIVE", 
    'INCLUDE_SOURCE_CLASSES', input_JunctionClassToReduce1, 
    "MAX_2_CONNECTED_JUNCTIONS", "KEEP_UNCONNECTED_JCT", "KEEP_JCT_TO_1JCT",
    "REDUCE_JCT_TO_2JCTS", input_Alias1 + ";" + input_Alias2)

Environments

This tool does not use any geoprocessing environments.

Licensing information

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