in_utility_network | Инженерная сеть или сеть трассировки, в которой находится изменяемый шаблон схемы. | Utility Network; Trace Network |
template_name | Имя изменяемого шаблона схемы. | String |
is_active | Указывает, будет ли правило включено при создании и обновлении схем на основе указанного шаблона: - ACTIVE—Добавляемое правило будет включено во время создания и обновления любых схем на основе входного шаблона. Это значение по умолчанию.
- INACTIVE—Добавляемое правило не будет включено во время создания и обновления любых схем на основе входного шаблона.
| Boolean |
trace_type | Определяет тип трассировки, выполняемой правилом для построения содержания схемы. - CONNECTED— Соединенная трассировка выполняется из элементов инженерной сети или сети трассировки, в данный момент представленных в схеме, когда правило запускается и распространяется вдоль соединенных объектов. Это значение по умолчанию.
- SUBNETWORK— Трассировка подсети выполняется из сетевых объектов, в данный момент представленных в схеме, когда правило запускается и распространяется вдоль соединенных объектов для поиска источников или приемников, из которых она распространяется дальше, вдоль связанной подсети.
- UPSTREAM—Трассировка вверх по течению выполняется из элементов инженерной сети или сети трассировки, в данный момент представленных в схеме, когда правило запускается для обнаружения объектов вверх по течению.
- DOWNSTREAM—Трассировка вниз по течению выполняется из элементов инженерной сети или сети трассировки, в данный момент представленных в схеме, когда правило запускается для обнаружения объектов вниз по течению.
- SHORTEST_PATH— Трассировка кратчайшего пути выполняется из объектов сети трассировки, в данный момент указанных на схеме как начальные точки, когда правило начинает исследовать объекты вдоль кратчайшего пути между этими начальными точками. Стоимость прохождения пути определяется на основе сетевого атрибута, заданного для значения параметра
shortest_path_network_attribute_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. Если объект удовлетворяет этому условию, трассировка остановится. При использовании более одного атрибута, можно применить параметр Комбинировать использование, чтобы задать условие И или Или. Применяются следующие компоненты барьера условий: - Name – фильтрация по любому из атрибутов сети, определенному в системе.
- Operator – выбрать среди различных операторов.
- Type – выбрать определенное значение или сетевой атрибут значения, которое задано в параметре name.
- Value – задать определенное значение для типа входного атрибута, которое может вызвать прерывание на основании значения оператора.
- Combine Using – укажите это значение, если собираетесь добавить несколько атрибутов. Их можно скомбинировать, используя условие И или Или.
Варианты значений барьеров условий 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—Побитовый оператор AND, где все биты в значении представлены в атрибуте (bitwise AND == value).
- DOES_NOT_INCLUDE_THE_VALUES—Побитовый оператор AND, где не все биты в значении представлены в атрибуте (bitwise AND != value).
- INCLUDES_ANY—Побитовый оператор AND, где как минимум один бит в значении представлен в атрибуте (bitwise AND == True).
- DOES_NOT_INCLUDE_ANY—Побитовый оператор AND, где ни один из битов в значении не представлен в атрибуте (bitwise AND == value).
Более подробно о побитовых операторах Варианты значений барьеров условий 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—Cумма значений.
- 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—Побитовый оператор AND, где все биты в значении представлены в атрибуте (bitwise AND == value).
- DOES_NOT_INCLUDE_THE_VALUES—Побитовый оператор AND, где не все биты в значении представлены в атрибуте (bitwise AND != value).
- INCLUDES_ANY—Побитовый оператор AND, где как минимум один бит в значении представлен в атрибуте (bitwise AND == True).
- DOES_NOT_INCLUDE_ANY—Побитовый оператор AND, где ни один из битов в значении не представлен в атрибуте (bitwise AND == value).
Более подробно о побитовых операторах Опции барьера функции Use Local Values: - TRUE—Использовать локальные значения.
- FALSE—Использовать глобальные значения. Это значение по умолчанию.
| Value Table |
traversability_scope (Дополнительный) | Тип проходимости для применения. Область проходимости определяет, будут ли применены настройки проходимости для соединений, ребер или для обоих. Например, если барьер условия определен на остановку трассировки, если Статус устройства равен значению Открыто и область действия проходимости задана только для ребер, то даже в случае, если трассировка встретит открытое устройство, она не будет остановлена, поскольку Статус устройства применим только к соединениям. Другими словами, параметр показывает, что трассировка должна игнорировать ребра, соединения, или и то и другое. - BOTH_JUNCTIONS_AND_EDGES—Применить проходимость к соединениям и ребрам. Это значение по умолчанию.
- JUNCTIONS_ONLY—Применить проходимость только к соединениям.
- EDGES_ONLY—Применить проходимость только к ребрам.
| String |
filter_barriers [[Name, Operator, Type, Value, Combine Using],...] (Дополнительный) | Определяет, когда должна быть прекращена трассировка для определенной категории или атрибута сети. Например, остановить трассировку на объектах, имеющих атрибут статуса жизненного цикла, равный заданному значению. Этот параметр используется для задания ограничителя на основе значения атрибута сети, определенного в системе. Если используется более одного атрибута, можно использовать опцию Combine Using, чтобы задать условие И или Или. Компоненты барьеров фильтра следующие: - Name – выбрать фильтр по любому сетевому атрибуту, заданному в системе.
- Operator – выбрать среди различных операторов.
- Type – выбрать определенное значение или сетевой атрибут значения, которое задано в параметре name.
- Value – укажите определенное значение типа входного атрибута, которое может вызвать прекращение трассировки на основании значения оператора.
- Combine Using – укажите это значение, если собираетесь добавить несколько атрибутов. Можно выбрать их комбинирование при помощи условия И или Или.
Варианты значений барьеров фильтра 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—Побитовый оператор AND, где все биты в значении представлены в атрибуте (bitwise AND == value).
- DOES NOT INCLUDE_THE_VALUES—Побитовый оператор AND, где не все биты в значении представлены в атрибуте (bitwise AND != value).
- INCLUDES_ANY—Побитовый оператор AND, где как минимум один бит в значении представлен в атрибуте (bitwise AND == True).
- DOES_NOT_INLCUDE_ANY—Побитовый оператор AND, где ни один из битов в значении не представлен в атрибуте (bitwise AND == value).
Более подробно о побитовых операторах Варианты значений барьеров фильтра 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—Cумма значений.
- 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—Побитовый оператор AND, где все биты в значении представлены в атрибуте (bitwise AND == value).
- DOES_NOT_INCLUDE_THE_VALUES—Побитовый оператор AND, где не все биты в значении представлены в атрибуте (bitwise AND != value).
- INCLUDES_ANY—Побитовый оператор AND, где как минимум один бит в значении представлен в атрибуте (bitwise AND == True).
- DOES_NOT_INCLUDE_ANY—Побитовый оператор AND, где ни один из битов в значении не представлен в атрибуте (bitwise AND == value).
Более подробно о побитовых операторах Варианты значений Use Local Values барьеров функции фильтр следующие: - TRUE—Использовать локальные значения.
- FALSE—Использовать глобальные значения. Это значение по умолчанию.
| Value Table |
filter_scope (Дополнительный) | Определяет, будет ли фильтр для определенной категории применяться к соединениям, ребрам или ко всем. Например, если фильтр барьера задан для остановки трассировки, если Состояние устройства - Открыто, а для области проходимости задано «только ребра», трассировка не остановится, даже если обнаружит открытое устройство, так как Статус устройства применим только к соединениям. Другими словами, этот параметр указывает трассировке, следует ли игнорировать ребра, соединения, или и то и другое. - BOTH_JUNCTIONS_AND_EDGES—Фильтр будут применен как к соединениям, так и к ребрам. Это значение по умолчанию
- JUNCTIONS_ONLY—Фильтр будет применен только к соединениям.
- EDGES_ONLY—Фильтр будет применен только к ребрам.
| String |
filter_bitset_network_attribute_name (Дополнительный) | Имя атрибута сети, который может быть использован для фильтрации по битовому множеству. Этот параметр применяется только для трассировки типа вверх против течения, вниз по течению и петли. Этот параметр может быть использован для добавления специальной логики во время трассировки, чтобы трассировка могла полнее отражать сценарии реального мира. Например, при трассировке петель атрибут сети Текущие фазы может определить, является ли петля истинной электрической петлей (та же фаза проходит вдоль всей петли, то есть А) и возвратить для результатов трассировки только реальные электрические петли. Пример трассировки вверх против течения: при трассировке сети электрического распределения, указав атрибут сети Текущие фазы, вы получите в качестве результатов трассировки только корректные пути, которые указаны в атрибуте сети, а не все пути. | 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, например, Protective. | 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 – использовать заменяющее значение вместо битового множества атрибутов сети. Замены являются кодированными на основании числа битов в передаваемом сетевом атрибуте. Замена - это сопоставление каждого бита по фазе другого бита. Например, для Фазы 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—Побитовый оператор AND, где все биты в значении представлены в атрибуте (bitwise AND == value).
- DOES_NOT_INCLUDE_THE_VALUES—Побитовый оператор AND, где не все биты в значении представлены в атрибуте (bitwise AND != value).
- INCLUDES_ANY—Побитовый оператор AND, где как минимум один бит в значении представлен в атрибуте (bitwise AND == True).
- DOES_NOT_INCLUDE_ANY—Побитовый оператор AND, где ни один из битов в значении не представлен в атрибуте (bitwise AND == value).
Более подробно о побитовых операторах Этот параметр доступен только в Python. | Value Table |
description (Дополнительный) | Описание правила. | String |
allow_indeterminate_flow (Дополнительный) | Определяет, будет ли выполняться трассировка объектов с неопределенным или неинициализированным потоком. Этот параметр используется только при запуске трассировки вверх или вниз по течению. - TRACE_INDETERMINATE_FLOW—Включать в трассировку объекты с неопределенным или неинициализированным направлением потока.
- IGNORE_INDETERMINATE_FLOW—Не выполнять трассировку объектов с неопределенным или неинициализированным направлением потока. Это значение по умолчанию.
| Boolean |
path_direction (Дополнительный) | Определяет направление пути в сети трассировки. Стоимость прохождения пути определяется на основе значения, заданного для path_network_attribute_name. Этот параметр используется только при запуске трассировки типа PATH. - NO_DIRECTION—Поиск пути между двумя начальными точками выполняется независимо от направления потока. Это значение по умолчанию.
- PATH_UPSTREAM—Определяет путь вниз по течению между двумя начальными точками.
- PATH_DOWNSTREAM—Определяет путь вверх по течению между двумя начальными точками.
| String |
path_network_weight_name (Дополнительный) | Атрибут сети, используемый для вычисления кратчайшего пути в сети трассировки. При запуске трассировки типа кратчайший путь, кратчайший путь вычисляется с помощью числового атрибута сети, такого как Длина объекта. Могут быть вычислены пути как на основе стоимости, так и на основе расстояния. Этот параметр является обязательным при запуске трассировки кратчайшего пути. | String |
до момента обновления.