Типы блоков в конструкторе

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

  • Скрипт (code) — скрипт, выполняемый при запуске плейбука. Соответствует типу модуля script в плейбуке.

  • Цикл (refresh) — последовательность блоков с элементами, выполняемыми согласно конфигурации. Соответствует типу модуля forloop в плейбуке.

  • Цикл (с условием) (refresh) — последовательность блоков с элементами, выполняемыми до тех пор, пока выполняется заданное условие. Соответствует типу модуля whileloop в плейбуке.

  • Ветвление (git branch) — параллельное выполнение нескольких сценариев в блоке. Соответствует типу модуля all в плейбуке.

  • Ветвление (с условием) (git branch) — конкурентное выполнение нескольких сценариев в зависимости от заданного условия. Соответствует типу модуля case в плейбуке.

  • Ввод данных (audit) — интерактивное взаимодействие между пользователем и выполняемым плейбуком. Соответствует типу модуля userinput в плейбуке.

  • Подтверждение (keyboard) — перевод плейбука в режим ожидания перед выполнением определенного модуля. До тех пор, пока выполнение модуля не будет согласовано вручную, плейбук будет находиться в режиме ожидания.

Блок Скрипт

О блоке

В блоке Скрипт задается выполнение указанного пользователем скрипта.

Структура блока

Система добавляет в рабочую область конструктора блок Скрипт с выбранным скриптом, который будет выполняться в рамках этого блока.

Создание блока

Чтобы создать скрипт:

  1. Нажмите на кнопку plus на линии под блоком, от которого строится скрипт.

  2. В отобразившемся меню выберите команду Скрипт. Отобразится окно добавления скрипта.

  3. Добавьте скрипт. Для этого:

    1. Раскройте дерево каталогов в левой части окна и выберите каталог, который содержит нужный скрипт.

      Панель инструментов окна добавления скрипта включает в себя следующие компоненты:

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

      • Поле фильтра Теги позволяет задать комбинацию тегов искомых элементов.

    2. Выделите скрипт, который необходимо добавить в конструктор.

    3. Нажмите на кнопку Добавить. Система добавит в рабочую область блок Скрипт, содержащий выбранный скрипт.

  4. Выполните настройку скрипта.

Просмотр блока

При нажатии на блок справа отображается его карточка. В карточке блока, содержащего элемент плейбука Скрипт, доступны следующие вкладки:

Общее

На вкладке Общее отображается общая информация о блоке и скрипте:

  • Информация о блоке

    • ID блока — уникальный идентификатор блока, который автоматически создается системой. Используется первый свободный символ последовательности строчных букв латинского алфавита — a, b, c, d, …​.

      Если все символы из последовательности a, b, c, d, …​ уже заняты, в качестве идентификаторов используются сочетания символов aa, ab, ac, ad, …​ , az, aaa, aab, aac, …​ .

      Идентификатор не может содержать более 8 символов. После создания идентификатора zzzzzzzz будет использоваться последовательность a1, a2, …​ .

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

    • Название блока — по умолчанию отображается значение Скрипт.

    • Описание блока — сведения о блоке.

  • Информация о скрипте (отображается на основе метаданных скрипта)

    • ID скрипта — идентификатор скрипта.

    • Название скрипта — название, отражающее функцию скрипта.

    • Тип — тип элемента. Отображается значение Скрипт.

    • Описание скрипта — сведения о скрипте.

    • Пользователь (Автор) — сведения о пользователе, добавившем скрипт.

    • Версия — версия скрипта.

Аргументы

На вкладке Аргументы отображаются значения доступных в скрипте аргументов.

Настройки

На вкладке Настройки отображаются поля настроек скрипта.

Редактирование блока

Чтобы отредактировать блок:

  1. Выделите блок в рабочей области конструктора, нажав на него левой клавишей мыши. Карточка блока отобразится в рабочей области справа.

  2. В карточке блока нажмите на кнопку edit. Отобразится модальное окно редактирования блока.

  3. Отредактируйте информацию в разделах окна редактирования блока:

    • Информация о блоке

      Для редактирования в разделе доступно поле ID. Вы можете указать пользовательский ID вместо созданного системой. ID должен быть уникальным.

    • Аргументы

    • Настройки

      Для редактирования в разделе доступны поля:

  4. Нажмите на кнопку Сохранить.

Структура полей настроек скрипта
Конструктор (просмотр) Конструктор (редактирование) Код Значок настройки

Ожидание

Ознакомьтесь с описанием работы с полем.

Ожидание

Ознакомьтесь с описанием работы с полем.

sleep_secs

clock

Приоритет

Отображается текущий приоритет элемента.

Приоритет

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

Введите в поле Приоритетность значение от 1 (минимальная приоритетность) до 100 (максимальная приоритетность).

priority

Отладка

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

Отладка

Установите переключатель, чтобы ввести в поле Выражение на языке JavaScript значение, которое будет возвращено вместо фактического выполнения модуля.

mock

tool

Кэширование

Отображается время жизни кэша данных скрипта в секундах.

Кэширование результатов

Установите переключатель, чтобы ввести в поле Секунды время жизни кэша данных скрипта.

cache_ttl

Тайм-аут

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

Тайм-аут

Установите переключатель, чтобы ввести в поле Секунды максимальное время выполнения модуля.

timeout

Удаление результатов блока

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

Удаление результатов блока

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

delete_after_use

Продолжить выполнение при ошибке

Показывает, будет ли продолжено выполнение элемента при возникновении ошибки.

Продолжить выполнение при ошибке

Установите переключатель, чтобы при возникновении ошибки выполнение элемента продолжилось.

continue on error

Прервать выполнение

Ознакомьтесь с описанием работы с полем.

Прервать выполнение

Ознакомьтесь с описанием работы с полем.

stop_after_if

stop circle

Повторы при ошибке

Ознакомьтесь с описанием работы с полем.

Повторы при ошибке

Ознакомьтесь с описанием работы с полем.

retry

restore

Блок Цикл

О блоке

В блоке Цикл задается неоднократное выполнение заданной последовательности элементов плейбука.

Структура блока

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

  • Для создания блока в рамках цикла используйте кнопку plus на линии, расположенной под блоком цикла.

  • Для создания блока, который должен быть расположен в плейбуке после цикла, используйте кнопку plus на линии, выходящей с правой стороны блока Цикл.

Создание блоков в цикле

Чтобы создать блоки в цикле:

  1. Нажмите на кнопку plus на линии под блоком, от которого строится цикл.

  2. В отобразившемся меню выберите команду Цикл. Система добавит в рабочую область блок Цикл. Значение выполнения цикла передается в элемент, расположенный под циклом.

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

    Первый блок в рамках цикла создается от блока Цикл.

  4. Выполните настройку цикла.

Просмотр блока

При нажатии на блок справа отображается его карточка. В карточке блока, содержащего элемент плейбука Цикл, доступны следующие вкладки:

Общее

На вкладке Общее отображается общая информация о блоке и конфигурации цикла:

  • Информация о блоке

    • ID блока — уникальный идентификатор блока, который автоматически создается системой. Используется первый свободный символ последовательности строчных букв латинского алфавита — a, b, c, d, …​.

      Если все символы из последовательности a, b, c, d, …​ уже заняты, в качестве идентификаторов используются сочетания символов aa, ab, ac, ad, …​ , az, aaa, aab, aac, …​ .

      Идентификатор не может содержать более 8 символов. После создания идентификатора zzzzzzzz будет использоваться последовательность a1, a2, …​ .

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

    • Название блока. По умолчанию отображается значение Цикл.

    • Описание блока

  • Конфигурация цикла

    Ознакомьтесь со структурой полей конфигурации цикла.

Настройки

На вкладке Настройки отображаются настройки цикла.

Редактирование блока

Чтобы отредактировать блок:

  1. Выделите блок в рабочей области конструктора, нажав на него левой клавишей мыши. Карточка блока отобразится в рабочей области справа.

  2. В карточке блока нажмите на кнопку edit. Отобразится модальное окно редактирования блока.

  3. Отредактируйте информацию в разделах окна редактирования блока:

    • Информация

      Для редактирования в разделе доступно поле ID. Вы можете указать пользовательский ID вместо ID, созданного системой. Он должен быть уникальным.

    • Конфигурация цикла

      Ознакомьтесь со структурой полей конфигурации цикла.

    • Настройки

      Для редактирования доступны поля:

  4. Нажмите на кнопку Сохранить.

Структура полей конфигурации цикла
Конструктор (просмотр) Конструктор (редактирование) Код Значок настройки

Пропускать неудачи

Показывается, будет ли возобновляться выполнение цикла при ошибке.

Пропускать неудачи

Установите переключатель, чтобы, если при выполнении какого-либо модуля в цикле возникнет ошибка, выполнение цикла начиналось с новой итерации.

skip_failures

move to

Выражение для повторов

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

Выражение для повторов

Задайте выражение на языке JavaScript, которое при выполнении возвращает значения аргументов для итерации.

iterator

Параллельное выполнение

Показывается количество параллельных выполнений итераций цикла

Параллельное выполнение

Установите переключатель, чтобы итерации цикла выполнялись параллельно. В поле Ограничения количества итераций укажите количество параллельных выполнений итераций цикла.

parallelism

move
Структура полей настроек цикла
Конструктор (просмотр) Конструктор (редактирование) Код Значок настройки

Ожидание

Ознакомьтесь с описанием работы с полем.

Ожидание

Ознакомьтесь с описанием работы с полем.

sleep_secs

clock

Отладка

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

Отладка

Установите переключатель, чтобы задать выражение, значение которого будет возвращено системой вместо фактического выполнения блока.

mock

tool

Удаление результатов блока

Показывается, будет ли удалено значение, возвращаемое системой после выполнения блока.

Удалять результаты блока

Установите переключатель, чтобы удалять значение, возвращаемое системой после выполнения блока.

delete_after_use

Прервать выполнение

Ознакомьтесь с описанием работы с полем.

Прервать выполнение

Ознакомьтесь с описанием работы с полем.

stop_after_if

stop circle

Продолжить выполнение при ошибке

Показывает, будет ли продолжено выполнение элемента при возникновении ошибки.

Продолжить выполнение при ошибке

Установите переключатель, чтобы при возникновении ошибки выполнение элемента продолжилось.

continue on error

Повторы при ошибке

Ознакомьтесь с описанием работы с полем.

Повторы при ошибке

Ознакомьтесь с описанием работы с полем.

retry

restore

Тайм-аут

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

Тайм-аут

Установите переключатель, чтобы ввести в поле Секунды максимальное время выполнения модуля.

timeout

Блок Цикл (с условием)

О блоке

В блоке Цикл (с условием) задается выполнение заданной последовательности элементов плейбука при соблюдении определенного условия. Выполнение останавливается:

  • Если выполняется условие прерывания цикла.

  • Если вы нажимаете на кнопку остановки запуска в разделе Запуски.

Структура блока

При создании цикла система добавляет в рабочую область блок Цикл (с условием), который используется для настройки самого цикла.

  • Для создания блока в рамках цикла используйте кнопку plus на линии под блоком Цикл.

  • Для создания блока, который будет расположен в плейбуке после цикла, используйте кнопку plus на линии, выходящей с правой стороны блока Цикл (с условием).

Создание блоков в цикле (с условием)

Чтобы создать блоки в цикле (с условием):

  1. Нажмите на кнопку plus на линии под блоком, от которого строится цикл.

  2. В отобразившемся меню выберите команду Цикл (с условием). Система добавит в рабочую область блок Цикл (с условием). Значение выполнения цикла передается в элемент, расположенный под циклом.

  3. Создайте последовательность блоков, выполняемых в рамках цикла, нажимая на кнопку plus под блоком, к которому вы хотите присоединить новый блок. Первый блок в рамках цикла создается от блока Цикл. Таким образом, вы можете сформировать требуемую структуру цикла, добавив в него блоки нужного типа.

  4. Выполните настройку цикла.

Просмотр блока

При нажатии на блок его карточка отображается справа. В карточке блока, содержащего элемент плейбука Цикл (с условием), доступны следующие вкладки:

Вкладка Общее

На вкладке Общее отображается общая информация о блоке цикла:

  • Информация о блоке

    • ID блока — уникальный идентификатор блока, который автоматически создается системой. Используется первый свободный символ последовательности строчных букв латинского алфавита — a, b, c, d, …​.

      Если все символы из последовательности a, b, c, d, …​ уже заняты, в качестве идентификаторов используются сочетания символов aa, ab, ac, ad, …​ , az, aaa, aab, aac, …​ .

      Идентификатор не может содержать более 8 символов. После создания идентификатора zzzzzzzz будет использоваться последовательность a1, a2, …​ .

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

    • Название блока. По умолчанию отображается значение Цикл (с условием).

    • Описание блока

Вкладка Настройки

На вкладке Настройки отображаются настройки цикла.

Редактирование блока

Чтобы отредактировать блок:

  1. Выделите блок в рабочей области конструктора, нажав на него левой клавишей мыши. Карточка блока отобразится справа.

  2. В карточке блока нажмите на кнопку edit. Отобразится модальное окно редактирования блока.

  3. Отредактируйте информацию в разделах окна редактирования блока:

    • Информация о блоке

      Для редактирования в разделе доступно поле ID. Вы можете указать пользовательский ID вместо ID, созданного системой. Он должен быть уникальным.

    • Настройки

      Для редактирования доступно поле Название блока.

    • Поля настроек цикла.

  4. Нажмите на кнопку Сохранить.

Структура полей настроек цикла (с условием)
Конструктор (просмотр) Конструктор (редактирование) Код Значок настройки

Пропускать неудачи

Показывает, возобновится ли выполнение цикла при ошибке с новой итерации или прервется.

Пропускать неудачи

Установите переключатель, чтобы, если при выполнении какого-либо модуля в цикле возникнет ошибка, выполнение цикла начиналось с новой итерации.

skip_failures

move to

Ожидание

Ознакомьтесь с описанием работы с полем.

Ожидание

Ознакомьтесь с описанием работы с полем.

sleep_secs

clock

Отладка

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

Отладка

Установите переключатель, чтобы задать выражение, значение которого будет возвращено системой вместо фактического выполнения блока.

mock

tool

Удаление результатов блока

Показывается, будет ли удалено значение, возвращаемое системой после выполнения блока.

Удалять результаты блока

Установите переключатель, чтобы удалять значение, возвращаемое системой после выполнения блока.

delete_after_use

Приоритет

Отображается текущий приоритет элемента.

Приоритет

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

Введите в поле Приоритетность значение от 1 (минимальная приоритетность) до 100 (максимальная приоритетность).

priority

Кэширование

Отображается время жизни кэша данных шага в секундах.

Кэширование результатов

Установите переключатель, чтобы ввести в поле Секунды время жизни кэша данных шага.

cache_ttl

Тайм-аут

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

Тайм-аут

