Skip To Content

Add Reduce Edge By Attribute Rule

Summary

Adds a diagram rule to automatically reduce diagram edges during the building of diagrams based on an existing template. This rule can be set up to reduce diagram edges by attributes.

Learn more about the reduction of edges in diagrams

Caution:

This tool is a configuration and administration tool that must be run by the database owner of the utility network through a direct connection to the default version. In addition to that requirement, the connected portal account must be the owner of the utility network to perform this operation. This essentially forms two-factor authentication.

Usage

  • The Reduce Edge rule is used to simplify the diagram graph while preserving the topology by merging each expected utility network line feature and all its connection points into a schematic diagram junction. Such a junction is called a reduction junction.

    Any reduction junction in the resulting diagram aggregates one utility network line feature and all its connection points; that is, a reduction junction cannot aggregate several utility network line features.

  • The Reduce Edge rule is particularly useful when reducing specific utility network line features such as bus bars.

Syntax

AddReduceEdgeByAttributeRule_un (in_utility_network, template_name, is_active, network_source, {where_clause}, {description}, {reconnected_edges_option})
ParameterExplanationData Type
in_utility_network

The utility network referencing the diagram template to modify.

Utility Network
template_name

The name of the diagram template to modify.

String
is_active

Specifies whether the rule is enabled when generating and updating diagrams based on the specified template.

  • ACTIVEThe added rule becomes enabled during the generation and update of any diagrams based on the input template. This is the default.
  • INACTIVEThe added rule is not enabled during the generation or update of any diagrams based on the input template.
Boolean
network_source

The network edge source class to process during the reduction rule. All diagram edges related to network lines that belong to this source class are candidates for the reduction.

Feature Class
where_clause
(Optional)

An SQL expression used to select the subset of network edges among the edges that are candidates for the reduction that will be reduced in the diagrams based on the input template. For more information on SQL syntax, see the SQL reference for query expressions used in ArcGIS help topic.

SQL Expression
description
(Optional)

The description of the rule.

String
reconnected_edges_option
(Optional)

Specifies whether the rule must aggregate the edges that are reconnected to the reduction junctions or not.

  • DONT_AGGREGATE_RECONNECTED_EDGESAny edge connecting a point along the edge that is reduced is kept and simply reconnected to the reduction junction.
  • AGGREGATE_RECONNECTED_EDGESAny edge connecting a point along the edge that is reduced is replaced by a reduction edge. This reduction edge is reconnected to the reduction junction. This is the default.
Boolean

Derived Output

NameExplanationData Type
out_utility_network

The updated utility network.

Utility Network
out_template_name

The name of the network template.

String

Code sample

AddReduceEdgeByAttributeRule example (Python window)

Add a Reduce Edge By Attribute rule to the MyTemplate1 template that exists for a given utility network to systematically reduce any busbar distribution lines (and all their related connected junctions to a junction) in the generated diagrams.

import arcpy
input_UtilityNetwork = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.Electric"
input_DiagramTemplate = "MyTemplate1"
input_EdgeLineClassToReduce = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.ElectricDistributionLine"

arcpy.AddReduceEdgeByAttributeRule_un(input_UtilityNetwork, input_DiagramTemplate, 'ACTIVE', input_EdgeLineClassToReduce, "ASSETGROUP = 1", '', 'AGGREGATE_RECONNECTED_EDGES')

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics