Перейти к основному содержимому
Версия: 7.9

Глобальные функции

Описание и характеристика глобальных функций модуля Автоматизации, которые можно использовать при разработке сценариев.

Общие функции фильтрации

FilterByStreamId

  • Тип функции: Impure

  • Описание: Функция позволяет осуществлять фильтрацию принимаемого объекта по полю id структуры _stream.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      StreamStruct: StreamInLogEventПринимает на вход структуру StreamInLogEventСвязь
      StreamIdinteger64Идентификатор потока monqСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна, если фильтрация успешнаСвязь
      FailedExecПоследовательность активна, если фильтрация неуспешнаСвязь

FilterStruct

  • Тип функции: Impure

  • Описание: Функция позволяет настроить фильтрацию по визуально сконструированному условию в инспекторе объектов.

    Изображение

    Ограничения:

    • Не поддерживается фильтрация структур с типом DateTimeOffset

    • Не поддерживается фильтрация среди массивов Dynamic

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      StructWildcard:StructПринимает на вход любую структуруСвязь
      QueryStringФильтруемое значениеСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      TrueExecПоследовательность активна, если фильтрация успешнаСвязь
      FalseExecПоследовательность активна, если фильтрация неуспешнаСвязь

HTTP Функции

AutomatonHTTPRequest

  • Тип функции: Impure

  • Описание:

    Функция позволяет сформировать http-запрос для обращения к публичному API любой системы.

    Для формирования запроса, необходимо указать:

    • адрес API

      Если Uri не начинается с http:// или с https://, то автоматически будет подставлен BaseUri из переменной Scenario для удобства работы с API Monq.

    • метод запроса

    • тело запроса

    • системную переменную Scenario

    • системную переменную BearerToken

      Данный параметр можно не указывать, если планируется отправить запрос от лица Automaton Bot (берется по умолчанию из переменной Scenario).

      Если указать - при запросе будет использован заданный пользователем Bearer Token.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      ScenarioStruct:ScenarioBaseПередаются общие параметры сценария для выполнения функцииСвязь/контрол
      UrlStringАдрес APIСвязь/контрол
      MethodStringТип (метод) запросаСвязь/контрол
      BodyWildcard: Struct array/singleТело запросаСвязь
      BearerTokenStringТокен пользователя. (Automaton bot token)Связь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПин вызова функции, в случае успешного выполнения запросаСвязь
      FailedExecПин вызова функции, в случае неудачного выполнения запросаСвязь
      ResultWildcard: Struct array/singleРезультат запроса будет передан для исходящего пина Result, формат которого будет определен по установленной связи WildcardСвязь
      ResponseWildcard: Struct singleРезультат запроса в сыром виде с дополнительной служебной информациейСвязь

HTTPRequest

  • Тип функции: Impure

  • Описание:

    Расширенная версия функции AutomatonHTTPRequest. В функцию добавлена возможность указать:

    • Заголовки запроса

    • Параметры запроса

    • Кодировку

    • Тип данных

    • Таймаут запроса

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      ScenarioStruct:ScenarioBaseПередаются общие параметры сценария для выполнения функцииСвязь/контрол
      UrlStringАбсолютный путь к запрашиваемому ресурсуСвязь/контрол
      MethodStringHTTP метод запросаСвязь/контрол
      ContentWildcard: Struct array/singleТело запросаСвязь
      MediaTypeStringТип данных. По умолчанию определяется в зависимости от типа пина ContentСвязь/контрол
      EncodingStringКодировка, которая используется при кодировании контента в запросе. По умолчанию UTF-8Связь/контрол
      HeadersStruct:StringKeyValueСписок заголовков запросаСвязь
      ContentHeadersStruct:StringKeyValueСписок заголовков для описания контента. Несет дополнительную информацию о типе контентаСвязь
      UrlParametersStruct:StringKeyValueСписок параметров запросаСвязь
      RequestTimeoutSecondsIntegerТаймаут запроса в секундах. При указании 0, ставится значение по умолчанию в 60 секунд.Связь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПин вызова функции, в случае успешного выполнения запросаСвязь
      FailedExecПин вызова функции, в случае неудачного выполнения запросаСвязь
      ResultWildcard: Struct array/singleРезультат запроса будет передан для исходящего пина Result, формат которого будет определен по установленной связи WildcardСвязь
      ResponseStruct:AutomatonResponseРезультат запроса в сыром виде с дополнительной служебной информациейСвязь

MonqHTTPRequest