Установите переключатель, чтобы ввести в поле Секунды максимальное время выполнения модуля.

timeout

Прервать выполнение Ознакомьтесь с описанием работы с полем.

Прервать выполнение

Ознакомьтесь с описанием работы с полем.

stop_after_if

stop circle

Продолжить выполнение при ошибке

Показывает, будет ли продолжено выполнение элемента при возникновении ошибки.

Продолжить выполнение при ошибке

Установите переключатель, чтобы при возникновении ошибки выполнение элемента продолжилось.

continue on error

Повторы при ошибке

Ознакомьтесь с описанием работы с полем.

Повторы при ошибке

Ознакомьтесь с описанием работы с полем.

retry

restore

Блок Ветвление

О блоке

В блоке Ветвление задается параллельное выполнение сценариев. Система создает в рабочей области блок Ветвление, ниже которого располагаются соединенные параллельно блоки сценариев. Вы можете создавать в рабочей области требуемое количество блоков сценариев. Результатом выполнения блока является список результатов каждого сценария.

Блоки сценариев содержат набор шагов, которые будут выполняться параллельно.

Структура блока

При создании ветвления система добавляет в рабочую область конструктора следующие блоки:

  • Блок Ветвление — используется для настройки ветвления;

  • Блок Сценарий 1;

  • Блок Сценарий 2.

Система создает ветвление, присоединяя к блоку Ветвление снизу блоки сценариев, соединенные параллельно.

Создание ветвления

Чтобы создать ветвление:

  1. Нажмите на кнопку plus под блоком, после которого будет выполняться сценарий из ветвления.

  2. Выберите команду Ветвление в отобразившемся меню. Система добавит в рабочую область блок Ветвление, соединенный с расположенными ниже и связанными параллельно блоками Сценарий 1 и Сценарий 2.

  3. Для добавления нового блока со сценарием в ветвление нажмите на кнопку add branch под блоком Ветвление. Система добавит блок ниже блока Ветвление и соединит его параллельно с существующими блоками сценариев.

  4. Выполните настройку блока Ветвление.

Работа с блоком Ветвление

Просмотр блока

Чтобы просмотреть блок Ветвление, нажмите на него. Карточка блока отобразится в правой части экрана. В карточке блока доступны следующие вкладки:

Вкладка Общее

На вкладке Общее отображается общая информация о блоке.

  • Информация о блоке

    • ID блока — уникальный идентификатор блока, который автоматически создается системой. Используется первый свободный символ последовательности строчных букв латинского алфавита — a, b, c, d, …​.

      Если все символы из последовательности a, b, c, d, …​ уже заняты, в качестве идентификаторов используются сочетания символов aa, ab, ac, ad, …​ , az, aaa, aab, aac, …​ .

      Идентификатор не может содержать более 8 символов. После создания идентификатора zzzzzzzz будет использоваться последовательность a1, a2, …​ .

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

    • Название блока. По умолчанию отображается значение Ветвление.

    • Описание блока.

Вкладка Настройки

На вкладке Настройки отображаются настройки блока Ветвление.

Редактирование блока Ветвление

Чтобы отредактировать блок Ветвление:

  1. Выделите блок в рабочей области конструктора. Карточка блока отобразится в правой части экрана.

  2. В карточке блока нажмите на кнопку edit. Отобразится модальное окно редактирования блока.

  3. Отредактируйте информацию в разделах окна редактирования блока Информация и Настройки:

    • Информация

      Для редактирования в разделе доступно поле ID. Вы можете указать пользовательский ID вместо ID, созданного системой. Он должен быть уникальным.

    • Настройки

      Для редактирования доступны следующие поля:

  4. Нажмите на кнопку Сохранить. Информация будет сохранена.

Структура полей настроек ветвления
Конструктор (просмотр) Конструктор (редактирование) Код Значок настройки

Параллельное выполнение

Отображается индикатор, определяющий, разрешено ли параллельное выполнение блоков сценариев в ветвлении.

Параллельное выполнение

Установите переключатель, чтобы разрешить параллельное выполнение блоков сценариев в ветвлении.

parallel

Прервать выполнение

Ознакомьтесь с описанием работы с полем.

Прервать выполнение

Ознакомьтесь с описанием работы с полем.

stop_after_if

stop circle

Ожидание

Ознакомьтесь с описанием работы с полем.

Ожидание

Ознакомьтесь с описанием работы с полем.

sleep_secs

Отладка

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

Отладка

Установите переключатель, чтобы задать выражение, значение которого будет возвращено системой вместо фактического выполнения блока.

mock

tool

Удаление результатов блока

Показывается, будет ли удалено значение, возвращаемое системой после выполнения блока.

Удаление результатов блока

Установите переключатель, чтобы удалять значение, возвращаемое системой после выполнения блока.

delete_after_use

Приоритет

Отображается текущий приоритет элемента.

Приоритет

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

Введите в поле Приоритетность значение от 1 (минимальная приоритетность) до 100 (максимальная приоритетность).

priority

Кэширование

Отображается время жизни кэша данных шага в секундах.

