Глобальные функции
Описание и характеристика глобальных функций модуля Автоматизации, которые можно использовать при разработке сценариев.
Общие функции фильтрации
FilterByStreamId
-
Тип функции: Impure
-
Описание: Функция позволяет осуществлять фильтрацию принимаемого объекта по полю
id
структуры_stream
.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Stream Struct: StreamInLogEvent Принимает на вход структуру StreamInLogEvent Связь StreamId integer64 Идентификатор потока monq Связь/контрол -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна, если фильтрация успешна Связь Failed Exec Последовательность активна, если фильтрация неуспешна Связь
-
FilterStruct
-
Тип функции: Impure
-
Описание: Функция позволяет настроить фильтрацию по визуально сконструированному условию в инспекторе объектов.
Ограничения:
-
Не поддерживается фильтрация структур с типом
DateTimeOffset
-
Не поддерживается фильтрация среди массивов
Dynamic
-
Inputs
Название Тип Описание Параметры 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 секунд. Связь/контрол ProxyConfiguration Struct:ProxyConfiguration Конфигурация подключения используя прокси-сервер (адрес, порт, пользователь и пароль). Связь -
Outputs
Название Тип Описание Параметры Ok Exec Пин вызова функции, в случае успешного выполнения запроса Связь Failed Exec Пин вызова функции, в случае неудачного выполнения запроса Связь Result Wildcard: Struct array/single Результат запроса будет передан для исходящего пина Result, формат которого будет определен по установленной связи Wildcard Связь Response Struct:AutomatonResponse Результат запроса в сыром виде с дополнительной служебной информацией Связь
-
MonqHTTPRequest
Deprecated - AutomatonHTTPRequest
-
Тип функции: Impure
-
Описание:
Функция позволяет сформировать http-запрос для обращения к публичному API системы. Для формирования запроса, потребуется указать:
- адрес API
- тип запроса
- тело запроса
Внутри функции будет произведена конвертация
struct
toJSON
для приведения к нужному формату запроса.-
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 Последовательность, выполняемая, если ни одно указанное пользователем значение не совпало с пришедшим на вход. Связь
-
ThrowError
-
Тип функции: Impure
-
Описание:
Функция определяет направление потока, если искусственно необходимо вызвать ошибку сценария.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь -
Outputs
Название Тип Описание Параметры Error String Текст ошибки, который будет указан в истории запуска Связь
-
Функции итераций
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 Последовательность вызываемая по завершению цикла Связь
ForEachWithBreak
-
Категория: Loop
-
Тип функции: Impure
-
Описание:
- Принимает на вход массив данных, перебирая каждый из них в цикле.
- При каждой итерации отдает элемент массива и его индекс
ElementIndex
. - При каждой итерации цикла вызывается последовательность
Loop
. - После прерывания цикла вызывается последовательность
Completed
. - Если
Condition
==True
вызывается последовательностьCompleted
.
Тип пина обоюдно наследуется между
Array
иArrayElement
. Массив/сингл закреплен, наследуется именно тип.-
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Array Wildcard: Any array Принимает на вход любой массив для дальнейшей работы с ним. Тип данного пина связан с типом пина Array Element. Связь Condition Boolean Значение переменной для остановки цикла Связь -
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 устанавливается парно на входящий и исходящий пин. Связь
-
ArrayGetValue
-
Тип функции: Pure
-
Описание:
Функция принимает на вход массив и возвращает элемента массива по указанному индексу.
-
Inputs
Название Тип Описание Параметры Array Wildcard: Any array Принимает на вход массив. Значение wildcard устанавливается парно на входящий и исходящий пин. Связь ElementNumber Integer Индекс элемента массива Связь -
Outputs
Название Тип Описание Параметры Result Wildcard Возвращает элемент массива по указанному индексу. Значение wildcard устанавливается парно на входящий и исходящий пин. Связь
-
ArrayTryGetValue
-
Тип функции: Impure
-
Описание:
Функция принимает на вход массив и возвращает элемента массива по указанному индексу с возможностью обработать исключение, если элемент по указанному индексу не найден.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Array Wildcard: Any array Принимает на вход массив. Значение wildcard устанавливается парно на входящий и исходящий пин. Связь ElementNumber Integer Индекс элемента массива Связь -
Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна, если элемент найден Связь False Exec Последовательность активна, если элемента с таким индексом нет Связь Element Wildcard Найденный элемент массива Связь IsSuccess 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 Итоговый объединенный массив Связь
-
ArraySplit
-
Тип функции: Impure
-
Описание:
Функция принимает на вход любой массив и размер массивов для деления. Затем в цикле проходит по исходному массиву и итеративно возвращает новые массивы с указанным кол-вом элементов.
-
Inputs
Название Тип Описание Параметры In Exec Пин вызова функции Связь Array Wildcard: Any array Исходный массив, который необходимо разбить на подмассивы Связь Size Integer Количество элементов в подмассивах Связь -
Outputs
Название Тип Описание Параметры Loop Exec Пин вызова, который активируется каждую итерацию цикла Связь SubArray Wildcard: Any array Новые массивы с заданным кол-вом элементов, создаваемые итеративно в результате выполнения функции Связь Completed 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 Возвращает значение, указывающее, успешно ли выполнено преобразование Связь
-
ToLower
-
Тип функции: Pure
-
Описание:
-
Преобразует строковое значение в эквивалентное ему значение в нижнем регистре символов
-
Inputs
Название Тип Описание Параметры Source String Строка, подлежащая преобразованию Связь/контрол -
Outputs
Название Тип Описание Параметры Result Source Преобразованное значение в нижнем регистре символов Связь
-
ToUpper
-
Тип функции: Pure
-
Описание:
-
Преобразует строковое значение в эквивалентное ему значение в верхнем регистре символов
-
Inputs
Название Тип Описание Параметры Source String Строка, подлежащая преобразованию Связь/контрол -
Outputs
Название Тип Описание Параметры Result Source Преобразованное значение в верхнем регистре символов Связь
-
Trim
-
Тип функции: Pure
-
Описание:
-
Функция принимает на вход строку и возвращает новую строку, в которой удалены все начальные и конечные символы пробела
-
Inputs
Название Тип Описание Параметры Source String Строка, подлежащая преобразованию Связь/контрол -
Outputs
Название Тип Описание Параметры Result Source Преобразованное значение Связь
-
Функции управления статусами
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 Последовательность активируется после выполнения функции Связь
-