Deprecated - AutomatonHTTPRequest

  • Тип функции: Impure

  • Описание:

    Изображение

    Функция позволяет сформировать http-запрос для обращения к публичному API системы. Для формирования запроса, потребуется указать:

    • адрес API
    • тип запроса
    • тело запроса

    Внутри функции будет произведена конвертация struct to JSON для приведения к нужному формату запроса.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      UrlStringАдрес APIСвязь/контрол
      TypeStringТип (метод) запросаСвязь/контрол
      BodyWildcard: Struct array/singleТело запросаСвязь
      BearerTokenStringТокен пользователя. (Automaton bot token)Связь/контрол
      UserspaceIdStringId пользовательского пространстваСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПин вызова функции, в случае успешного выполнения запросаСвязь
      FailedExecПин вызова функции, в случае неудачного выполнения запросаСвязь
      ErrorStringПри наличии ошибки, ее тело будет передано в исходящий пин ErrorСвязь
      ResultWildcard: Struct array/singleРезультат запроса будет передан для исходящего пина Result, формат которого будет определен по установленной связи WildcardСвязь

Функции для работы с объектами

BreakDynamic

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция позволяет разложить произвольный объект на составные элементы.

    1. На вход всегда принимается произвольный объект типа Dynamic. Для выхода пользователь создает пины, задает их типы и указывает, какие предполагаемые поля войдут в его состав.
    2. В случае если для данного объекта существует такое поле, то его значение передается на выход.
    • Inputs

      НазваниеТипОписаниеПараметры
      ObjectWildcard:Dynamic singleПринимает любой объектСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      НастраиваемыйНастраиваемыйПользователь может добавить и настроить Пины в инспекторе. Пины могут быть массивомСвязь

BreakStruct

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция автоматически раскладывает структуру на ее свойства при установлении входящей связи.

    Свойства первого уровня вложенности отражаются в виде исходящих пинов.

    • Inputs

      НазваниеТипОписаниеПараметры
      ValueWildcard:Struct singleПринимает любую структуруСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      -Тип и количество пинов зависят от состава входящей структурыПины добавляются автоматически, при установке входящей связиСвязь

ConvertToDynamic

  • Тип функции: Pure

  • Описание:

    • Преобразует объекты типа Struct, а так же массив Dynamic в Dynamic single (JSON)

    • Inputs

      НазваниеТипОписаниеПараметры
      ValueWildcard: Any Struct single/array, Dynamic ArrayИсходное значение. Структура или массив структур.Связь
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultDynamicВозвращает преобразованное значениеСвязь

DynamicMerge

  • Тип функции: Pure

  • Описание:

    Функция принимает на вход два объекта типа Dynamic и выполняет объединение их содержимого.

    • Объединение происходит путем слияния второго объекта с первым.

    • При слиянии осуществляется проверка на уникальность полей. В случае если в объединяемых объектах существуют одинаковые поля, значение исходного поля заменяется значением второго объекта.

    • Слияние строк происходит в порядке расположения пинов сверху вниз.

    • Inputs

      НазваниеТипОписаниеПараметры
      ObjectDynamicИсходный объектСвязь
      ValueDynamicОбъект, который планируется слить с исходным объектомСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultDynamicРезультат объединения двух объектовСвязь

DynamicContains

  • Тип функции: Impure

  • Описание:

    Функция позволяет определить наличие заданного поля в переданном объекте.

    • Функция осуществляет проверку на наличие заданного поля в объекте и активирует последовательность Contains, если поле найдено, или NotContains если не найдено.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      ObjectDynamicОбъект, в котором будет выполнена проверка наличия поля FieldNameСвязь
      ValueStringНазвание проверяемого поляСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      ContainsExecПоследовательность активна, если поле найденоСвязь
      NotContainsExecПоследовательность активна, если поле НЕ найденоСвязь

MakeStruct

  • Тип функции: Pure

  • Описание:

    Функция устанавливает исходящую связь со структурой и позволяет задать значения ее свойств.

    Свойства первого уровня вложенности отражаются в виде входящих пинов.

    • Inputs

      НазваниеТипОписаниеПараметры
      *Типы и количество пинов зависят от состава конкретной структурыПины добавляются автоматически, при установке исходящей связи.Связь
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultWildcard: Any struct (single)Устанавливает связь с пинами типа "Struct"Связь

ReturnNull

  • Тип функции: Pure

  • Описание:

    • Функция возвращает Null для пинов, с которым будет установлена связь.

    • В случае с блоками автоматизации, если для входящих пинов не указано значение, то будет передано значение по умолчанию для указанного типа: "", "0" и тд. Однако некоторые запросы к API ожидают получить в модели именно Null, для этого понадобится данная функция.

    • Inputs

    • Outputs

      НазваниеТипОписаниеПараметры
      NullWildcard: any array, Dynamic:Single, String:Single, Struct:SingleВозвращает Null в качестве значений пинаСвязь