Кэширование результатов

Установите переключатель, чтобы ввести в поле Секунды время жизни кэша данных шага.

cache_ttl

Тайм-аут

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

Тайм-аут

Установите переключатель, чтобы ввести в поле Секунды максимальное время выполнения модуля.

timeout

Продолжить выполнение при ошибке

Показывает, будет ли продолжено выполнение элемента при возникновении ошибки.

Продолжить выполнение при ошибке

Установите переключатель, чтобы при возникновении ошибки выполнение элемента продолжилось.

continue on error

Повторы при ошибке

Ознакомьтесь с описанием работы с полем.

Повторы при ошибке

Ознакомьтесь с описанием работы с полем.

retry

restore

Работа с блоком сценария

Просмотр блока

Чтобы просмотреть блок сценария, нажмите на блок. Карточка блока отобразится в правой части экрана.

На карточке отображается общая информация о сценарии, который содержится в блоке:

  • Информация о сценарии

    • ID блока — уникальный идентификатор блока, который автоматически создается системой. Используется первый свободный символ последовательности строчных букв латинского алфавита — a, b, c, d, …​.

      Если все символы из последовательности a, b, c, d, …​ уже заняты, в качестве идентификаторов используются сочетания символов aa, ab, ac, ad, …​ , az, aaa, aab, aac, …​ .

      Идентификатор не может содержать более 8 символов. После создания идентификатора zzzzzzzz будет использоваться последовательность a1, a2, …​ .

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

      Идентификаторы определяют последовательность добавления блоков сценариев. Например, блок с идентификатором b добавляется ранее блока с идентификатором с.

    • Название сценария — название сценария, указанное пользователем. Если не указано, по умолчанию используется значение Сценарий.

    • Описание блока — описание сценария, указанное пользователем.

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

    • Пропускать неудачные попытки — индикатор, определяющий, будет ли возобновлено выполнение блока сценария при ошибке.

Редактирование блока

Чтобы отредактировать блок сценария:

  1. Выделите блок в рабочей области конструктора, нажав на него левой клавишей мыши. Карточка блока отобразится в правой части экрана.

  2. В карточке блока нажмите на кнопку edit. Отобразится модальное окно редактирования блока.

  3. Отредактируйте следующую информацию в окне редактирования блока:

    • ID — поле позволяет указать пользовательский ID вместо ID, созданного системой. Он должен быть уникальным.

    • Название блока —  введите название сценария. По умолчанию используется значение Сценарий.

    • Описание сценария —  введите описание сценария.

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

    • Параллельное выполнение — установите переключатель, чтобы разрешить выполнение блока сценария параллельно с другими блоками.

Блок Ветвление (с условием)

О блоке

В блоке Ветвление с условием задается конкурентное выполнение одного из нескольких сценариев по заданному условию. Система создает в рабочей области блок Ветвление (с условием), ниже которого располагаются соединенные параллельно блок конкурентного сценария и блок сценария, выполняемого по умолчанию. Вы можете создавать в рабочей области требуемое количество блоков конкурентных сценариев.

Блоки конкурентных сценариев содержат сценарии и выражения, определяющие условия их выполнения. Система использует следующую логику выбора сценария для выполнения:

  • Если выражение в блоке возвращает значение Истина, выполняется сценарий в этом блоке.

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

Блок Сценарий 1 выполняется, если выражения во всех блоках конкурентных сценариев возвращают значение Ложь.

Структура блока

При создании ветвления система добавляет в рабочую область конструктора следующие блоки:

  • Блок Ветвление (с условием) — используется для настройки ветвления. От этого блока система создает ветвление, присоединяя к нему ниже следующие блоки, соединенные параллельно:

  • Блок Сценарий 1 — используется для хранения сценария, который будет выполняться, если выражения во всех блоках конкурентных сценариев возвращают значение Ложь.

  • Блоки Сценарий 2, Сценарий 3, …​, Сценарий n — используются для хранения сценариев, которые будут выполняться, если выражение в этом блоке принимает значение Истина.

Создание ветвления (с условием)

Чтобы создать ветвление:

  1. Нажмите на кнопку plus под блоком, после которого будет выполняться сценарий из ветвления.

  2. В отобразившемся меню выберите команду Ветвление (с условием). Система добавит в рабочую область блок Ветвление (с условием), соединенный с расположенными ниже и связанными параллельно блоками:

    • Сценарий 1 — сценарий по умолчанию.

    • Сценарий 2 — конкурентный сценарий.

  3. Если необходимо добавить другие конкурентные сценарии в развилку, нажмите на кнопку add branch под блоком Ветвление (с условием).

  4. Выполните настройку блока Ветвление (с условием) и блоков сценариев.

Работа с блоком Ветвление (с условием)

Просмотр блока

При нажатии на блок справа отображается его карточка. В карточке блока, содержащего элемент плейбука Ветвление, доступны вкладки Общее и Настройки.

Вкладка Общее

