Глобальные функции
Описание и характеристика глобальных функций модуля Автоматизации, которые можно использовать при разработке сценариев.
Общие функции фильтрации
FilterByStreamId
Тип функции: Impure
Описание: Функция позволяет осуществлять фильтрацию принимаемого объекта по полю
idструктуры_stream.Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Stream Struct: StreamInLogEvent Принимает на вход структуру StreamInLogEvent Связь StreamId integer64 Идентификатор потока monq Связь/контрол Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна, если фильтрация успешна Связь Failed Exec Последовательность активна, если фильтрация неуспешна Связь
FilterStruct
Тип функции: Impure
Описание: Функция позволяет настроить фильтрацию по визуально сконструированному условию в инспекторе объектов.
Ограничения:
Не поддерживается фильтрация структур с типом
DateTimeOffsetНе поддерживается фильтрация среди массивов
DynamicInputs
Название Тип Описание Параметры In Exec Пин вызова Связь Struct Wildcard:Struct Принимает на вход любую структуру Связь Query String Фильтруемое значение Связь/контрол Outputs
Название Тип Описание Параметры True Exec Последовательность активна, если фильтрация успешна Связь False Exec Последовательность активна, если фильтрация неуспешна Связь
HTTP Функции
AutomatonHTTPRequest
Тип функции: Impure
Описание:
Функция позволяет сформировать http-запрос для обращения к публичному API любой системы.
Для формирования запроса, необходимо указать:
адрес API
Если Uri не начинается с
http://или сhttps://, то автоматически будет подставленBaseUriиз переменнойScenarioдля удобства работы с API Monq.метод запроса
тело запроса
системную переменную
Scenarioсистемную переменную
BearerTokenДанный параметр можно не указывать, если планируется отправить запрос от лица
Automaton Bot(берется по умолчанию из переменнойScenario).Если указать - при запросе будет использован заданный пользователем
Bearer Token.Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Scenario Struct:ScenarioBase Передаются общие параметры сценария для выполнения функции Связь/контрол Url String Адрес API Связь/контрол Method String Тип (метод) запроса Связь/контрол Body Wildcard: Struct array/single Тело запроса Связь BearerToken String Токен пользователя. (Automaton bot token) Связь/контрол Outputs
Название Тип Описание Параметры Ok Exec Пин вызова функции, в случае успешного выполнения запроса Связь Failed Exec Пин вызова функции, в случае неудачного выполнения запроса Связь Result Wildcard: Struct array/single Результат запроса будет передан для исходящего пина Result, формат которого будет определен по установленной связи Wildcard Связь Response Wildcard: Struct single Результат запроса в сыром виде с дополнительной служебной информацией Связь
HTTPRequest
Тип функции: Impure
Описание:
Расширенная версия функции AutomatonHTTPRequest. В функцию добавлена возможность указать:
Заголовки запроса
Параметры запроса
Кодировку
Тип данных
Таймаут запроса
Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Scenario Struct:ScenarioBase Передаются общие параметры сценария для выполнения функции Связь/контрол Url String Абсолютный путь к запрашиваемому ресурсу Связь/контрол Method String HTTP метод запроса Связь/контрол Content Wildcard: Struct array/single Тело запроса Связь MediaType String Тип данных. По умолчанию определяется в зависимости от типа пина ContentСвязь/контрол Encoding String Кодировка, которая используется при кодировании контента в запросе. По умолчанию UTF-8Связь/контрол Headers Struct:StringKeyValue Список заголовков запроса Связь ContentHeaders Struct:StringKeyValue Список заголовков для описания контента. Несет дополнительную информацию о типе контента Связь UrlParameters Struct:StringKeyValue Список параметров запроса Связь RequestTimeoutSeconds Integer Таймаут запроса в секундах. При указании 0, ставится значение по умолчанию в 60 секунд. Связь/контрол Outputs
Название Тип Описание Параметры Ok Exec Пин вызова функции, в случае успешного выполнения запроса Связь Failed Exec Пин вызова функции, в случае неудачного выполнения запроса Связь Result Wildcard: Struct array/single Результат запроса будет передан для исходящего пина Result, формат которого будет определен по установленной связи Wildcard Связь Response Struct:AutomatonResponse Результат запроса в сыром виде с дополнительной служебной информацией Связь
MonqHTTPRequest
Deprecated - AutomatonHTTPRequest
Тип функции: Impure
Описание:
Функция позволяет сформировать http-запрос для обращения к публичному API системы. Для формирования запроса, потребуется указать:
- адрес API
- тип запроса
- тело запроса
Внутри функции будет произведена конвертация
structtoJSONдля приведения к нужному формату запроса.Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Url String Адрес API Связь/контрол Type String Тип (метод) запроса Связь/контрол Body Wildcard: Struct array/single Тело запроса Связь BearerToken String Токен пользователя. (Automaton bot token) Связь/контрол UserspaceId String Id пользовательского пространства Связь/контрол Outputs
Название Тип Описание Параметры Ok Exec Пин вызова функции, в случае успешного выполнения запроса Связь Failed Exec Пин вызова функции, в случае неудачного выполнения запроса Связь Error String При наличии ошибки, ее тело будет передано в исходящий пин Error Связь Result Wildcard: Struct array/single Результат запроса будет передан для исходящего пина Result, формат которого будет определен по установленной связи Wildcard Связь
Функции для работы с объектами
BreakDynamic
Тип функции: Pure
Описание:
Функция позволяет разложить произвольный объект на составные элементы.
- На вход всегда принимается произвольный объект типа Dynamic. Для выхода пользователь создает пины, задает их типы и указывает, какие предполагаемые поля войдут в его состав.
- В случае если для данного объекта существует такое поле, то его значение передается на выход.
Inputs
Название Тип Описание Параметры Object Wildcard:Dynamic single Принимает любой объект Связь Outputs
Название Тип Описание Параметры Настраиваемый Настраиваемый Пользователь может добавить и настроить Пины в инспекторе. Пины могут быть массивом Связь
BreakStruct
Тип функции: Pure
Описание:
Функция автоматически раскладывает структуру на ее свойства при установлении входящей связи.
Свойства первого уровня вложенности отражаются в виде исходящих пинов.
Inputs
Название Тип Описание Параметры Value Wildcard:Struct single Принимает любую структуру Связь Outputs
Название Тип Описание Параметры - Тип и количество пинов зависят от состава входящей структуры Пины добавляются автоматически, при установке входящей связи Связь
ConvertToDynamic
Тип функции: Pure
Описание:
Преобразует объекты типа
Struct, а так же массивDynamicв Dynamic single (JSON)Inputs
Название Тип Описание Параметры Value Wildcard: Any Struct single/array, Dynamic Array Исходное значение. Структура или массив структур. Связь Outputs
Название Тип Описание Параметры Result Dynamic Возвращает преобразованное значение Связь
DynamicMerge
Тип функции: Pure
Описание:
Функция принимает на вход два объекта типа Dynamic и выполняет объединение их содержимого.
Объединение происходит путем слияния второго объекта с первым.
При слиянии осуществляется проверка на уникальность полей. В случае если в объединяемых объектах существуют одинаковые поля, значение исходного поля заменяется значением второго объекта.
Слияние строк происходит в порядке расположения пинов сверху вниз.
Inputs
Название Тип Описание Параметры Object Dynamic Исходный объект Связь Value Dynamic Объект, который планируется слить с исходным объектом Связь Outputs
Название Тип Описание Параметры Result Dynamic Результат объединения двух объектов Связь
DynamicContains
Тип функции: Impure
Описание:
Функция позволяет определить наличие заданного поля в переданном объекте.
Функция осуществляет проверку на наличие заданного поля в объекте и активирует последовательность
Contains, если поле найдено, илиNotContainsесли не найдено.Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Object Dynamic Объект, в котором будет выполнена проверка наличия поля FieldNameСвязь Value String Название проверяемого поля Связь Outputs
Название Тип Описание Параметры Contains Exec Последовательность активна, если поле найдено Связь NotContains Exec Последовательность активна, если поле НЕ найдено Связь
MakeStruct
Тип функции: Pure
Описание:
Функция устанавливает исходящую связь со структурой и позволяет задать значения ее свойств.
Свойства первого уровня вложенности отражаются в виде входящих пинов.
Inputs
Название Тип Описание Параметры *Типы и количество пинов зависят от состава конкретной структуры Пины добавляются автоматически, при установке исходящей связи. Связь Outputs
Название Тип Описание Параметры Result Wildcard: Any struct (single) Устанавливает связь с пинами типа "Struct" Связь
ReturnNull
Тип функции: Pure
Описание:
Функция возвращает
Nullдля пинов, с которым будет установлена связь.В случае с блоками автоматизации, если для входящих пинов не указано значение, то будет передано значение по умолчанию для указанного типа: "", "0" и тд. Однако некоторые запросы к API ожидают получить в модели именно
Null, для этого понадобится данная функция.Inputs
Outputs
Название Тип Описание Параметры Null Wildcard: any array, Dynamic:Single, String:Single, Struct:Single Возвращает Null в качестве значений пина Связь
SetMembersInStruct
Тип функции: Impure
Описание:
Функция позволяет внести изменение в значение конкретных свойств структуры.
Блок создается с доступным для выбора типом структуры.
На вход функции принимается вся структура. В инспекторе пользователь может указать, для каких свойств структуры нужно задать собственное значение.
Выбранные пользователем свойства отображаются, как входящие пины функции, с которыми можно установить связь или задать контрол.
На выходе функции будет представлена структура с измененными значениями.
Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Value Wildcard: Struct single Принимает на вход структуру Связь - - По умолчанию, пины свойств структуры будут отсутствовать. Их нужно указать в настройках конфигурации в инспекторе. Связь/контрол Outputs
Название Тип Описание Параметры Out Exec Пин вызова функции Связь Result Struct На выходе будет указанный тип структуры с обновленными значениями указанных свойств Связь
Функции управления потоком
Branch
Тип функции: Impure
Описание:
Функция предназначена для управления потоком. Направление определяется в зависимости от состояния пришедшей на вход
boolпеременной.Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Condition Bool Принимает значение true/false, благодаря чему функция определяет последовательность выполнения. Связь/контрол Outputs
Название Тип Описание Параметры True Exec Последовательность активна, если на вход пришло значение trueСвязь False Exec Последовательность активна, если на вход пришло значение falseСвязь
Switch
Тип функции: Impure
Описание:
Функция определяет направление потока, в зависимости от того, какое значение указанного строкового поля поступило на вход.
Добавление, удаление и настройка узлов выхода реализуется через инспектор (панель справа).
При добавлении устанавливается неизменяемый тип
Execпо умолчанию. Значение контрола - пустое.Функция принимает на вход только строку и числа.
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Value WildCard: string & any numbers Переменная, значение которой будет сравнивать функция для определения направления потока. Связь Outputs
Название Тип Описание Параметры {Значение} Exec Последовательность, выполняемая, если указанное пользователем значение в контроле совпадает с пришедшим на вход. Контрол/Связь Default Exec Последовательность, выполняемая, если ни одно указанное пользователем значение не совпало с пришедшим на вход. Связь
Функции итераций
DoWhile
Тип функции: Impure
Описание:
Цикл, гарантированно вызывающий последовательность один раз.
При следующей итерации проверяется значение входящего
booleanусловия. Если оно истинно - цикл продолжается. Если нет - прекращается.После прерывания цикла вызывается последовательность
Complete.Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Condition Boolean Значение, определяющее, зацикливается последовательность или нет. Связь/контрол Outputs
Название Тип Описание Параметры Loop Exec Вызывает последовательность, пока условие Condition == True.Связь Completed Exec Вызывает последовательность, если условие Condition == FalseСвязь
ForEach
Категория: Loop
Тип функции: Impure
Описание:
- Принимает на вход массив данных, перебирая каждый из них в цикле.
- При каждой итерации отдает элемент массива и его индекс
ElementIndex. - При каждой итерации цикла вызывается последовательность
Loop. - После прерывания цикла вызывается последовательность
Completed.
Тип пина обоюдно наследуется между
ArrayиArrayElement. Массив/сингл закреплен, наследуется именно тип.Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Array Wildcard: Any array Принимает на вход любой массив для дальнейшей работы с ним. Тип данного пина связан с типом пина Array Element. Связь Outputs
Название Тип Описание Параметры Loop Exec Последовательность, вызываемая каждую итерацию Связь ArrayElement Wildcard: Any single Принимает тип данных от входящего массива или от установки связи. Тип данного пина связан с типом пина Array. При выполнении итерации отдает на выход элемент массива. Связь Element Index Integer Индекс элемента для данной итерации Связь Completed Exec Последовательность вызываемая по завершению цикла Связь
WhileDo
Категория: Loop
Тип функции: Impure
Описание:
Функция циклично вызывает последовательность до тех пор, пока условие, принимаемое на вход - истинно.
После прерывания цикла вызывается последовательность
Complete.Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Condition Boolean Значение, определяющее, зацикливается последовательность или нет. Связь/контрол Outputs
Название Тип Описание Параметры Loop Exec Вызывает последовательность, пока условие Condition == True.Связь Completed Exec Вызывает последовательность, если условие Condition == FalseСвязь
Функции для работы с массивами
ArrayAddElement
Тип функции: Impure
Описание:
Функция добавляет элемент к входящему массиву и возвращает обновленный массив.
Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Array Wildcard: Any array Принимает и изменяет массив. Тип пина для wildcard устанавливается на все пины. Связь Element Wildcard: Any single Принимает на вход элемент, который будет добавлен в массив. Тип пина для wildcard устанавливается на все пины. Связь Outputs
Название Тип Описание Параметры Out Exec Пин вызова функции Связь Result Wildcard: Any array Возвращает измененный массив. Тип пина для wildcard устанавливается на все пины. Связь
ArrayAny
Тип функции: Pure
Описание:
Функция принимает на вход массив и возвращает true, если массив содержит хотя бы один элемент.
Inputs
Название Тип Описание Параметры Array Wildcard: Any array Принимает на вход массив для проверки на наличие в нем элементов Связь Outputs
Название Тип Описание Параметры Result Bool Возвращает значение по результатам проверки Связь
ArrayCreate
Тип функции: Pure
Описание:
Функция инициализации и наполнения массива
Inputs
Название Тип Описание Параметры a Wildcard: Single Элемент, который будет добавлен в состав массива Связь/контрол Outputs
Название Тип Описание Параметры Result Wildcard: Array Возвращает созданный массив Связь
ArrayExcept
Тип функции: Pure
Описание:
Функция принимает на вход два Wildcard массива, возвращает массив, содержащий все элементы первого массива, которых нет во втором массиве.
Тип наследуется для всех 3-х пинов при установке/снятии связи.
Inputs
Название Тип Описание Параметры First Wildcard: Any array Принимает любой массив, тип устанавливается на все пины блока, если еще не был установлен. Связь Second Wildcard: Any array Принимает любой массив, тип устанавливается на все пины блока, если еще не был установлен. Связь Outputs
Название Тип Описание Параметры Result Wildcard: Any array Возвращает массив элементов первого массива, которых нет во втором массиве. Связь
ArrayFirst
Тип функции: Pure
Описание:
Функция принимает на вход массив и возвращает первый по счету элемент.
Inputs
Название Тип Описание Параметры Array Wildcard: Any array Принимает на вход массив. Значение wildcard устанавливается парно на входящий и исходящий пин. Связь Outputs
Название Тип Описание Параметры Result Wildcard Возвращает первый по счету элемент. Значение wildcard устанавливается парно на входящий и исходящий пин. Связь
ArrayLength
Категория: Structure/object
Тип функции: Pure
Описание:
Принимает на вход любой массив и возвращает количество элементов в массиве.
Inputs
Название Тип Описание Параметры Value Wildcard: Any array Принимает на вход любой массив Связь Outputs
Название Тип Описание Параметры Result Int Возвращает количество элементов в массиве Связь
ArraySelect
Тип функции: Pure
Описание:
Функция принимает на вход массив структур и создает массивы элементов данных структур
Inputs
Название Тип Описание Параметры Value Wildcard:Struct: Any array Исходная структура Связь Outputs
Название Тип Описание Параметры Названия пинов берутся из исходной структуры Тип и количество пинов зависят от свойств исходной структуры Пины создаются автоматически, в зависимости от свойств исходной структуры Связь
ArrayUnion
Тип функции: Pure
Описание:
Возвращает массив элементов в объединении данных двух и более массивов, без дубликатов
Inputs
Название Тип Описание Параметры a Wildcard: Any array Массив Связь b Wildcard: Any array Массив Связь Outputs
Название Тип Описание Параметры Result Wildcard: Any array Итоговый объединенный массив Связь
Функции сравнения
CompareNumber
Тип функции: Impure
Описание:
Позволяет управлять потоком по результатам сравнения двух чисел, установленных по связи или заданными вручную.
Тип пинов - числовой Wildcard, устанавливаются связано на оба пина.
Тип обоюдно наследуется.
Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Value Wildcard: Number Сравниваемое число Связь/контрол CompareWith Wildcard: Number Число, с которым необходимо сравнить значение пина ValueСвязь/контрол Outputs
Название Тип Описание Параметры > Exec Последовательность активна, если значение пина Valueбольше значения пинаCompareWithСвязь == Exec Последовательность активна, если значения равны Связь < Exec Последовательность активна, если значение пина Valueменьше значения пинаCompareWithСвязь
Equal
Тип функции: Pure
Описание:
Функция принимает на вход и сравнивает между собой значения А и В, и если они равны - возвращает true.
Значения должны быть одного типа.
Тип обоюдно наследуется.
Inputs
Название Тип Описание Параметры A Wildcard: Basic single и struct:DateTime Принимает или устанавливает значение для сравнения Связь/контрол B Wildcard: Basic single и struct:DateTime Принимает или устанавливает значение для сравнения Связь/контрол Outputs
Название Тип Описание Параметры Result Bool Возвращает результат сравнения. Связь
Greater
Тип функции: Pure
Описание:
Функция принимает на вход и сравнивает между собой значения А и В, и если А больше В, возвращает true.
Значения должны быть одного типа.
Тип обоюдно наследуется.
Inputs
Название Тип Описание Параметры A Wildcard: byte, double, integer, integer64, struct:DateTime Принимает или устанавливает значение для сравнения Связь/контрол B Wildcard: byte, double, integer, integer64, struct:DateTime Принимает или устанавливает значение для сравнения Связь/контрол Outputs
Название Тип Описание Параметры Result Bool Возвращает результат сравнения. Связь
GreaterOrEqual
Тип функции: Pure
Описание:
Функция принимает на вход и сравнивает между собой значения А и В, и если А больше или равен В, возвращает true.
Значения должны быть одного типа.
Тип обоюдно наследуется.
Inputs
Название Тип Описание Параметры A Wildcard: byte, double, integer, integer64, struct:DateTime Принимает или устанавливает значение для сравнения Связь/контрол B Wildcard: byte, double, integer, integer64, struct:DateTime Принимает или устанавливает значение для сравнения Связь/контрол Outputs
Название Тип Описание Параметры Result Bool Возвращает результат сравнения. Связь
IsNull
Тип функции: Pure
Описание:
Принимает на вход любой тип данных, и возвращает
True, если значениеnull.Inputs
Название Тип Описание Параметры Value Any: single/array Переменная, значение которой будет проверяться на nullСвязь Outputs
Название Тип Описание Параметры Result Bool Возвращает True, если значениеnull. В остальных случаях -FalseСвязь
Less
Тип функции: Pure
Описание:
Функция принимает на вход и сравнивает между собой значения А и В, и если А меньше, чем В, возвращает true.
Значения должны быть одного типа.
Тип обоюдно наследуется.
Inputs
Название Тип Описание Параметры A Wildcard: byte, double, integer, integer64, struct:DateTime Принимает или устанавливает значение для сравнения Связь/контрол B Wildcard: byte, double, integer, integer64, struct:DateTime Принимает или устанавливает значение для сравнения Связь/контрол Outputs
Название Тип Описание Параметры Result Bool Возвращает результат сравнения. Связь
LessOrEqual
Тип функции: Pure
Описание:
Функция принимает на вход и сравнивает между собой значения А и В, и если А меньше или равен В, возвращает true.
Значения должны быть одного типа.
Тип обоюдно наследуется.
Inputs
Название Тип Описание Параметры A Wildcard: byte, double, integer, integer64, struct:DateTime Принимает или устанавливает значение для сравнения Связь/контрол B Wildcard: byte, double, integer, integer64, struct:DateTime Принимает или устанавливает значение для сравнения Связь/контрол Outputs
Название Тип Описание Параметры Result Bool Возвращает результат сравнения. Связь
NotEqual
Тип функции: Pure
Описание:
Функция принимает на вход и сравнивает между собой значения А и В, и если они не равны - возвращает true.
Значения должны быть одного типа.
Тип обоюдно наследуется.
Inputs
Название Тип Описание Параметры A Wildcard: Basic single и struct:DateTime Принимает или устанавливает значение для сравнения Связь/контрол B Wildcard: Basic single и struct:DateTime Принимает или устанавливает значение для сравнения Связь/контрол Outputs
Название Тип Описание Параметры Result Bool Возвращает результат сравнения. Связь
NewGuid
Тип функции: Pure
Описание:
Функция генерации уникального GUID
Outputs
Название Тип Описание Параметры Guid Guid При выполнении генерируется уникальный идентификатор типа GUID Связь
Математические функции
Increment
Тип функции: Impure
Описание:
Функция увеличивает на 1 значение числовой переменной, с которой у нее установлена входящая связь. Так же функция возвращает полученное значение на выходе.
Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Value Wildcard: byte, double, integer, integer64 Устанавливает связь с переменной Связь Outputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Result Wildcard: byte, double, integer, integer64 Устанавливает связь с переменной Связь
Decrement
Тип функции: Impure
Описание:
Функция уменьшает на 1 значение числовой переменной, с которой у нее установлена входящая связь. Так же функция возвращает полученное значение на выходе.
Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Value Wildcard: byte, double, integer, integer64 Устанавливает связь с переменной Связь Outputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Value Wildcard: byte, double, integer, integer64 Устанавливает связь с переменной Связь
Add
Тип функции: Pure
Описание:
Функция принимает на вход 2 и более значения, складывает их и возвращает сумму.
Пользователь может управлять количеством входящих пинов в настройках инспектора.
При добавлении очередного слагаемого, по умолчанию для него ставится значение 0.
Inputs
Название Тип Описание Параметры a Wildcard: byte, double, integer, integer64 Слагаемое Связь/контрол b Wildcard: byte, double, integer, integer64 Слагаемое Связь/контрол Outputs
Название Тип Описание Параметры Result Wildcard: byte, double, integer, integer64 Сумма Связь
Cast
Тип функции: Pure
Описание:
Преобразует числовое значение базового типа в эквивалентное ему числовое значение другого базового типа
Если исходное значение преобразуемого типа больше значения целевого типа, значение усекается до максимально возможного для итогового типа
Если исходное значение преобразуемого типа меньше значения целевого типа, значение увеличивается до минимально возможного для итогового типа
При преобразовании значения
Doubleв целочисленный тип оно округляется в сторону нуля до ближайшего целого значенияInputs
Название Тип Описание Параметры Value Wildcard: int, int64, double, byte Исходное значение. Тип предварительно можно выбрать в инспекторе Связь/контрол Outputs
Название Тип Описание Параметры Result Wildcard: int, int64, double, byte Преобразованное значение. Тип предварительно можно выбрать в инспекторе Связь
Логические функции
AND
Тип функции: Pure
Описание:
Функция с двумя или более операндами. Результат выполнения функции истинен тогда и только тогда, когда все операнды, принимаемые на вход - истинны.
Пользователь может добавить неограниченное количество операндов через инспектор
Для добавленных пинов по умолчанию выставляется неизменяемый тип пина bool
По умолчанию значение false.
Inputs
Название Тип Описание Параметры a Bool Принимает bool значение для сравнения Связь/контрол b Bool Принимает bool значение для сравнения Связь/контрол Outputs
Название Тип Описание Параметры Result Bool Результат выполнения Связь
OR
Тип функции: Pure
Описание:
Функция с 2 или более операндами. Результат выполнения функции истинен, когда хотя бы один из операндов, принимаемых на вход - истинен.
Пользователь может добавить неограниченное количество операндов через инспектор
Для добавленных пинов по умолчанию выставляется неизменяемый тип пина bool
По умолчанию значение false.
Inputs
Название Тип Описание Параметры a Bool Принимает bool значение для сравнения Связь/контрол b Bool Принимает bool значение для сравнения Связь/контрол Outputs
Название Тип Описание Параметры Result Bool Результат выполнения Связь
NOT
Категория: Logic Operators
Тип функции: Pure
Описание:
Функция с одним операндом. Результат выполнения функции истинен тогда и только тогда, когда принимаемый на вход операнд ложен.
Inputs
Название Тип Описание Параметры Value Bool Принимает bool значение для проверки Связь/контрол Outputs
Название Тип Описание Параметры Result Bool Результат выполнения Связь
Функции для работы со строками
ConvertToString
Тип функции: Pure
Описание:
Функция принимает на вход любой тип данных, преобразует и отдает на выходе строку.
Inputs
Название Тип Описание Параметры Value Wildcard: Any single Принимает на вход любое значение Связь/контрол Outputs
Название Тип Описание Параметры Result String Приведенное к строке входящее значение Связь
StringConcat
Категория: Strings
Тип функции: Pure
Описание:
Функция принимает на вход строковые значения, конкатенирует их и возвращает получившуюся строку в результате слияния.
Пользователь может добавить и удалить дополнительные входящие пины через инспектор.
При добавлении по умолчанию устанавливается не редактируемый тип string.
Слияние строк происходит в порядке расположения пинов сверху вниз.
Inputs
Название Тип Описание Параметры Value String Строка Связь/контрол Outputs
Название Тип Описание Параметры Result String Результат конкатенации Связь
StringContains
Тип функции: Impure
Описание:
Функция позволяет определить встречается ли указанная подстрока внутри заданной строки.
Функция осуществляет проверку, и активирует последовательность
Contains, если подстрока найдена, илиNotContainsесли не найдена.Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь String String Исходная строка Связь Substring String Подстрока Связь Outputs
Название Тип Описание Параметры Contains Exec Последовательность активна, если подстрока найдена Связь NotContains Exec Последовательность активна, если подстрока НЕ найдена Связь
Parse
Тип функции: Pure
Описание:
Преобразует строковое значение в эквивалентное ему значение другого базового типа
Если преобразование невозможно - в качестве результата будет возвращено значение по умолчанию для данного типа.
Inputs
Название Тип Описание Параметры Value String Строка, подлежащая преобразованию Связь/контрол Outputs
Название Тип Описание Параметры Result Wildcard: Single Преобразованное значение Связь
TryParse
Тип функции: Impure
Описание:
Преобразует строковое значение в эквивалентное ему значение другого базового типа
Возвращает
booleanзначение, указывающее, успешно ли выполнено преобразование, и активирует последовательность в зависимости от результата парсингаЕсли преобразование невозможно - в качестве результата будет возвращено значение по умолчанию для данного типа
Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Value String Строка, подлежащая преобразованию Связь/контрол Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна, если преобразование успешно Связь Failed Exec Последовательность активна, если не удалось выполнить преобразование Связь Result Wildcard: Single Преобразованное значение Связь IsSuccess Boolean Возвращает значение, указывающее, успешно ли выполнено преобразование Связь
Функции управления статусами
SetStatusCompleted
Тип функции: Impure
Описание:
Устанавливает для запуска сценария статус
Completedи записывает указанное сообщение и дополнительные данные в историю запускаInputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Message String Сообщение, которое будет записано в истории запуска для данного статуса Связь/контрол Attachment Wildcard: Any single/array Дополнительная информация, которая будет указана для данного запуска сценария Связь Outputs
Название Тип Описание Параметры Out Exec Последовательность активируется после выполнения функции Связь
SetStatusSkipped
Тип функции: Impure
Описание:
Устанавливает для запуска сценария статус
Skippedи записывает указанное сообщение и дополнительные данные в историю запускаInputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Message String Сообщение, которое будет записано в истории запуска для данного статуса Связь/контрол Attachment Wildcard: Any single/array Дополнительная информация, которая будет указана для данного запуска сценария Связь Outputs
Название Тип Описание Параметры Out Exec Последовательность активируется после выполнения функции Связь
SetStatusFailed
Тип функции: Impure
Описание:
Устанавливает для запуска сценария статус
Failedи записывает указанное сообщение и дополнительные данные в историю запускаInputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Message String Сообщение, которое будет записано в истории запуска для данного статуса Связь/контрол Attachment Wildcard: Any single/array Дополнительная информация, которая будет указана для данного запуска сценария Связь Outputs
Название Тип Описание Параметры Out Exec Последовательность активируется после выполнения функции Связь
SetStatusDebug
Тип функции: Impure
Описание:
Устанавливает для запуска сценария статус
Debugи записывает указанное сообщение и дополнительные данные в историю запускаInputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Message String Сообщение, которое будет записано в истории запуска для данного статуса Связь/контрол Attachment Wildcard: Any single/array Дополнительная информация, которая будет указана для данного запуска сценария Связь Outputs
Название Тип Описание Параметры Out Exec Последовательность активируется после выполнения функции Связь
Функции для работы с датами
ConvertToMilliseconds
Тип функции: Pure
Описание:
Функция принимает числовые значения дней, часов, минут, секунд и преобразует их в миллисекунды
Inputs
Название Тип Описание Параметры Days Integer N дней Связь/контрол Hours Integer N часов Связь/контрол Minutes Integer N минут Связь/контрол Seconds Integer N секунд Связь/контрол Outputs
Название Тип Описание Параметры Result Specific:Integer64:Single Значение времени в миллисекундах Связь
DateRangeToNow
Тип функции: Pure
Описание:
Функция возвращает структуру
DateRange, свойства которой вычисляются исходя из текущего времени и заданного пользователем значения.Например, "Последние 1 день 1 час 1 минута 1 секунда":
"StartDate": "2022-08-23T10:13:08.6904588+00:00",
"EndDate": "2022-08-24T11:14:09.6904695+00:00"Inputs
Название Тип Описание Параметры Days Integer N последних дней Связь/контрол Hours Integer N последних часов Связь/контрол Minutes Integer N последних минут Связь/контрол Seconds Integer N последних секунд Связь/контрол Outputs
Название Тип Описание Параметры DateRange Exec Диапазон дат от указанного времени в Input до текущего времени Связь
Now
Тип функции: Pure
Описание:
Возвращает текущее системное время
Inputs
Outputs
Название Тип Описание Параметры Result Struct: DateTime Возвращает текущее системное время Связь
ParseDateTime
Тип функции: Pure
Описание:
Принимает на вход строковое значение содержащую дату в каком-либо формате и преобразует данное значение в формат
DateTimeOffset.По умолчанию поддерживает большинство форматов даты.
В случае, если функция не может преобразовать исходное значение, необходимо воспользоваться полем
Formatи задать необходимую маску.Inputs
Название Тип Описание Параметры DateTime Specific:String:Single Дата, в строковом представлении Связь/контрол Format Specific:String:Single Указание строгого формата, по которому функция будет преобразовывать входящую дату Связь/контрол Outputs
Название Тип Описание Параметры DateTimeOffset Specific:DateTimeOffset:Single Возвращает преобразованное значение даты Связь В случае невозможности преобразовать значение - сценарий завершится с ошибкой.
TryParseDateTime
Тип функции: Impure
Описание:
Принимает на вход строковое значение содержащую дату в каком-либо формате и преобразует данное значение в формат DateTimeOffset. В отличии от функции ParseDateTime функция Impure. Так же, если функция не может распарсить значение, активируется последовательность Failed.
В остальном функция аналогична ParseDateTime.
Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь/контрол DateTime Specific:String:Single Дата, в строковом представлении Связь/контрол Format Specific:String:Single Указание строгого формата, по которому функция будет преобразовывать входящую дату Связь/контрол Outputs
Название Тип Описание Параметры Ok Exec Активна, если преобразование успешно выполнено Связь Failed Exec Активна, если преобразование не выполнено Связь DateTimeOffset Specific:DateTimeOffset:Single Возвращает преобразованное значение даты Связь Error Specific:String:Single Текст ошибки преобразования, с указанием исходного значения, которое не удалось преобразовать. Связь
UTCNow
Тип функции: Pure
Описание:
Возвращает текущее время по UTC
Inputs
Outputs
Название Тип Описание Параметры Result Struct: DateTime Возвращает текущее время по UTC Связь
Функции для работы с глобальными переменными
StorageSetValue
Тип функции: Impure
Описание:
Функция позволяет создать или обновить значение глобальной переменной по ключу и указать время ее жизни
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario ScenarioBase Системная переменная Scenario Связь IsPublic Boolean Область видимости глобальной переменной (хранилище переменной) Связь/контрол Key String Название ключа (название глобальной переменной) Связь/контрол Value Wildcard:Any single/array Значение глобальной переменной Связь/контрол ExpirationTime Integer64 Время жизни глобальной переменной (в миллисекундах), по истечению которого она будет удалена из хранилища Связь/контрол Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна, если глобальная переменная создана/обновлена успешно Связь Failed Exec Последовательность активна, если глобальная переменная создана/обновлена с ошибкой Связь Response String Текст ответа, в случае ошибки Связь
Хранилище глобальной переменной указывает уровень доступа к этой переменной:
True- управление глобальной переменной доступно на уровне Рабочей группы в разных сценарияхFalse(по умолчанию) - управление глобальной переменной доступно только на уровне текущего сценария
StorageTryGetValue
Тип функции: Impure
Описание:
Функция позволяет запросить значение указанной глобальной переменной
Запрос будет реализован в то хранилище, которое указано в переменной
IsPublicInputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario ScenarioBase Системная переменная Scenario Связь IsPublic Boolean Область видимости глобальной переменной Связь/контрол Key String Название ключа (название глобальной переменной) Связь/контрол Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна, если глобальная переменная создана/обновлена успешно Связь Failed Exec Последовательность активна, если глобальная переменная создана/обновлена с ошибкой Связь Result Wildcard any single/array Значение переменной, которое будет возвращено по запросу. Тип указывается пользователем, в зависимости от того, какой тип был задан при создании Связь Response String Текст ответа, в случае ошибки Связь
StorageRemoveKey
Тип функции: Impure
Описание:
Функция позволяет удалить глобальную переменную по ключу
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario ScenarioBase Системная переменная Scenario Связь IsPublic Boolean Область видимости глобальной переменной Связь/контрол Key String Название ключа (название глобальной переменной) Связь/контрол Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна, если глобальная переменная успешно удалена Связь Failed Exec Последовательность активна, если функция выполнилась с ошибкой Связь Response String Текст ответа, в случае ошибки Связь
Если была попытка удалить несуществующую глобальную переменную, то это валидная операция (код 204) и вызов пойдет по пину
Ok.
StorageKeyExists
Тип функции: Impure
Описание:
Функция позволяет определить наличие глобальной переменной с таким ключом с хранилище
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario ScenarioBase Системная переменная Scenario Связь IsPublic Boolean Область видимости глобальной переменной Связь/контрол Key String Название ключа (название глобальной переменной) Связь/контрол Outputs
Название Тип Описание Параметры Exists Exec Последовательность активна, если глобальная переменная с таким ключом существует в указанном хранилище Связь NotExists Exec Последовательность активна, если глобальная переменная с таким ключом не существует в указанном хранилище Связь Failed Exec Последовательность активна, если функция выполнилась с ошибкой Связь Response String Текст ответа, в случае ошибки Связь
Функции работы с планировщиком запуска сценариев
CreateSchedule
Тип функции: Impure
Описание:
Функция позволяет создать разовый запуск или расписание запусков текущего сценария
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario ScenarioBase Системная переменная Scenario Связь BearerToken String По умолчанию BearerTokenзапрашивается из переменнойScenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол Description String Описание запуска Связь/контрол TimeZone String Указание часового пояса в определенном формате. Если не указано - запуск будет произведен согласно серверному времени пространства. Пример формата: Europe/MoscowСвязь/контрол StartLaunchAt DateTimeOffset Дата первого запуска сценария Связь EndLaunchAt DateTimeOffset Дата, до которого длится расписание запуска Связь DelayTime Integer64 Время (в миллисекундах), через которое будет выполнен запуск сценария по планировщику, без необходимости указывать дату StartLaunchAtСвязь/контрол Cron String Расписание запуска в CRON-формате. Если не задано будет произведен разовый запуск Связь Body Wildcard(any struct, dynamic array, dynamic single) Тело события, с которым будет произведен запуск сценария Связь/контрол Outputs
Название Тип Описание Параметры Out Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Schedule Struct:Schedule Модель созданного запланированного запуска/расписания запусков Связь Response Struct:AutomatonResponse Возвращает результат запроса согласно модели AutomatonResponseСвязь