| 名称 | 说明 | 数据类型 |
in_utility_network | 包含要修改的逻辑示意图模板的公共设施网络或追踪网络。 | Utility Network; Trace Network |
template_name | 要修改的逻辑示意图模板名称 | String |
is_active | 指定在基于指定模板生成并更新逻辑示意图时，规则是否将处于启用状态。 - ACTIVE—在基于输入模板生成并更新逻辑示意图的过程中，添加的规则将会变为启用状态。 这是默认设置。
- INACTIVE—在基于输入模板生成或更新逻辑示意图的过程中，添加的规则将不会变为启用状态。
| Boolean |
trace_type | 请指定为了构建逻辑示意图内容将运行的追踪类型。 - CONNECTED—当规则开始并沿连接元素向外跨越时，将通过逻辑示意图中当前表示的公共设施网络或追踪网络元素运行连接的追踪。 这是默认设置。
- SUBNETWORK—当规则开始并沿连接元素向外跨越时，将通过逻辑示意图中当前表示的公共设施网络元素来运行子网追踪，以查找沿相关子网向外跨越的源或汇。
- UPSTREAM—当规则开始时，将通过逻辑示意图中当前表示的公共设施网络或追踪网络元素运行上游追踪，以查找上游元素。
- DOWNSTREAM—当规则开始时，将通过逻辑示意图中当前表示的公共设施网络或追踪网络元素运行下游追踪，以查找下游元素。
- SHORTEST_PATH—当规则开始沿起点之间的最短路径查找要素时，系统将从逻辑示意图中当前指定为起点的公共设施网络或追踪网络要素运行最短路径追踪。 遍历路径的成本取决于为最短路径网络属性名称参数值 / path_network_weight_name 设置的网络属性，而与流向无关。
| String |
domain_network (可选) | 针对公共设施网络运行追踪的域网络名称。 运行子网、上游和下游追踪类型时，需要此参数。 | String |
tier (可选) | 针对公共设施网络开始追踪的层名称。 运行已连接追踪类型时可以使用此参数；运行子网、上游和下游追踪类型时必须使用此参数。 | String |
target_tier (可选) | 公共设施网络输入层流向的目标层名称。 如果上溯和下溯追踪的此参数丢失，当到达起始子网边界时，上述追踪将停止。 该参数可以使此类追踪在层级结构中继续向上或向下延伸。 | String |
include_structures (可选) | 指定追踪结果中是否包含结构要素和对象。 - INCLUDE_STRUCTURES—追踪结果中将包含结构要素和对象。
- EXCLUDE_STRUCTURES—追踪结果中将不包含结构要素和对象。 这是默认设置。
| Boolean |
include_barriers (可选) | 指定追踪结果中是否包含可遍历性障碍要素。 即使已在子网定义中进行了预设，可遍历性障碍仍可选。 此参数不适用于具备终端的设备要素。 - INCLUDE_BARRIERS—追踪结果中将包含可遍历性障碍要素。 这是默认设置。
- EXCLUDE_BARRIERS—追踪结果中将不包含可遍历性障碍要素。
| Boolean |
condition_barriers [[Name, Operator, Type, Value, Combine Using],...] (可选) | 基于与网络属性的比较或对类别字符串的检查，对要素设置可遍历性障碍条件。 条件障碍根据网络属性或类别、操作符、类型及属性值来定义。 例如，当要素的 Device Status 属性等于 Open 的特定值时，将停止追踪。 当要素满足此条件时，追踪将停止。 如果您要使用多个属性，可使用组合方法参数来定义 And 或 Or 条件。
条件障碍组件如下： - Name - 选择按系统中定义的任何网络属性进行过滤。
- Operator - 从大量不同的运算符中进行选择。
- Type - 从 name 参数指定的值中选择特定值或网络属性。
- Value - 提供会基于运算符值导致终止的输入属性类型的特定值。
- Combine Using - 如果要添加多个属性，则设置此值。您可以使用 And 或 Or 条件来对它们进行组合。
条件障碍 operator 值选项如下： - IS_EQUAL_TO—属性与值相等。
- DOES_NOT_EQUAL—属性与值不相等。
- IS_GREATER_THAN—属性大于值。
- IS_GREATER_THAN_OR_EQUAL_TO—属性大于或等于值。
- IS_LESS_THAN—属性小于值。
- IS_LESS_THAN_OR_EQUAL_TO—属性小于或等于值。
- INCLUDES_THE_VALUES—值中的所有位都存在于属性中的“按位与”运算（按位与 == 值）。
- DOES_NOT_INCLUDE_THE_VALUES—并非值中的所有位都存在于属性中的“按位与”运算（按位与 != 值）。
- INCLUDES_ANY—值中至少有一位存在于属性中的“按位与”运算（按位与 == True）。
- DOES_NOT_INCLUDE_ANY—值中的所有位均未存在于属性中的“按位与”运算（按位与 == False）。
了解有关按位运算符的详细信息 条件障碍 Type 值选项如下： - SPECIFIC_VALUE—按特定值过滤。
- NETWORK_ATTRIBUTE—按网络属性过滤。
条件障碍 Combine Using 值选项如下： - AND—合并条件障碍。
- OR—满足任一条件障碍时使用。
| Value Table |
function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (可选) | 基于函数对要素设置可遍历性障碍。 函数障碍可用于执行以下操作：限制追踪距离起点的行程或设置停止追踪的最大值。 例如，所经过的每条线的长度和为目前经过的总距离。 当经过的总长度达到指定值时，追踪将停止。 函数障碍组件如下： - Function - 从大量不同的计算函数中进行选择。
- Attribute - 选择按系统中定义的任何网络属性进行过滤。
- Operator - 从大量不同的运算符中进行选择。
- Value - 提供将导致终止的输入属性类型（若发现）的特定值。
- Use Local Values - 计算每个方向的值，而不是整体全局值。 例如计算形状长度总和的函数障碍，其中，如果值大于或等于 4，则追踪终止。 在全局情况下，遍历两条值为 2 的边之后，形状长度总和将达到 4，因此追踪会停止。 如果使用本地值，每条路径上的本地值会变化，且追踪将继续。
函数障碍 Function 值选项如下： - AVERAGE—将使用输入值的平均值。
- COUNT—将使用要素数。
- MAX—将使用输入值的最大值。
- MIN—将使用输入值的最小值。
- ADD—将使用值的总和。
- SUBTRACT—将使用各值之间的差值。 子网控制器和循环追踪类型不支持减函数。
函数障碍 Operator 值选项如下： - IS_EQUAL_TO—属性与值相等。
- DOES_NOT_EQUAL—属性与值不相等。
- IS_GREATER_THAN—属性大于值。
- IS_GREATER_THAN_OR_EQUAL_TO—属性大于或等于值。
- IS_LESS_THAN—属性小于值。
- IS_LESS_THAN_OR_EQUAL_TO—属性小于或等于值。
- INCLUDES_THE_VALUES—值中的所有位都存在于属性中的“按位与”运算（按位与 == 值）。
- DOES_NOT_INCLUDE_THE_VALUES—并非值中的所有位都存在于属性中的“按位与”运算（按位与 != 值）。
- INCLUDES_ANY—值中至少有一位存在于属性中的“按位与”运算（按位与 == True）。
- DOES_NOT_INCLUDE_ANY—值中的所有位均未存在于属性中的“按位与”运算（按位与 == False）。
了解有关按位运算符的详细信息 函数障碍 Use Local Values 选项如下： - TRUE—将使用局部值。
- FALSE—将使用全局值。 这是默认设置。
| Value Table |
traversability_scope (可选) | 将应用的可遍历性类型。 可遍历性范围用于确定是否在交汇点和/或边处应用可遍历性。 例如，如果定义了用于停止追踪的条件障碍，其中 Device Status 等于 Open 并将遍历范围仅设置为边，则即使追踪遇到开路设备，追踪也不会停止，因为 Device Status 仅适用于交汇点。 换言之，此参数会向追踪指出是否要忽略交汇点、边或这两者。 - BOTH_JUNCTIONS_AND_EDGES—可遍历性将同时应用于交汇点和边。 这是默认设置。
- JUNCTIONS_ONLY—可遍历性将仅应用于交汇点。
- EDGES_ONLY—可遍历性将仅应用于边。
| String |
filter_barriers [[Name, Operator, Type, Value, Combine Using],...] (可选) | 用于指定针对特定类别或网络属性的追踪停止时间。 例如，针对生命周期状态属性等于特定值的要素，追踪停止。 此参数用于根据系统中定义的网络属性值设置终止符。 如果要使用多个属性，可使用 Combine Using 选项来定义 And 或 Or 条件。
过滤器障碍组件如下： - Name - 按类别或系统中定义的任何网络属性进行过滤。
- Operator - 从大量不同的运算符中进行选择。
- Type - 从 name 参数指定的值中选择特定值或网络属性。
- Value - 提供会基于运算符值导致终止的输入属性类型的特定值。
- Combine Using - 如果要添加多个属性，则设置此值。您可以使用 And 或 Or 条件来对它们进行组合。
过滤器障碍 Operator 值选项如下： - IS_EQUAL_TO—属性与值相等。
- DOES_NOT_EQUAL—属性与值不相等。
- IS_GREATER_THAN—属性大于值。
- IS_GREATER_THAN_OR_EQUAL_TO—属性大于或等于值。
- IS_LESS_THAN—属性小于值。
- IS_LESS_THAN_OR_EQUAL_TO—属性小于或等于值。
- INCLUDES_THE_VALUES—值中的所有位都存在于属性中的“按位与”运算（按位与 == 值）。
- DOES_NOT_INCLUDE_THE_VALUES—并非值中的所有位都存在于属性中的“按位与”运算（按位与 != 值）。
- INCLUDES_ANY—值中至少有一位存在于属性中的“按位与”运算（按位与 == True）。
- DOES_NOT_INLCUDE_ANY—值中的所有位均未存在于属性中的“按位与”运算（按位与 == False）。
了解有关按位运算符的详细信息 过滤器障碍 Type 值选项如下： - SPECIFIC_VALUE—按特定值过滤。
- NETWORK_ATTRIBUTE—按网络属性过滤。
过滤器障碍 Combine Using 值选项如下： - AND—合并条件障碍。
- OR—满足任一条件障碍时使用。
| Value Table |
filter_function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (可选) | 用于过滤特定类别的追踪结果。 过滤器函数障碍组件如下： - Function - 从大量不同的计算函数中进行选择。
- Attribute - 选择按系统中定义的任何网络属性进行过滤。
- Operator - 从大量不同的运算符中进行选择。
- Value - 提供将导致终止的输入属性类型（若发现）的特定值。
- Use Local Values - 计算每个方向的值，而不是整体全局值。 例如计算形状长度总和的函数障碍，其中，如果值大于或等于 4，则追踪终止。 在全局情况下，遍历两条值为 2 的边之后，形状长度总和将达到 4，因此追踪会停止。 如果使用本地值，每条路径上的本地值会变化，否则追踪将继续。
过滤器函数障碍 Function 值选项如下： - AVERAGE—将使用输入值的平均值。
- COUNT—将使用要素数。
- MAX—将使用输入值的最大值。
- MIN—将使用输入值的最小值。
- ADD—将使用值的总和。
- SUBTRACT—将使用各值之间的差值。 子网控制器和循环追踪类型不支持减函数。
过滤器函数障碍 Operator 值选项如下： - IS_EQUAL_TO—属性与值相等。
- DOES_NOT_EQUAL—属性与值不相等。
- IS_GREATER_THAN—属性大于值。
- IS_GREATER_THAN_OR_EQUAL_TO—属性大于或等于值。
- IS_LESS_THAN—属性小于值。
- IS_LESS_THAN_OR_EQUAL_TO—属性小于或等于值。
- INCLUDES_THE_VALUES—值中的所有位都存在于属性中的“按位与”运算（按位与 == 值）。
- DOES_NOT_INCLUDE_THE_VALUES—并非值中的所有位都存在于属性中的“按位与”运算（按位与 != 值）。
- INCLUDES_ANY—值中至少有一位存在于属性中的“按位与”运算（按位与 == True）。
- DOES_NOT_INCLUDE_ANY—值中的所有位均未存在于属性中的“按位与”运算（按位与 == False）。
了解有关按位运算符的详细信息 过滤器函数障碍 Use Local Values 选项如下： - TRUE—将使用局部值。
- FALSE—将使用全局值。 这是默认设置。
| Value Table |
filter_scope (可选) | 指定是否在交汇点、边或这两处应用特定类别的过滤器。 例如，如果定义了用于停止追踪的过滤器障碍，其中 Device Status 等于 Open 并将遍历范围仅设置为边，则即使追踪遇到开路设备，追踪也不会停止，因为 Device Status 仅适用于交汇点。 换言之，此参数会向追踪指出是否要忽略交汇点、边或这两者。 - BOTH_JUNCTIONS_AND_EDGES—过滤器将同时应用于交汇点和边。 这是默认设置。
- JUNCTIONS_ONLY—过滤器将仅应用于交汇点。
- EDGES_ONLY—过滤器将仅应用于边。
| String |
filter_bitset_network_attribute_name (可选) | 将用于按 bitset 过滤的网络属性的名称。 此参数仅适用于上溯、下溯和循环追踪类型。 此参数可用于在追踪过程中添加特殊逻辑，以便追踪能够更好地反映真实世界的场景。 例如，对于循环追踪而言，Phases current 网络属性可以确定该循环是否为实际的电气循环（相同的相在循环 A 中各处均有电流通过），并且追踪结果只返回实际的电气循环。 上溯追踪的示例如下；如果追踪配电网络时指定 Phases current 网络属性，则追踪结果将只包含在网络属性中指定的有效路径，而不是所有路径。 | String |
filter_nearest (可选) | 指定是否使用 k-最近邻算法在给定距离内返回一些特定类型的要素。 可以提供计数、成本以及类别和/或资产类型的集合。 - FILTER_BY_NEAREST—将使用 k-最近邻算法来返回 nearest_count、nearest_cost_network_attribute、nearest_categories 或 nearest_assets 参数中指定的一定数量的要素。
- DO_NOT_FILTER—k 最近邻算法不会用于过滤结果。 这是默认设置。
| Boolean |
nearest_count (可选) | 当 filter_nearest 设置为 FILTER_BY_NEAREST 时，要返回的要素数量。 | Long |
nearest_cost_network_attribute (可选) | 当 filter_nearest 设置为 FILTER_BY_NEAREST 时，将用于计算接近度、成本或距离的数字网络属性，例如形状长度。 | String |
nearest_categories [nearest_categories,...] (可选) | 当 filter_nearest 设置为 FILTER_BY_NEAREST 时，将返回的类别，例如保护类别。 | String |
nearest_assets [nearest_assets,...] (可选) | 当 filter_nearest 设置为 FILTER_BY_NEAREST 时，将返回的资产组和资产类型，例如，ElectricDistributionDevice/Transformer/Step Down。 | String |
propagators [[Attribute, Substitution Attribute, Function, Operator, Value],...] (可选) | 指定要传播的网络属性以及传播将在追踪过程中的发生方式。 传播的类属性表示子网控制器上已传播至子网余下要素的关键值。 例如，在配电模型中，您可传播相位值。 传播程序组件如下： - Attribute - 选择按系统中定义的任何网络属性进行过滤。
- Substitution Attribute - 使用替换值而不是 bitset 网络属性值。 替换是基于正在传递的网络属性中的位数进行编码的。 替换是指同相位的某个位到另一个位的映射。 例如对于相 AC 而言，可通过一个替换将位 A 映射到 B，将位 C 映射到 null。 在该示例中，1010（相 AC）的替换是 0000-0010-0000-0000 (512)。 该替换将捕捉映射，以通知您相 A 被映射到 B，且相 C 被映射到 null 而非相反（即相 A 未映射到 null，且相 C 未映射到 B）。
- Function - 从大量计算函数中进行选择。
- Operator - 从大量运算符中进行选择。
- Value - 提供会基于运算符值导致终止的输入属性类型的特定值。
传播程序 Function 值选项如下： - PROPAGATED_BITWISE_AND—依次比较要素的值。
- PROPAGATED_MIN—将传播最小值。
- PROPAGATED_MAX—将传播最大值。
传播程序 Operator 值选项如下： - IS_EQUAL_TO—属性与值相等。
- DOES_NOT_EQUAL—属性与值不相等。
- IS_GREATER_THAN—属性大于值。
- IS_GREATER_THAN_OR_EQUAL_TO—属性大于或等于值。
- IS_LESS_THAN—属性小于值。
- IS_LESS_THAN_OR_EQUAL_TO—属性小于或等于值。
- INCLUDES_THE_VALUES—值中的所有位都存在于属性中的“按位与”运算（按位与 == 值）。
- DOES_NOT_INCLUDE_THE_VALUES—并非值中的所有位都存在于属性中的“按位与”运算（按位与 != 值）。
- INCLUDES_ANY—值中至少有一位存在于属性中的“按位与”运算（按位与 == True）。
- DOES_NOT_INCLUDE_ANY—值中的所有位均未存在于属性中的“按位与”运算（按位与 == False）。
了解有关按位运算符的详细信息 | Value Table |
description (可选) | 规则的描述。 | String |
allow_indeterminate_flow (可选) | 指定是否将追踪具有不确定或未初始化流向的追踪网络要素。 此参数仅在运行上游追踪或下游追踪类型时使用。 - TRACE_INDETERMINATE_FLOW—将包含追踪中具有不确定流向或未初始化流向的追踪网络要素。
- IGNORE_INDETERMINATE_FLOW—不包含具有不确定流向或未初始化流向的追踪网络要素。 这是默认设置。
| Boolean |
path_direction (可选) | 指定追踪网络的路径的方向。 遍历路径的成本取决于 path_network_weight_name 参数值。 此参数仅在运行 SHORTEST_PATH 追踪类型时使用。 - NO_DIRECTION—路径位于两个起点之间，无论流向如何。 这是默认设置。
- PATH_UPSTREAM—路径方向将是两个起点之间的下游方向。
- PATH_DOWNSTREAM—路径方向将是两个起点之间的上游方向。
| String |
path_network_weight_name (可选) | 将用于计算公共设施网络或追踪网络路径的网络属性。 运行最短路径追踪类型时，使用数字网络属性（例如形状长度）计算最短路径。 基于成本和距离的路径都可以进行计算。 运行最短路径追踪时，需要此参数。 | String |
use_trace_config (可选) | 指定是否将使用现有指定追踪配置来定义追踪的属性。 此参数仅适用于 Utility Network 版本 7 及更高版本。 - USE_TRACE_CONFIGURATION—将使用现有指定追踪配置来定义追踪的属性。
- DO_NOT_USE_TRACE_CONFIGURATION—不使用现有指定追踪配置来定义追踪的属性。 这是默认设置。
| Boolean |
trace_config_name (可选) | 将用于定义追踪属性的现有指定追踪配置的名称。 仅当 use_trace_config 参数设置为 USE_TRACE_CONFIGURATION 时，此参数才会启用。 | String |
use_digitized_direction (可选) | 指定上游和下游跟踪操作是否将使用线的数字化方向和 Flow direction 属性来确定流量。 当 trace_type 参数设置为 UPSTREAM 或 DOWNSTREAM 选项时，此参数仅适用于 Utility Network 版本 7 及更高版本。 - USE_DIGITIZED_DIRECTION—追踪操作将使用线路的数字化方向和流向属性来确定流向。 使用此选项，domain_network、tier 和 target_tier 参数将被忽略。
- IGNORE_DIGITIZED_DIRECTION—跟踪操作将根据子网控制器的位置确定流向。 这是默认设置。
使用企业级地理数据库时，此参数需要 ArcGIS Enterprise 11.3 或更高版本。 | Boolean |
，直至对其进行更新为止。