На вкладке Общее отображается общая информация о блоке и конфигурации цикла:

  • Информация о блоке

    • ID блока — уникальный идентификатор блока, который автоматически создается системой. Используется первый свободный символ последовательности строчных букв латинского алфавита — a, b, c, d, …​.

      Если все символы из последовательности a, b, c, d, …​ уже заняты, в качестве идентификаторов используются сочетания символов aa, ab, ac, ad, …​ , az, aaa, aab, aac, …​ .

      Идентификатор не может содержать более 8 символов. После создания идентификатора zzzzzzzz будет использоваться последовательность a1, a2, …​ .

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

    • Название блока. По умолчанию отображается значение Ветвление.

    • Описание блока.

Вкладка Настройки

На вкладке отображаются настройки блока Ветвление (с условием).

Редактирование блока Ветвление (с условием)

Чтобы отредактировать блок Ветвление (с условием):

  1. Выделите блок в рабочей области конструктора, нажав на него левой клавишей мыши. Карточка блока отобразится в рабочей области справа.

  2. В карточке блока нажмите на кнопку edit. Отобразится модальное окно редактирования блока.

  3. Отредактируйте информацию в разделах окна редактирования блока Информация и Настройки:

    • Информация

      Для редактирования в разделе доступно поле ID. Вы можете указать пользовательский ID вместо ID, созданного системой. Он должен быть уникальным.

    • Настройки

      Для редактирования доступны следующие поля:

  4. Нажмите на кнопку Сохранить. Информация будет сохранена.

Структура полей настроек ветвления
Конструктор (просмотр) Конструктор (редактирование) Код Значок настройки

Прервать выполнение

Ознакомьтесь с описанием работы с полем.

Прервать выполнение

Ознакомьтесь с описанием работы с полем.

stop after if

stop circle

Ожидание

Ознакомьтесь с описанием работы с полем.

Ожидание

Ознакомьтесь с описанием работы с полем.

sleep_secs

Отладка

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

Отладка

Установите переключатель, чтобы задать выражение, значение которого будет возвращено системой вместо фактического выполнения блока.

mock

tool

Удаление результатов блока

Показывается, будет ли удалено значение, возвращаемое системой после выполнения блока.

Удалять результаты блока

Установите переключатель, чтобы удалять значение, возвращаемое системой после выполнения блока.

delete_after_use

Приоритет

Отображается текущий приоритет элемента.

Приоритет

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

Введите в поле Приоритетность значение от 1 (минимальная приоритетность) до 100 (максимальная приоритетность).

priority

Кэширование

Отображается время жизни кэша данных скрипта в секундах.

Кэширование результатов

Установите переключатель, чтобы ввести в поле Секунды время жизни кэша данных скрипта.

cache_ttl

Тайм-аут

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

Тайм-аут

Установите переключатель, чтобы ввести в поле Секунды максимальное время выполнения модуля.

timeout

Продолжить выполнение при ошибке

Показывает, будет ли продолжено выполнение элемента при возникновении ошибки.

Продолжить выполнение при ошибке

Установите переключатель, чтобы при возникновении ошибки выполнение элемента продолжилось.

continue on error

Повторы при ошибке

Ознакомьтесь с описанием работы с полем.

Повторы при ошибке

Ознакомьтесь с описанием работы с полем.

retry

restore

Работа с блоком сценария

Просмотр блока

При нажатии на блок справа отображается его карточка. В карточке отображается общая информация о сценарии, который содержится в блоке:

  • Информация о сценарии

    • ID блока — уникальный идентификатор блока, который автоматически создается системой. Используется первый свободный символ последовательности строчных букв латинского алфавита — a, b, c, d, …​.

      Если все символы из последовательности a, b, c, d, …​ уже заняты, в качестве идентификаторов используются сочетания символов aa, ab, ac, ad, …​ , az, aaa, aab, aac, …​ .

      Идентификатор не может содержать более 8 символов. После создания идентификатора zzzzzzzz будет использоваться последовательность a1, a2, …​ .

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

    • Название сценария — название сценария, указанное пользователем. Если оно не указано, по умолчанию используется значение Сценарий.

    • Описание блока — описание блока, указанное пользователем.

    • Условие — выражение на языке JavaScript, результат которого определяет, будет ли выполнен этот сценарий.

      Условие не отображается для Сценария 1, используемого по умолчанию.

Редактирование блока сценария

Чтобы отредактировать блок сценария:

  1. Выделите блок в рабочей области конструктора, нажав на него левой клавишей мыши. Карточка блока отобразится справа.

  2. В карточке блока нажмите на кнопку edit. Отобразится модальное окно редактирования блока.

  3. Отредактируйте следующую информацию в окне редактирования блока:

    • ID — поле позволяет указать пользовательский ID вместо ID, созданного системой. Он должен быть уникальным.

      Идентификаторы определяют последовательность добавления блоков сценариев. Например, блок b добавляется ранее блока с.

    • Название блока —  введите название сценария. По умолчанию используется значение Сценарий.

    • Условие сценария на языке JavaScript — введите выражение на языке JavaScript, результат которого определяет, будет ли выполнен этот сценарий.

Блок Ввод данных

О блоке