SetMembersInStruct

  • Тип функции: Impure

  • Описание:

    Изображение

    Функция позволяет внести изменение в значение конкретных свойств структуры.

    • Блок создается с доступным для выбора типом структуры.

    • На вход функции принимается вся структура. В инспекторе пользователь может указать, для каких свойств структуры нужно задать собственное значение.

    • Выбранные пользователем свойства отображаются, как входящие пины функции, с которыми можно установить связь или задать контрол.

    • На выходе функции будет представлена структура с измененными значениями.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      ValueWildcard: Struct singleПринимает на вход структуруСвязь
      --По умолчанию, пины свойств структуры будут отсутствовать. Их нужно указать в настройках конфигурации в инспекторе.Связь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OutExecПин вызова функцииСвязь
      ResultStructНа выходе будет указанный тип структуры с обновленными значениями указанных свойствСвязь

Функции управления потоком

Branch

  • Тип функции: Impure

  • Описание:

    Изображение

    Функция предназначена для управления потоком. Направление определяется в зависимости от состояния пришедшей на вход bool переменной.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ConditionBoolПринимает значение true/false, благодаря чему функция определяет последовательность выполнения.Связь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      TrueExecПоследовательность активна, если на вход пришло значение trueСвязь
      FalseExecПоследовательность активна, если на вход пришло значение falseСвязь

Switch

  • Тип функции: Impure

  • Описание:

    Изображение

    Функция определяет направление потока, в зависимости от того, какое значение указанного строкового поля поступило на вход.

    • Добавление, удаление и настройка узлов выхода реализуется через инспектор (панель справа).

    • При добавлении устанавливается неизменяемый тип Exec по умолчанию. Значение контрола - пустое.

    • Функция принимает на вход только строку и числа.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ValueWildCard: string & any numbersПеременная, значение которой будет сравнивать функция для определения направления потока.Связь
    • Outputs

      НазваниеТипОписаниеПараметры
      {Значение}ExecПоследовательность, выполняемая, если указанное пользователем значение в контроле совпадает с пришедшим на вход.Контрол/Связь
      DefaultExecПоследовательность, выполняемая, если ни одно указанное пользователем значение не совпало с пришедшим на вход.Связь

Функции итераций

DoWhile

  • Тип функции: Impure

  • Описание:

    Изображение

    • Цикл, гарантированно вызывающий последовательность один раз.

    • При следующей итерации проверяется значение входящего boolean условия. Если оно истинно - цикл продолжается. Если нет - прекращается.

    • После прерывания цикла вызывается последовательность Complete.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ConditionBooleanЗначение, определяющее, зацикливается последовательность или нет.Связь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      LoopExecВызывает последовательность, пока условие Condition == True.Связь
      CompletedExecВызывает последовательность, если условие Condition == FalseСвязь

ForEach

  • Категория: Loop

  • Тип функции: Impure

  • Описание:

    Изображение

    • Принимает на вход массив данных, перебирая каждый из них в цикле.
    • При каждой итерации отдает элемент массива и его индекс ElementIndex.
    • При каждой итерации цикла вызывается последовательность Loop.
    • После прерывания цикла вызывается последовательность Completed.

    Тип пина обоюдно наследуется между Array и ArrayElement. Массив/сингл закреплен, наследуется именно тип.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ArrayWildcard: Any arrayПринимает на вход любой массив для дальнейшей работы с ним. Тип данного пина связан с типом пина Array Element.Связь
    • Outputs

      НазваниеТипОписаниеПараметры
      LoopExecПоследовательность, вызываемая каждую итерациюСвязь
      ArrayElementWildcard: Any singleПринимает тип данных от входящего массива или от установки связи. Тип данного пина связан с типом пина Array. При выполнении итерации отдает на выход элемент массива.Связь
      Element IndexIntegerИндекс элемента для данной итерацииСвязь
      CompletedExecПоследовательность вызываемая по завершению циклаСвязь

WhileDo

  • Категория: Loop

  • Тип функции: Impure

  • Описание:

    Изображение

    • Функция циклично вызывает последовательность до тех пор, пока условие, принимаемое на вход - истинно.

    • После прерывания цикла вызывается последовательность Complete.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ConditionBooleanЗначение, определяющее, зацикливается последовательность или нет.Связь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      LoopExecВызывает последовательность, пока условие Condition == True.Связь
      CompletedExecВызывает последовательность, если условие Condition == FalseСвязь

Функции для работы с массивами

ArrayAddElement

  • Тип функции: Impure

  • Описание:

    Изображение

    Функция добавляет элемент к входящему массиву и возвращает обновленный массив.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      ArrayWildcard: Any arrayПринимает и изменяет массив. Тип пина для wildcard устанавливается на все пины.Связь
      ElementWildcard: Any singleПринимает на вход элемент, который будет добавлен в массив. Тип пина для wildcard устанавливается на все пины.Связь
    • Outputs

      НазваниеТипОписаниеПараметры
      OutExecПин вызова функцииСвязь
      ResultWildcard: Any arrayВозвращает измененный массив. Тип пина для wildcard устанавливается на все пины.Связь

