Nombre | Explicación | Tipo de datos |
in_utility_network | La red de servicios o red de trazado que contiene la plantilla de diagrama que se modificará. | Utility Network; Trace Network |
template_name | El nombre de la plantilla de diagrama que se modificará. | String |
is_active | Especifica si la regla estará habilitada al generar y actualizar diagramas basándose en la plantilla especificada. - ACTIVE—La regla agregada se habilitará durante la generación y la actualización de cualquier diagrama basado en la plantilla de entrada. Esta es la opción predeterminada.
- INACTIVE—La regla agregada no estará habilitada durante la generación ni la actualización de cualquier diagrama basado en la plantilla de entrada.
| Boolean |
trace_type | Especifica el tipo de trazado que la regla realizará para generar el contenido del diagrama. - CONNECTED—Un trazado conectado se ejecutará desde los elementos de la red de servicios o red de trazado representados actualmente en el diagrama al iniciar la regla y se expande hacia fuera a lo largo de los elementos conectados. Esta es la opción predeterminada.
- SUBNETWORK—Un trazado de subred se ejecutará desde los elementos de la red de servicios representados actualmente en el diagrama al iniciar la regla y se expande hacia fuera a lo largo de los elementos conectados, para encontrar orígenes o sumideros desde los cuales expandirse hacia fuera a lo largo de la subred relacionada.
- UPSTREAM—Un trazado aguas arriba se ejecutará desde los elementos de la red de servicios o red de trazado representados actualmente en el diagrama cuando la regla comienza a descubrir elementos aguas arriba.
- DOWNSTREAM—Un trazado aguas abajo se ejecutará desde los elementos de la red de servicios o red de trazado representados actualmente en el diagrama cuando la regla comienza a descubrir elementos aguas abajo.
- SHORTEST_PATH—Un trazado de ruta más corta se ejecutará desde la red de servicios o las entidades de red de trazado especificadas actualmente como puntos de partida en el diagrama cuando la regla empieza a descubrir las entidades presentes a lo largo de la ruta más corta entre estos dos puntos de partida. El coste de recorrer la ruta se determina en función del atributo de red definido para el valor del parámetro path_network_weight_name independientemente de la dirección del flujo.
| String |
domain_network (Opcional) | El nombre de la red de dominio en la que se ejecuta el trazado para una red de servicios. Este parámetro es obligatorio para ejecutar los tipos de trazado de subred, aguas arriba y aguas abajo. | String |
tier (Opcional) | El nombre del nivel en el que empezará el trazado para una red de servicios. Este parámetro es opcional al ejecutar el tipo de trazado conectado; es obligatorio para ejecutar los tipos de trazado de subred, aguas arriba y aguas abajo. | String |
target_tier (Opcional) | El nombre del nivel de destino hacia el que fluirá el nivel de entrada para una red de servicios. Si este parámetro está presente en los trazados aguas arriba y aguas abajo, estos rastreos se detienen tan pronto como alcanzan el límite de la subred de partida. Este parámetro puede usarse para permitir que estos trazados continúen, ya sea más arriba o más abajo en la jerarquía. | String |
include_structures (Opcional) | Especifica si las entidades de estructura y objetos se incluirán en los resultados del trazado. - INCLUDE_STRUCTURES—Las entidades de estructura y objetos se incluirán en los resultados del trazado.
- EXCLUDE_STRUCTURES—Las entidades de estructura y objetos no se incluirán en los resultados del trazado. Esta es la opción predeterminada.
| Boolean |
include_barriers (Opcional) | Especifica si las entidades de barrera de transitabilidad se incluirán en los resultados del trazado. Las barreras de transitabilidad son opcionales incluso si se han predefinido en la definición de subred. Este parámetro no se aplica a las entidades del dispositivo con terminales. - INCLUDE_BARRIERS—Las entidades de barrera de transitabilidad se incluirán en los resultados del trazado. Esta es la opción predeterminada.
- EXCLUDE_BARRIERS—Las entidades de barrera de transitabilidad no se incluirán en los resultados del trazado.
| Boolean |
condition_barriers [[Name, Operator, Type, Value, Combine Using],...] (Opcional) | Define una condición de barrera de transitabilidad en entidades basadas en una comparación con un atributo de red o busque una cadena de categoría. Una condición de barrera utiliza un atributo de red, un operador y un tipo, y un valor de atributo. Por ejemplo, el trazado se detiene cuando una entidad tiene el atributo Device Status igual que el valor específico de Open. Cuando una entidad cumple esta condición, el seguimiento se detiene. Si está utilizando más de un atributo, puede usar el parámetro Combinar usando para definir una condición Y u O.
Los componentes de condición de barrera son los siguientes: - Name: filtre por cualquier atributo de red definido en el sistema.
- Operator: elija entre una variedad de operadores diferentes.
- Type: elija un valor o un atributo de red específicos del valor que se especifica en el parámetro name.
- Value: proporcione un valor específico para un tipo de atributo de entrada que causaría la finalización en función de un valor del operador.
- Combine Using: defina este valor si tiene varios atributos que agregar. Puede combinarlos utilizando una condición Y u O.
Las opciones del valor operator de las condiciones de barrera son las siguientes: - IS_EQUAL_TO—El atributo es igual que el valor.
- DOES_NOT_EQUAL—El atributo no es igual que el valor.
- IS_GREATER_THAN—El atributo es mayor que el valor.
- IS_GREATER_THAN_OR_EQUAL_TO—El atributo es mayor o igual que el valor.
- IS_LESS_THAN—El atributo es menor que el valor.
- IS_LESS_THAN_OR_EQUAL_TO—El atributo es menor o igual que el valor.
- INCLUDES_THE_VALUES—Una operación bitwise AND en la que todos los bits del valor están presentes en el atributo (bitwise AND == valor).
- DOES_NOT_INCLUDE_THE_VALUES—Una operación bitwise AND en la que no todos los bits del valor están presentes en el atributo (bitwise AND != valor).
- INCLUDES_ANY—Una operación bitwise AND en la que al menos un bit del valor está presente en el atributo (bitwise AND == True).
- DOES_NOT_INCLUDE_ANY—Una operación bitwise AND en la que ninguno de los bits del valor está presente en el atributo (bitwise AND == False).
Más información sobre los operadores bitwise Las opciones del valor Type de las condiciones de barrera son las siguientes: - SPECIFIC_VALUE—Filtrar por un valor específico.
- NETWORK_ATTRIBUTE—Filtrar por un atributo de red.
Las opciones del valor Combine Using de las condiciones de barrera son las siguientes: - AND—Combinar las barreras de condición.
- OR—Usar si se cumple alguna de las barreras de condición.
| Value Table |
function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (Opcional) | Define una barrera de transitabilidad en entidades basadas en una función. Las barreras de función se pueden utilizar para hacer cosas como restringir cuánto se desplaza el trazado desde el punto de partida o definir un valor máximo en el que se detiene un trazado. Por ejemplo, la longitud de cada línea recorrida se suma a la distancia total recorrida hasta ese momento. Cuando la longitud total recorrida alcanza el valor especificado, el seguimiento se detiene. Los componentes de barrera de función son los siguientes: - Function: elija entre una variedad de funciones de cálculo diferentes.
- Attribute: filtre por cualquier atributo de red definido en el sistema.
- Operator: elija entre una variedad de operadores diferentes.
- Value: indique un valor específico para el tipo de atributo de entrada que, si se descubre, causará la finalización.
- Use Local Values: calcule valores en todas las direcciones, en lugar de un valor global general. Por ejemplo, una barrera de función que está calculando la suma de Shape length, en la que el trazado termina si el valor es mayor o igual que 4. En el caso global, después de hacer un trazado poligonal de dos ejes con un valor de 2, habrá alcanzado una longitud de forma cuya suma sea 4, de forma que el trazado finaliza. Si se utilizan valores locales, los valores locales a lo largo de cada ruta cambian y el trazado continúa.
Las opciones de valor de barrera de función de function son las siguientes: - AVERAGE—Se utilizará el promedio de los valores de entrada.
- COUNT—Se utilizará el número de entidades.
- MAX—Se utilizará el máximo de valores de entrada.
- MIN—Se utilizará el mínimo de valores de entrada.
- ADD—Se utilizará la suma de los valores.
- SUBTRACT—Se usará la diferencia entre los valores. Ni los controladores de subred ni los tipos de trazado en bucle admiten la función de resta.
Las opciones de valor de barrera de función de operator son las siguientes: - IS_EQUAL_TO—El atributo es igual que el valor.
- DOES_NOT_EQUAL—El atributo no es igual que el valor.
- IS_GREATER_THAN—El atributo es mayor que el valor.
- IS_GREATER_THAN_OR_EQUAL_TO—El atributo es mayor o igual que el valor.
- IS_LESS_THAN—El atributo es menor que el valor.
- IS_LESS_THAN_OR_EQUAL_TO—El atributo es menor o igual que el valor.
- INCLUDES_THE_VALUES—Una operación bitwise AND en la que todos los bits del valor están presentes en el atributo (bitwise AND == valor).
- DOES_NOT_INCLUDE_THE_VALUES—Una operación bitwise AND en la que no todos los bits del valor están presentes en el atributo (bitwise AND != valor).
- INCLUDES_ANY—Una operación bitwise AND en la que al menos un bit del valor está presente en el atributo (bitwise AND == True).
- DOES_NOT_INCLUDE_ANY—Una operación bitwise AND en la que ninguno de los bits del valor está presente en el atributo (bitwise AND == False).
Más información sobre los operadores bitwise Las opciones de barrera de función de Use Local Values son las siguientes: - TRUE—Se utilizarán valores locales.
- FALSE—Se utilizarán valores globales. Esta es la opción predeterminada.
| Value Table |
traversability_scope (Opcional) | El tipo de transitabilidad que se impondrá. El alcance de la traversabilidad dicta si esta se aplica en los cruces, los ejes o en ambos. Por ejemplo, si se define que una condición de barrera detenga el trazado si Estado de dispositivo equivale a Abierto y el alcance de transitabilidad se establece solo en los ejes, el trazado no se detendrá, aunque se encuentre con un dispositivo abierto, porque Estado de dispositivo solo se aplica a los cruces. Es decir, este parámetro indica al trazado si debe ignorar los cruces, ejes o ambos. - BOTH_JUNCTIONS_AND_EDGES—Se aplicará la transitabilidad tanto a los cruces como a los ejes. Esta es la opción predeterminada.
- JUNCTIONS_ONLY—Solo se aplicará la transitabilidad a los cruces.
- EDGES_ONLY—Solo se aplicará la transitabilidad a los ejes.
| String |
filter_barriers [[Name, Operator, Type, Value, Combine Using],...] (Opcional) | Especifica cuándo se detendrá un trazado con una categoría o un atributo de red específicos. Por ejemplo, el trazado se detiene en las entidades que presentan un atributo de estado de ciclo igual a un determinado valor. Este parámetro se utiliza para definir un terminador basado en un valor de un atributo de red que está definido en el sistema. Si se utiliza más de un atributo, puede usar la opción Combine Using para definir una condición Y u O.
Los componentes de barrera de filtro son los siguientes: - Name: filtre por categoría o cualquier atributo de red definido en el sistema.
- Operator: elija entre una variedad de operadores diferentes.
- Type: elija un valor o un atributo de red específicos del valor que se especifica en el parámetro name.
- Value: indique un valor específico de un tipo de atributo de entrada que causaría la finalización en función de un valor del operador.
- Combine Using: defina este valor si tiene varios atributos que agregar. Puede combinarlos utilizando una condición Y u O.
Las opciones de valor de barrera de filtro de operator son las siguientes: - IS_EQUAL_TO—El atributo es igual que el valor.
- DOES_NOT_EQUAL—El atributo no es igual que el valor.
- IS_GREATER_THAN—El atributo es mayor que el valor.
- IS_GREATER_THAN_OR_EQUAL_TO—El atributo es mayor o igual que el valor.
- IS_LESS_THAN—El atributo es menor que el valor.
- IS_LESS_THAN_OR_EQUAL_TO—El atributo es menor o igual que el valor.
- INCLUDES_THE_VALUES—Una operación bitwise AND en la que todos los bits del valor están presentes en el atributo (bitwise AND == valor).
- DOES NOT INCLUDE_THE_VALUES—Una operación bitwise AND en la que no todos los bits del valor están presentes en el atributo (bitwise AND != valor).
- INCLUDES_ANY—Una operación bitwise AND en la que al menos un bit del valor está presente en el atributo (bitwise AND == True).
- DOES_NOT_INLCUDE_ANY—Una operación bitwise AND en la que ninguno de los bits del valor está presente en el atributo (bitwise AND == False).
Más información sobre los operadores bitwise Las opciones de valor de barrera de filtro de Type son las siguientes: - SPECIFIC_VALUE—Filtrar por un valor específico.
- NETWORK_ATTRIBUTE—Filtrar por un atributo de red.
Las opciones de valor de barrera de filtro de Combine Using son las siguientes: - AND—Combinar las barreras de condición.
- OR—Usar si se cumple alguna de las barreras de condición.
| Value Table |
filter_function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (Opcional) | Filtra los resultados del rastreo para una categoría específica. Los componentes de barrera de función de filtro son los siguientes: - Function: elija entre una variedad de funciones de cálculo diferentes.
- Attribute: filtre por cualquier atributo de red definido en el sistema.
- Operator: elija entre una variedad de operadores diferentes.
- Value: indique un valor específico para el tipo de atributo de entrada que, si se descubre, causará la finalización.
- Use Local Values: calcule valores en todas las direcciones, en lugar de un valor global general. Por ejemplo, una barrera de función calcula la suma de la longitud de forma, en la que el trazado termina si el valor es mayor o igual que 4. En el caso global, después de hacer un trazado poligonal de dos ejes con un valor de 2, habrá alcanzado una longitud de forma cuya suma sea 4, de forma que el trazado finaliza. Si se utilizan valores locales, los valores locales a lo largo de cada ruta cambian, o bien el trazado continúa.
Las opciones de valor function de las funciones de barreras de filtro son las siguientes: - AVERAGE—Se utilizará el promedio de los valores de entrada.
- COUNT—Se utilizará el número de entidades.
- MAX—Se utilizará el máximo de valores de entrada.
- MIN—Se utilizará el mínimo de valores de entrada.
- ADD—Se utilizará la suma de los valores.
- SUBTRACT—Se usará la diferencia entre los valores. Ni los controladores de subred ni los tipos de trazado en bucle admiten la función de resta.
Las opciones de valor operator de las funciones de barreras de filtro son las siguientes: - IS_EQUAL_TO—El atributo es igual que el valor.
- DOES_NOT_EQUAL—El atributo no es igual que el valor.
- IS_GREATER_THAN—El atributo es mayor que el valor.
- IS_GREATER_THAN_OR_EQUAL_TO—El atributo es mayor o igual que el valor.
- IS_LESS_THAN—El atributo es menor que el valor.
- IS_LESS_THAN_OR_EQUAL_TO—El atributo es menor o igual que el valor.
- INCLUDES_THE_VALUES—Una operación bitwise AND en la que todos los bits del valor están presentes en el atributo (bitwise AND == valor).
- DOES_NOT_INCLUDE_THE_VALUES—Una operación bitwise AND en la que no todos los bits del valor están presentes en el atributo (bitwise AND != valor).
- INCLUDES_ANY—Una operación bitwise AND en la que al menos un bit del valor está presente en el atributo (bitwise AND == True).
- DOES_NOT_INCLUDE_ANY—Una operación bitwise AND en la que ninguno de los bits del valor está presente en el atributo (bitwise AND == False).
Más información sobre los operadores bitwise Las opciones Use Local Values de las funciones de barreras de filtro son las siguientes: - TRUE—Se utilizarán valores locales.
- FALSE—Se utilizarán valores globales. Esta es la opción predeterminada.
| Value Table |
filter_scope (Opcional) | Especifica si el filtro de una categoría específica se aplicará a los cruces, los ejes o ambos. Por ejemplo, si se define que una barrera de filtro detenga el trazado si Estado de dispositivo equivale a Abierto y el alcance de transitabilidad se establece solo en los ejes, el trazado no se detendrá aunque se encuentre con un dispositivo abierto porque Estado de dispositivo solo se aplica a los cruces. Es decir, este parámetro indica al trazado si debe ignorar los cruces, ejes o ambos. - BOTH_JUNCTIONS_AND_EDGES—Se aplicará el filtro tanto a los cruces como a los ejes. Esta es la opción predeterminada.
- JUNCTIONS_ONLY—Solo se aplicará el filtro a los cruces.
- EDGES_ONLY—Solo se aplicará el filtro a los ejes.
| String |
filter_bitset_network_attribute_name (Opcional) | El nombre del atributo de red que se usará para filtrar por conjunto de bits. Este parámetro solo es aplicable a los tipos de trazado de aguas arriba, aguas abajo y bucles. Este parámetro puede usarse para agregar una lógica especial durante un trazado, de modo que el trazado refleje más fielmente las situaciones reales. Por ejemplo, en un trazado de bucles, el atributo de red Fases actuales permite determinar si el bucle es un bucle eléctrico real (se alimenta la misma fase en todo el bucle, es decir, A) y devuelve solo los bucles eléctricos reales de los resultados del trazado de red. Un ejemplo de un trazado aguas arriba es que, durante el trazado de una red de distribución eléctrica, se especifica el atributo de red Fases actuales y el resultado del trazado solo contendrá las rutas válidas que se especifiquen en el atributo de red, no todas las rutas. | String |
filter_nearest (Opcional) | Especifica si el algoritmo k-vecinos más cercanos se usará para devolver un número de entidades de un tipo concreto dentro de una distancia determinada. Si se utiliza este parámetro, es posible especificar un recuento, un coste y una colección de categorías, además de un tipo de activos, o ambos. - FILTER_BY_NEAREST—El algoritmo k-vecinos más cercanos se utilizará para devolver el número de entidades especificado en el parámetro nearest_count, nearest_cost_network_attribute, nearest_categories o nearest_assets.
- DO_NOT_FILTER—No se utilizará el algoritmo k-vecinos más cercanos para filtrar resultados. Esta es la opción predeterminada.
| Boolean |
nearest_count (Opcional) | El número de entidades que se devolverán cuando filter_nearest sea FILTER_BY_NEAREST. | Long |
nearest_cost_network_attribute (Opcional) | El atributo de red numérico que se utilizará para calcular la cercanía, el coste o la distancia cuando filter_nearest sea FILTER_BY_NEAREST, por ejemplo, Shape length. | String |
nearest_categories [nearest_categories,...] (Opcional) | Las categorías que se devolverán cuando filter_nearest sea FILTER_BY_NEAREST, por ejemplo, Protective. | String |
nearest_assets [nearest_assets,...] (Opcional) | Los tipos y grupos de activos que se devolverán cuando filter_nearest sea FILTER_BY_NEAREST, por ejemplo, ElectricDistributionDevice/Transformer/Step Down. | String |
propagators [[Attribute, Substitution Attribute, Function, Operator, Value],...] (Opcional) | Especifica qué atributos de red propagar y cómo se producirá dicha propagación durante un seguimiento. Los atributos de clase propagados indican los valores clave en controladores de subred que se difunden al resto de las entidades de la subred. Por ejemplo, en un modelo de distribución eléctrica, puede propagar el valor de fase. Los componentes propagadores son los siguientes: - Attribute: filtre por cualquier atributo de red definido en el sistema.
- Substitution Attribute: utilice un valor sustituido en lugar de valores de atributo de red de conjunto de bits. Las sustituciones se codifican a partir del número de bits del atributo de red propagado. Una sustitución es una correlación de cada bit de la fase con otro bit. Por ejemplo, para la Fase AC, una sustitución podría correlacionar el bit A al B y el bit C a nulo. En este ejemplo, la sustitución para 1010 (Fase AC) es 0000-0010-0000-0000 (512). La sustitución captura la correlación de forma que usted sabe que la Fase A se correlacionó con B y la Fase C se correlacionó con nulo y no al contrario (es decir, no se correlacionó la Fase A a nulo ni se correlacionó la Fase C a B).
- Function: elija entre una variedad de funciones de cálculo.
- Operator: elija entre una variedad de operadores.
- Value: proporcione un valor específico para un tipo de atributo de entrada que causaría la finalización en función de un valor del operador.
Las opciones de valor de propagadores de function son las siguientes: - PROPAGATED_BITWISE_AND—Los valores se compararán entre una entidad y la siguiente.
- PROPAGATED_MIN—Se propagará el valor mínimo.
- PROPAGATED_MAX—Se propagará el valor máximo.
Las opciones de valor de propagadores de operator son las siguientes: - IS_EQUAL_TO—El atributo es igual que el valor.
- DOES_NOT_EQUAL—El atributo no es igual que el valor.
- IS_GREATER_THAN—El atributo es mayor que el valor.
- IS_GREATER_THAN_OR_EQUAL_TO—El atributo es mayor o igual que el valor.
- IS_LESS_THAN—El atributo es menor que el valor.
- IS_LESS_THAN_OR_EQUAL_TO—El atributo es menor o igual que el valor.
- INCLUDES_THE_VALUES—Una operación bitwise AND en la que todos los bits del valor están presentes en el atributo (bitwise AND == valor).
- DOES_NOT_INCLUDE_THE_VALUES—Una operación bitwise AND en la que no todos los bits del valor están presentes en el atributo (bitwise AND != valor).
- INCLUDES_ANY—Una operación bitwise AND en la que al menos un bit del valor está presente en el atributo (bitwise AND == True).
- DOES_NOT_INCLUDE_ANY—Una operación bitwise AND en la que ninguno de los bits del valor está presente en el atributo (bitwise AND == False).
Más información sobre los operadores bitwise Este parámetro está disponible solo a través de Python. | Value Table |
description (Opcional) | La descripción de la regla. | String |
allow_indeterminate_flow (Opcional) | Especifica si se realizará un trazado de las entidades de red de trazado que presentan un flujo indeterminado o no inicializado. Este parámetro solo se respeta al ejecutar un trazado de tipo aguas arriba o aguas abajo. - TRACE_INDETERMINATE_FLOW—Se incluirán en el trazado las entidades de la red de trazado que presentan una dirección de flujo indeterminada o no inicializada.
- IGNORE_INDETERMINATE_FLOW—No se incluirán en el trazado las entidades de red de trazado que presentan una dirección de flujo indeterminada o no inicializada. Esta es la opción predeterminada.
| Boolean |
path_direction (Opcional) | Especifica la dirección de la ruta de una red de trazado. El coste de recorrer la ruta se determina en función del valor del parámetro path_network_weight_name. Este parámetro solo se respeta al ejecutar un trazado de tipo SHORTEST_PATH. - NO_DIRECTION—Se usará la ruta entre los dos puntos de partida, independientemente de la dirección del flujo. Esta es la opción predeterminada.
- PATH_UPSTREAM—La dirección de la ruta será aguas abajo entre los dos puntos de partida.
- PATH_DOWNSTREAM—La dirección de la ruta será aguas arriba entre los dos puntos de partida.
| String |
path_network_weight_name (Opcional) | El atributo de red que se utilizará para calcular la ruta de una red de servicios o red de trazado. Al ejecutar el tipo de trazado de ruta más corta, la ruta más corta se calcula utilizando un atributo de red, por ejemplo, la longitud de forma. Es posible conseguir rutas basadas tanto en el coste como en la distancia. Este parámetro es obligatorio si se ejecuta un trazado de ruta más corta. | String |