В блоке этого типа настраивается интерактивное взаимодействие между пользователем и выполняемым плейбуком.

Структура блока

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

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

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

Создание блока

Чтобы создать блок Ввод данных:

  1. Нажмите на кнопку plus на линии под блоком, от которого строится блок ввода данных.

  2. В отобразившемся меню выберите команду Ввод данных. Система добавит в рабочую область блок Ввод данных.

  3. Выполните настройку блока.

Просмотр блока

При нажатии на блок справа отображается его карточка. В карточке блока, содержащего элемент плейбука Ввод данных, отображается общая информация о блоке и форме ввода:

  • Информация о блоке

    • ID блока — уникальный идентификатор блока, который автоматически создается системой. Используется первый свободный символ последовательности строчных букв латинского алфавита — a, b, c, d, …​.

      Если все символы из последовательности a, b, c, d, …​ уже заняты, в качестве идентификаторов используются сочетания символов aa, ab, ac, ad, …​ , az, aaa, aab, aac, …​ .

      Идентификатор не может содержать более 8 символов. После создания идентификатора zzzzzzzz будет использоваться последовательность a1, a2, …​ .

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

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

    • Описание блока — сведения о блоке.

    • Время ожидания ввода данных (сек) — время ожидания ввода данных в отображаемое модальное окно в секундах.

  • Форма ввода

    • Заголовок — отображаемый заголовок формы ввода данных.

    • Подзаголовок — сообщение или подсказка в форме ввода данных.

    • Кнопка подтверждения действия — название действия, выполняемого при нажатии на кнопку подтверждения.

    • Кнопка отмены действия — название действия, выполняемого при нажатии на кнопку отмены.

  • Структура формы ввода (YAML) — описание полей формы ввода данных, определяющих ее отображение и поведение, в формате YAML.

Редактирование блока

Чтобы отредактировать блок:

  1. Выделите блок в рабочей области конструктора, нажав на него левой клавишей мыши. Карточка блока отобразится в рабочей области справа.

  2. В карточке блока нажмите на кнопку edit. Отобразится модальное окно редактирования блока.

  3. Отредактируйте информацию в разделах окна редактирования блока:

    • Информация о блоке

      В поле ID вы можете указать пользовательский ID блока вместо созданного системой. ID должен быть уникальным.

      • Название блока — введите название блока

      • Описание — введите описание блока.

      • Время ожидания ввода данных (сек) — отредактируйте данные в соответствии со структурой полей.

    • Форма ввода

      • Заголовок — введите заголовок формы.

      • Подзаголовок — введите сообщение или подсказку для пользователя.

      • Кнопка подтверждения действия — введите название действия, выполняемого при нажатии на кнопку подтверждения.

      • Кнопка отмены действия — введите название действия, выполняемого при нажатии на кнопку отмены.

        Максимальное количество символов в названиях кнопок — 20. Допустимы строчные и прописные буквы латинского и кириллического алфавитов.

      • Структура (YAML) — переведите переключатель в активное положение, чтобы отредактировать структуру данных в окне. Она позволяет отобразить определенное поле для взаимодействия с пользователем.

  4. Нажмите на кнопку Сохранить.

Структура полей настроек блока ввода данных
Конструктор (просмотр) Конструктор (редактирование) Код Значок настройки

Время ожидания ввода данных (сек)

Отображается время ожидания в секундах.

Время ожидания ввода данных (сек)

Укажите время ожидания ввода данных в отображаемое модальное окно в секундах. Если за указанный интервал времени данные не будут введены, система закроет окно ввода данных.

timeout_sec
Пример использования блока Ввод данных

В этом примере мы вводим параметры блока и создаем форму взаимодействия системы с пользователем. При поступлении в систему критического инцидента отобразится форма ввода с заголовком Детали критического инцидента и следующим запросом на действие пользователя: Укажите сведения для экстренного реагирования.

Предполагается, что блоку предшествует блок ветвления (с условием). Блок содержит сценарий, обрабатывающий в данной ветке только критические инциденты.

Поля создаваемой формы:

  • Источник атаки — позволяет указать источник атаки, связанный с инцидентом.

  • Рекомендуемые действия — в этом выпадающем списке доступны следующие значения:

    • Немедленная блокировка;

    • Усиленный мониторинг;

    • Эскалация руководству.

Кнопки создаваемой формы:

  • Начать;

  • Отложить.

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

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

Результаты могут быть статичными или в виде выражения JavaScript. При соответствующей настройке сформированный комментарий будет отображен в карточке инцидента.

Настройки блока ввода данных:

Поле блока Значение

Время ожидания ввода данных (сек)

300

Заголовок

Детали критического инцидента

Подзаголовок

Укажите сведения для экстренного реагирования

Кнопка подтверждения действия

Начать

Кнопка отмены действия

Отложить

Структура (YAML) формы ввода:

properties:
  attack source:
    type: string
    tooltip: Основной идентификатор источника угрозы
    name: Источник атаки
    required: true
  recommended actions:
    type: enum
    tooltip: Рекомендуемые действия
    name: Рекомендуемые действия
    required: true
    enum_labels:
      - Немедленная блокировка
      - Усиленный мониторинг
      - Эскалация руководству