ArrayAny

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция принимает на вход массив и возвращает true, если массив содержит хотя бы один элемент.

    • Inputs

      НазваниеТипОписаниеПараметры
      ArrayWildcard: Any arrayПринимает на вход массив для проверки на наличие в нем элементовСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultBoolВозвращает значение по результатам проверкиСвязь

ArrayCreate

  • Тип функции: Pure

  • Описание:

    • Функция инициализации и наполнения массива

    • Inputs

      НазваниеТипОписаниеПараметры
      aWildcard: SingleЭлемент, который будет добавлен в состав массиваСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultWildcard: ArrayВозвращает созданный массивСвязь

ArrayExcept

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция принимает на вход два Wildcard массива, возвращает массив, содержащий все элементы первого массива, которых нет во втором массиве.

    Тип наследуется для всех 3-х пинов при установке/снятии связи.

    • Inputs

      НазваниеТипОписаниеПараметры
      FirstWildcard: Any arrayПринимает любой массив, тип устанавливается на все пины блока, если еще не был установлен.Связь
      SecondWildcard: Any arrayПринимает любой массив, тип устанавливается на все пины блока, если еще не был установлен.Связь
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultWildcard: Any arrayВозвращает массив элементов первого массива, которых нет во втором массиве.Связь

ArrayFirst

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция принимает на вход массив и возвращает первый по счету элемент.

    • Inputs

      НазваниеТипОписаниеПараметры
      ArrayWildcard: Any arrayПринимает на вход массив. Значение wildcard устанавливается парно на входящий и исходящий пин.Связь
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultWildcardВозвращает первый по счету элемент. Значение wildcard устанавливается парно на входящий и исходящий пин.Связь

ArrayLength

  • Категория: Structure/object

  • Тип функции: Pure

  • Описание:

    • Принимает на вход любой массив и возвращает количество элементов в массиве.

    • Inputs

      НазваниеТипОписаниеПараметры
      ValueWildcard: Any arrayПринимает на вход любой массивСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultIntВозвращает количество элементов в массивеСвязь

ArraySelect

  • Тип функции: Pure

  • Описание:

    Функция принимает на вход массив структур и создает массивы элементов данных структур

    • Inputs

      НазваниеТипОписаниеПараметры
      ValueWildcard:Struct: Any arrayИсходная структураСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      Названия пинов берутся из исходной структурыТип и количество пинов зависят от свойств исходной структурыПины создаются автоматически, в зависимости от свойств исходной структурыСвязь

ArrayUnion

  • Тип функции: Pure

  • Описание:

    Возвращает массив элементов в объединении данных двух и более массивов, без дубликатов

    • Inputs

      НазваниеТипОписаниеПараметры
      aWildcard: Any arrayМассивСвязь
      bWildcard: Any arrayМассивСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultWildcard: Any arrayИтоговый объединенный массивСвязь

Функции сравнения

CompareNumber

  • Тип функции: Impure

  • Описание:

    Позволяет управлять потоком по результатам сравнения двух чисел, установленных по связи или заданными вручную.

    • Тип пинов - числовой Wildcard, устанавливаются связано на оба пина.

    • Тип обоюдно наследуется.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      ValueWildcard: NumberСравниваемое числоСвязь/контрол
      CompareWithWildcard: NumberЧисло, с которым необходимо сравнить значение пина ValueСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      >ExecПоследовательность активна, если значение пина Value больше значения пина CompareWithСвязь
      ==ExecПоследовательность активна, если значения равныСвязь
      <ExecПоследовательность активна, если значение пина Value меньше значения пина CompareWithСвязь

Equal

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция принимает на вход и сравнивает между собой значения А и В, и если они равны - возвращает true.

    • Значения должны быть одного типа.

    • Тип обоюдно наследуется.

    • Inputs

      НазваниеТипОписаниеПараметры
      AWildcard: Basic single и struct:DateTimeПринимает или устанавливает значение для сравненияСвязь/контрол
      BWildcard: Basic single и struct:DateTimeПринимает или устанавливает значение для сравненияСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultBoolВозвращает результат сравнения.Связь

Greater

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция принимает на вход и сравнивает между собой значения А и В, и если А больше В, возвращает true.

    • Значения должны быть одного типа.

    • Тип обоюдно наследуется.

    • Inputs

      НазваниеТипОписаниеПараметры
      AWildcard: byte, double, integer, integer64, struct:DateTimeПринимает или устанавливает значение для сравненияСвязь/контрол
      BWildcard: byte, double, integer, integer64, struct:DateTimeПринимает или устанавливает значение для сравненияСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultBoolВозвращает результат сравнения.Связь

GreaterOrEqual

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция принимает на вход и сравнивает между собой значения А и В, и если А больше или равен В, возвращает true.

    • Значения должны быть одного типа.

    • Тип обоюдно наследуется.

    • Inputs

      НазваниеТипОписаниеПараметры
      AWildcard: byte, double, integer, integer64, struct:DateTimeПринимает или устанавливает значение для сравненияСвязь/контрол
      BWildcard: byte, double, integer, integer64, struct:DateTimeПринимает или устанавливает значение для сравненияСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultBoolВозвращает результат сравнения.Связь

IsNull

  • Тип функции: Pure

  • Описание:

    Принимает на вход любой тип данных, и возвращает True, если значение null.

    • Inputs

      НазваниеТипОписаниеПараметры
      ValueAny: single/arrayПеременная, значение которой будет проверяться на nullСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultBoolВозвращает True, если значение null. В остальных случаях - FalseСвязь

Less

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция принимает на вход и сравнивает между собой значения А и В, и если А меньше, чем В, возвращает true.

    • Значения должны быть одного типа.

    • Тип обоюдно наследуется.

    • Inputs

      НазваниеТипОписаниеПараметры
      AWildcard: byte, double, integer, integer64, struct:DateTimeПринимает или устанавливает значение для сравненияСвязь/контрол
      BWildcard: byte, double, integer, integer64, struct:DateTimeПринимает или устанавливает значение для сравненияСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultBoolВозвращает результат сравнения.Связь

LessOrEqual

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция принимает на вход и сравнивает между собой значения А и В, и если А меньше или равен В, возвращает true.

    • Значения должны быть одного типа.

    • Тип обоюдно наследуется.

    • Inputs

      НазваниеТипОписаниеПараметры
      AWildcard: byte, double, integer, integer64, struct:DateTimeПринимает или устанавливает значение для сравненияСвязь/контрол
      BWildcard: byte, double, integer, integer64, struct:DateTimeПринимает или устанавливает значение для сравненияСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultBoolВозвращает результат сравнения.Связь

NotEqual

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция принимает на вход и сравнивает между собой значения А и В, и если они не равны - возвращает true.

    • Значения должны быть одного типа.

    • Тип обоюдно наследуется.

    • Inputs

      НазваниеТипОписаниеПараметры
      AWildcard: Basic single и struct:DateTimeПринимает или устанавливает значение для сравненияСвязь/контрол
      BWildcard: Basic single и struct:DateTimeПринимает или устанавливает значение для сравненияСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultBoolВозвращает результат сравнения.Связь

NewGuid

  • Тип функции: Pure

  • Описание:

    Функция генерации уникального GUID

    • Outputs

      НазваниеТипОписаниеПараметры
      GuidGuidПри выполнении генерируется уникальный идентификатор типа GUIDСвязь

Математические функции

Increment

  • Тип функции: Impure

  • Описание:

    Изображение

    Функция увеличивает на 1 значение числовой переменной, с которой у нее установлена входящая связь. Так же функция возвращает полученное значение на выходе.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      ValueWildcard: byte, double, integer, integer64Устанавливает связь с переменнойСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      ResultWildcard: byte, double, integer, integer64Устанавливает связь с переменнойСвязь

Decrement

  • Тип функции: Impure

  • Описание:

    Изображение

    Функция уменьшает на 1 значение числовой переменной, с которой у нее установлена входящая связь. Так же функция возвращает полученное значение на выходе.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      ValueWildcard: byte, double, integer, integer64Устанавливает связь с переменнойСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      ValueWildcard: byte, double, integer, integer64Устанавливает связь с переменнойСвязь

Add

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция принимает на вход 2 и более значения, складывает их и возвращает сумму.

    • Пользователь может управлять количеством входящих пинов в настройках инспектора.

    • При добавлении очередного слагаемого, по умолчанию для него ставится значение 0.

    • Inputs

      НазваниеТипОписаниеПараметры
      aWildcard: byte, double, integer, integer64СлагаемоеСвязь/контрол
      bWildcard: byte, double, integer, integer64СлагаемоеСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultWildcard: byte, double, integer, integer64СуммаСвязь

Cast

  • Тип функции: Pure

  • Описание:

    • Преобразует числовое значение базового типа в эквивалентное ему числовое значение другого базового типа

    • Если исходное значение преобразуемого типа больше значения целевого типа, значение усекается до максимально возможного для итогового типа

    • Если исходное значение преобразуемого типа меньше значения целевого типа, значение увеличивается до минимально возможного для итогового типа

    • При преобразовании значения Double в целочисленный тип оно округляется в сторону нуля до ближайшего целого значения

    • Inputs

      НазваниеТипОписаниеПараметры
      ValueWildcard: int, int64, double, byteИсходное значение. Тип предварительно можно выбрать в инспектореСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultWildcard: int, int64, double, byteПреобразованное значение. Тип предварительно можно выбрать в инспектореСвязь