Блок Подтверждение

О блоке

Блок Подтверждение позволяет перед выполнением определенного модуля перевести плейбук в режим ожидания. Плейбук останется в этом режиме до ручного согласования выполнения модуля или до истечения времени ожидания. Запрос на выполнение необходимо согласовать или отклонить в разделе Автоматизация → Резолюции.

Структура блока

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

Просмотр блока

При нажатии на блок справа отображается его карточка. В карточке блока, содержащего элемент плейбука Подтверждение, отображается информация о блоке и время ожидания подтверждения.

  • Информация о блоке

    • ID блока — уникальный идентификатор блока, который автоматически создается системой. Используется первый свободный символ последовательности строчных букв латинского алфавита — a, b, c, d, …​.

      Если все символы из последовательности a, b, c, d, …​ уже заняты, в качестве идентификаторов используются сочетания символов aa, ab, ac, ad, …​ , az, aaa, aab, aac, …​ .

      Идентификатор не может содержать более 8 символов. После создания идентификатора zzzzzzzz будет использоваться последовательность a1, a2, …​ .

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

    • Название блока — по умолчанию отображается значение Подтверждение.

    • Сообщение — сообщение, обращенное к пользователю в рамках процесса подтверждения.

    • Время ожидания подтверждения — время в секундах, в течение которого ожидается подтверждение выполнения модуля.

Редактирование блока

Чтобы отредактировать блок:

  1. Выделите блок в рабочей области конструктора, нажав на него левой клавишей мыши. Карточка блока отобразится справа.

  2. В карточке блока нажмите на кнопку Редактировать (edit). Отобразится модальное окно редактирования блока.

  3. Отредактируйте информацию в разделах окна редактирования блока:

    • Информация

      Для редактирования в разделе доступно поле ID. Вы можете указать пользовательский ID вместо ID, созданного системой. Он должен быть уникальным.

      Также можно отредактировать название блока.

    • Настройки

      Для редактирования доступны поля:

      • Сообщение — сообщение, обращенное к пользователю в рамках процесса подтверждения.

      • Время ожидания подтверждения.

  4. Нажмите на кнопку Сохранить.

Пример использования

При поступлении в систему информации о критическом инциденте требуется согласование обработки инцидента дежурным специалистом.

Предполагается, что блоку предшествует блок ветвления (с условием). Блок содержит сценарий, обрабатывающий в данной ветке только критические инциденты.

В плейбуке создается блок со следующими параметрами:

Поле блока Значение

Название блока

Согласование обработки критического инцидента

Сообщение

Требуется согласование! Подтвердите начало обработки критического инцидента.

Время ожидания подтверждения

01:00:00

При поступлении в систему инцидента со статусом Критический у дежурного менеджера в разделе Автоматизация → Резолюции отобразится сообщение о поступившем задании на согласование. Выполнение плейбука будет приостановлено до момента согласования обработки инцидента дежурным менеджером.

Работа с полями "Ожидание", "Повторы при ошибке" и "Прервать выполнение"

Описание работы с полем "Ожидание"

  • В режиме Просмотр:

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

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

  • В режиме Редактирование:

    Установите переключатель, чтобы ввести время ожидания перед началом выполнения модуля.

    • Выберите в поле Тип данных значение JavaScript, чтобы ввести выражение на языке JavaScript.

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

Описание работы с полем "Повторы при ошибке"

  • В режиме Просмотр:

    • В разделе Статические повторы отображается количество попыток выполнения элемента и интервал между ними.

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

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

  • В режиме Редактирование:

    • Установите переключатель, чтобы настроить повторы выполнения элемента:

      • Установите флажок Статические повторы, чтобы настроить повторы через фиксированный интервал:

      • Укажите в поле Попытки количество повторных попыток выполнения элемента.

      • Укажите в поле Интервал интервал между попытками выполнения в секундах.

    • Установите флажок Возрастающие повторы, чтобы настроить гибко заданное количество повторов:

      • Укажите в поле Попытки количество попыток выполнения элемента.

      • Укажите в поле Попытки количество попыток выполнения элемента.

      • В поле Множитель укажите множитель, определяющий фактический интервал между попытками выполнения элемента.

      • Укажите в поле Интервал базовый интервал между попытками выполнения элемента.

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

Описание работы с полем "Прервать выполнение"

  • В режиме Просмотр:

    Отображается выражение, определяющее остановку выполнения всех последующих модулей.

  • В режиме Редактирование:

    Установите переключатель, чтобы прервать выполнение всех последующих модулей.

    • Введите в поле выражение, которое вернет значение, определяющее остановку выполнения процесса.

    • Если флажок Помечать блок как "Пропущенный" установлен, прерванное задание отобразится в разделе Запуски и будет иметь статус Пропущено.

Была ли полезна эта страница?

+7 (499) 755 55 70 sales@rvision.ru

О компании Пользовательское соглашение Политика cookies

Обратная связь