Логические функции

AND

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция с двумя или более операндами. Результат выполнения функции истинен тогда и только тогда, когда все операнды, принимаемые на вход - истинны.

    • Пользователь может добавить неограниченное количество операндов через инспектор

    • Для добавленных пинов по умолчанию выставляется неизменяемый тип пина bool

    • По умолчанию значение false.

    • Inputs

      НазваниеТипОписаниеПараметры
      aBoolПринимает bool значение для сравненияСвязь/контрол
      bBoolПринимает bool значение для сравненияСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultBoolРезультат выполненияСвязь

OR

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция с 2 или более операндами. Результат выполнения функции истинен, когда хотя бы один из операндов, принимаемых на вход - истинен.

    • Пользователь может добавить неограниченное количество операндов через инспектор

    • Для добавленных пинов по умолчанию выставляется неизменяемый тип пина bool

    • По умолчанию значение false.

    • Inputs

      НазваниеТипОписаниеПараметры
      aBoolПринимает bool значение для сравненияСвязь/контрол
      bBoolПринимает bool значение для сравненияСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultBoolРезультат выполненияСвязь

NOT

  • Категория: Logic Operators

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция с одним операндом. Результат выполнения функции истинен тогда и только тогда, когда принимаемый на вход операнд ложен.

    • Inputs

      НазваниеТипОписаниеПараметры
      ValueBoolПринимает bool значение для проверкиСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultBoolРезультат выполненияСвязь

Функции для работы со строками

ConvertToString

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция принимает на вход любой тип данных, преобразует и отдает на выходе строку.

    • Inputs

      НазваниеТипОписаниеПараметры
      ValueWildcard: Any singleПринимает на вход любое значениеСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultStringПриведенное к строке входящее значениеСвязь

StringConcat

  • Категория: Strings

  • Тип функции: Pure

  • Описание:

    Изображение

    Функция принимает на вход строковые значения, конкатенирует их и возвращает получившуюся строку в результате слияния.

    • Пользователь может добавить и удалить дополнительные входящие пины через инспектор.

    • При добавлении по умолчанию устанавливается не редактируемый тип string.

    • Слияние строк происходит в порядке расположения пинов сверху вниз.

    • Inputs

      НазваниеТипОписаниеПараметры
      ValueStringСтрокаСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultStringРезультат конкатенацииСвязь

StringContains

  • Тип функции: Impure

  • Описание:

    Функция позволяет определить встречается ли указанная подстрока внутри заданной строки.

    • Функция осуществляет проверку, и активирует последовательность Contains, если подстрока найдена, или NotContains если не найдена.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      StringStringИсходная строкаСвязь
      SubstringStringПодстрокаСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      ContainsExecПоследовательность активна, если подстрока найденаСвязь
      NotContainsExecПоследовательность активна, если подстрока НЕ найденаСвязь

Parse

  • Тип функции: Pure

  • Описание:

    • Преобразует строковое значение в эквивалентное ему значение другого базового типа

    • Если преобразование невозможно - в качестве результата будет возвращено значение по умолчанию для данного типа.

    • Inputs

      НазваниеТипОписаниеПараметры
      ValueStringСтрока, подлежащая преобразованиюСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultWildcard: SingleПреобразованное значениеСвязь

TryParse

  • Тип функции: Impure

  • Описание:

    • Преобразует строковое значение в эквивалентное ему значение другого базового типа

    • Возвращает boolean значение, указывающее, успешно ли выполнено преобразование, и активирует последовательность в зависимости от результата парсинга

    • Если преобразование невозможно - в качестве результата будет возвращено значение по умолчанию для данного типа

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      ValueStringСтрока, подлежащая преобразованиюСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна, если преобразование успешноСвязь
      FailedExecПоследовательность активна, если не удалось выполнить преобразованиеСвязь
      ResultWildcard: SingleПреобразованное значениеСвязь
      IsSuccessBooleanВозвращает значение, указывающее, успешно ли выполнено преобразованиеСвязь

Функции управления статусами

SetStatusCompleted

  • Тип функции: Impure

  • Описание:

    Устанавливает для запуска сценария статус Completed и записывает указанное сообщение и дополнительные данные в историю запуска

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      MessageStringСообщение, которое будет записано в истории запуска для данного статусаСвязь/контрол
      AttachmentWildcard: Any single/arrayДополнительная информация, которая будет указана для данного запуска сценарияСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OutExecПоследовательность активируется после выполнения функцииСвязь

SetStatusSkipped

  • Тип функции: Impure

  • Описание:

    Устанавливает для запуска сценария статус Skipped и записывает указанное сообщение и дополнительные данные в историю запуска

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      MessageStringСообщение, которое будет записано в истории запуска для данного статусаСвязь/контрол
      AttachmentWildcard: Any single/arrayДополнительная информация, которая будет указана для данного запуска сценарияСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OutExecПоследовательность активируется после выполнения функцииСвязь

SetStatusFailed

  • Тип функции: Impure

  • Описание:

    Устанавливает для запуска сценария статус Failed и записывает указанное сообщение и дополнительные данные в историю запуска

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      MessageStringСообщение, которое будет записано в истории запуска для данного статусаСвязь/контрол
      AttachmentWildcard: Any single/arrayДополнительная информация, которая будет указана для данного запуска сценарияСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OutExecПоследовательность активируется после выполнения функцииСвязь

SetStatusDebug

  • Тип функции: Impure

  • Описание:

    Устанавливает для запуска сценария статус Debug и записывает указанное сообщение и дополнительные данные в историю запуска

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь
      MessageStringСообщение, которое будет записано в истории запуска для данного статусаСвязь/контрол
      AttachmentWildcard: Any single/arrayДополнительная информация, которая будет указана для данного запуска сценарияСвязь
    • Outputs

      НазваниеТипОписаниеПараметры
      OutExecПоследовательность активируется после выполнения функцииСвязь

Функции для работы с датами

ConvertToMilliseconds

  • Тип функции: Pure

  • Описание:

    • Функция принимает числовые значения дней, часов, минут, секунд и преобразует их в миллисекунды

    • Inputs

      НазваниеТипОписаниеПараметры
      DaysIntegerN днейСвязь/контрол
      HoursIntegerN часовСвязь/контрол
      MinutesIntegerN минутСвязь/контрол
      SecondsIntegerN секундСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ResultSpecific: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

      НазваниеТипОписаниеПараметры
      DaysIntegerN последних днейСвязь/контрол
      HoursIntegerN последних часовСвязь/контрол
      MinutesIntegerN последних минутСвязь/контрол
      SecondsIntegerN последних секундСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      DateRangeExecДиапазон дат от указанного времени в Input до текущего времениСвязь

Now

  • Тип функции: Pure

  • Описание:

    • Возвращает текущее системное время

    • Inputs

    • Outputs

      НазваниеТипОписаниеПараметры
      ResultStruct: DateTimeВозвращает текущее системное времяСвязь

ParseDateTime

  • Тип функции: Pure

  • Описание:

    • Принимает на вход строковое значение содержащую дату в каком-либо формате и преобразует данное значение в формат DateTimeOffset.

    • По умолчанию поддерживает большинство форматов даты.

    • В случае, если функция не может преобразовать исходное значение, необходимо воспользоваться полем Format и задать необходимую маску.

    • Inputs

      НазваниеТипОписаниеПараметры
      DateTimeSpecific:String:SingleДата, в строковом представленииСвязь/контрол
      FormatSpecific:String:SingleУказание строгого формата, по которому функция будет преобразовывать входящую датуСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      DateTimeOffsetSpecific:DateTimeOffset:SingleВозвращает преобразованное значение датыСвязь
    • В случае невозможности преобразовать значение - сценарий завершится с ошибкой.

TryParseDateTime

  • Тип функции: Impure

  • Описание:

    • Принимает на вход строковое значение содержащую дату в каком-либо формате и преобразует данное значение в формат DateTimeOffset. В отличии от функции ParseDateTime функция Impure. Так же, если функция не может распарсить значение, активируется последовательность Failed.

    • В остальном функция аналогична ParseDateTime.

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызова функцииСвязь/контрол
      DateTimeSpecific:String:SingleДата, в строковом представленииСвязь/контрол
      FormatSpecific:String:SingleУказание строгого формата, по которому функция будет преобразовывать входящую датуСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecАктивна, если преобразование успешно выполненоСвязь
      FailedExecАктивна, если преобразование не выполненоСвязь
      DateTimeOffsetSpecific:DateTimeOffset:SingleВозвращает преобразованное значение датыСвязь
      ErrorSpecific:String:SingleТекст ошибки преобразования, с указанием исходного значения, которое не удалось преобразовать.Связь

UTCNow

  • Тип функции: Pure

  • Описание:

    • Возвращает текущее время по UTC

    • Inputs

    • Outputs

      НазваниеТипОписаниеПараметры
      ResultStruct: DateTimeВозвращает текущее время по UTCСвязь

Функции для работы с глобальными переменными

StorageSetValue

  • Тип функции: Impure

  • Описание:

    • Функция позволяет создать или обновить значение глобальной переменной по ключу и указать время ее жизни

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioScenarioBaseСистемная переменная ScenarioСвязь
      IsPublicBooleanОбласть видимости глобальной переменной (хранилище переменной)Связь/контрол
      KeyStringНазвание ключа (название глобальной переменной)Связь/контрол
      ValueWildcard:Any single/arrayЗначение глобальной переменнойСвязь/контрол
      ExpirationTimeInteger64Время жизни глобальной переменной (в миллисекундах), по истечению которого она будет удалена из хранилищаСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна, если глобальная переменная создана/обновлена успешноСвязь
      FailedExecПоследовательность активна, если глобальная переменная создана/обновлена с ошибкойСвязь
      ResponseStringТекст ответа, в случае ошибкиСвязь

    Хранилище глобальной переменной указывает уровень доступа к этой переменной:

    • True - управление глобальной переменной доступно на уровне Рабочей группы в разных сценариях
    • False (по умолчанию) - управление глобальной переменной доступно только на уровне текущего сценария

StorageTryGetValue

  • Тип функции: Impure

  • Описание:

    • Функция позволяет запросить значение указанной глобальной переменной

    • Запрос будет реализован в то хранилище, которое указано в переменной IsPublic

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioScenarioBaseСистемная переменная ScenarioСвязь
      IsPublicBooleanОбласть видимости глобальной переменнойСвязь/контрол
      KeyStringНазвание ключа (название глобальной переменной)Связь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна, если глобальная переменная создана/обновлена успешноСвязь
      FailedExecПоследовательность активна, если глобальная переменная создана/обновлена с ошибкойСвязь
      ResultWildcard any single/arrayЗначение переменной, которое будет возвращено по запросу. Тип указывается пользователем, в зависимости от того, какой тип был задан при созданииСвязь
      ResponseStringТекст ответа, в случае ошибкиСвязь

StorageRemoveKey

  • Тип функции: Impure

  • Описание:

    • Функция позволяет удалить глобальную переменную по ключу

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioScenarioBaseСистемная переменная ScenarioСвязь
      IsPublicBooleanОбласть видимости глобальной переменнойСвязь/контрол
      KeyStringНазвание ключа (название глобальной переменной)Связь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна, если глобальная переменная успешно удаленаСвязь
      FailedExecПоследовательность активна, если функция выполнилась с ошибкойСвязь
      ResponseStringТекст ответа, в случае ошибкиСвязь

    Если была попытка удалить несуществующую глобальную переменную, то это валидная операция (код 204) и вызов пойдет по пину Ok.

StorageKeyExists

  • Тип функции: Impure

  • Описание:

    • Функция позволяет определить наличие глобальной переменной с таким ключом с хранилище

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioScenarioBaseСистемная переменная ScenarioСвязь
      IsPublicBooleanОбласть видимости глобальной переменнойСвязь/контрол
      KeyStringНазвание ключа (название глобальной переменной)Связь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      ExistsExecПоследовательность активна, если глобальная переменная с таким ключом существует в указанном хранилищеСвязь
      NotExistsExecПоследовательность активна, если глобальная переменная с таким ключом не существует в указанном хранилищеСвязь
      FailedExecПоследовательность активна, если функция выполнилась с ошибкойСвязь
      ResponseStringТекст ответа, в случае ошибкиСвязь

Функции работы с планировщиком запуска сценариев

CreateSchedule

  • Тип функции: Impure

  • Описание:

    • Функция позволяет создать разовый запуск или расписание запусков текущего сценария

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioScenarioBaseСистемная переменная ScenarioСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      DescriptionStringОписание запускаСвязь/контрол
      TimeZoneStringУказание часового пояса в определенном формате. Если не указано - запуск будет произведен согласно серверному времени пространства. Пример формата: Europe/MoscowСвязь/контрол
      StartLaunchAtDateTimeOffsetДата первого запуска сценарияСвязь
      EndLaunchAtDateTimeOffsetДата, до которого длится расписание запускаСвязь
      DelayTimeInteger64Время (в миллисекундах), через которое будет выполнен запуск сценария по планировщику, без необходимости указывать дату StartLaunchAtСвязь/контрол
      CronStringРасписание запуска в CRON-формате. Если не задано будет произведен разовый запускСвязь
      BodyWildcard(any struct, dynamic array, dynamic single)Тело события, с которым будет произведен запуск сценарияСвязь/контрол
    • Outputs

      НазваниеТипОписаниеПараметры
      OutExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ScheduleStruct:ScheduleМодель созданного запланированного запуска/расписания запусковСвязь
      ResponseStruct:AutomatonResponseВозвращает результат запроса согласно модели AutomatonResponseСвязь