Конструктор плейбуков

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

О конструкторе плейбуков

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

Вкладка Код.

С помощью этого редактора плейбук создается в файле. В файл добавляются элементы плейбука в формате YAML — модули. Система отображает шаблон с полями, которые нужно заполнить для описания работы плейбука. Система отображает шаблон с полями, которые нужно заполнить для описания работы плейбука.
Вкладка Конструктор.

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

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

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

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

Таблица шагов создания плейбука в редакторах
Шаг	Код	Конструктор
Ввод метаданных плейбука	Набор полей метаданных	Вкладка Информация в панели настроек плейбука
Задание настроек выполнения плейбука	Набор полей настроек	Вкладка Настройки в панели настроек плейбука
Задание настроек модуля обработки ошибок	Поле `failure-module`	Панель обработки ошибок плейбука
Ввод входных аргументов	Поле `input`	Блок Вход
Добавление элементов плейбука	Поле `modules`	Блоки плейбука, созданные пользователем

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

Укажите метаданные плейбука.
Задайте настройки выполнения плейбука.
При необходимости:
1. настройте обработку ошибок в плейбуке.
2. введите входные аргументы плейбука.
Создайте в рабочей области конструктора блоки для хранения элементов плейбука и настройте их.

В конструкторе доступны следующие типы блоков:

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

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

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

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

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

Кнопка позволяет отобразить в правой части экрана панель Настройки, где вы можете:
- добавить в плейбук описание метаданных;
- задать настройки выполнения плейбука;
- просмотреть метаданные и настройки плейбука.
Кнопка позволяет позволяет отобразить панель настроек модуля обработки ошибок плейбука для их просмотра и редактирования.

Работа с конструктором плейбуков

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

— переход в полноэкранный режим.
— скрытие и отображение карты блоков плейбука в нижней части рабочей области.
— увеличение масштаба.
— уменьшение масштаба.
100% — возвращение к масштабу 100%.

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

Вход — блок, в котором при необходимости задаются входные аргументы плейбука.
Результат — блок с результатами выполнения плейбука. Не требует настройки.

Другие блоки создаются в конструкторе вручную.

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

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

Работа с блоками, хранящими элементы плейбука, и настройками плейбука

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

Доступные операции над блоками:

создание;
просмотр;
редактирование;
удаление.

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

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

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

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

Создание блока включает следующие шаги:

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

Добавление блока

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

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

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

Удаление блока

Чтобы удалить блок:

Выделите блок, нажав на него. Карточка блока отобразится справа.
В карточке блока нажмите на кнопку .
Подтвердите удаление, нажав на кнопку Удалить. Блок будет удален.

Вы также можете удалить блок, наведя на него курсор мыши и выбрав команду Удалить ( trash

) из отобразившегося меню действий more vertical

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

Режим просмотра в конструкторе плейбуков

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

В блоках Вход и Результат отображаются их названия. Во всех остальных блоках отображаются их названия и идентификаторы.

Просмотр блока Вход

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

Название — название аргумента. Отображается только для аргумента типа "объект".
Описание — описание аргумента.
Тип данных — тип данных аргумента.

Значение по умолчанию — значение, которое аргумент принимает по умолчанию.

Для аргумента типа "объект" значение вводится в формате JSON-строки.
Для аргумента типа "файл" значение недоступно.

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

Просмотр блока Результат

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

Просмотр блока, хранящего элемент плейбука

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

Набор вкладок в карточке блока зависит от элемента плейбука в этом блоке. Как правило, карточка блока включает вкладки Общее и Настройки:

Общее — отображает базовую информацию о блоке.
Настройки — отображает настройки элемента плейбука.

Чтобы закрыть карточку, нажмите на крестик в верхнем правом углу.

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

Значки включенных настроек можно просмотреть в таблицах структур полей настроек.

Ошибки при отображении плейбука в конструкторе:

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

Просмотр метаданных плейбука

Просмотреть метаданные плейбука можно в панели настроек на вкладке Информация. Панель отображается при нажатии кнопки settings в правой верхней части экрана.

Ознакомьтесь со структурой полей метаданных плейбука.

Просмотр настроек выполнения плейбука

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

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

Режим редактирования в конструкторе плейбуков

В режиме редактирования можно отредактировать данные в конструкторе.

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

В блоке конструктора Вход хранятся входные аргументы плейбука.

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

Выделите блок Вход в рабочей области конструктора. В правой части экрана отобразится карточка блока.
В карточке блока нажмите на кнопку . Отобразится модальное окно редактирования блока.
Нажмите на кнопку Добавить.
Заполните поля входного аргумента плейбука:
- Название — название аргумента.
- Описание — описание аргумента.
- Выберите из выпадающего списка тип данных аргумента.
- В поле Значение по умолчанию введите значение аргумента, используемое по умолчанию.
  
  Поле не отображается при вводе аргументов типов "файл" и "объект".

Для аргумента типа "объект" вы можете ввести значение объекта по умолчанию в формате JSON или добавить схему конфигурации к аргументу:

Чтобы добавить значение объекта по умолчанию, используйте поле Значение, object.

Чтобы добавить схему конфигурации к аргументу:

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

Раскройте дерево каталогов в левой части окна и выберите каталог, который содержит нужную схему конфигурации.

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

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

Выделите схему, которую необходимо добавить к аргументу.
Нажмите на кнопку Добавить.

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

Чтобы добавить другие аргументы в блок, используйте кнопку Добавить аргумент.
После добавления всех аргументов нажмите на кнопку Сохранить.

Редактирование блока, хранящего элемент плейбука

Чтобы отредактировать блок, хранящий элемент плейбука:

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

Вы также можете перейти в режим редактирования блока, наведя на него курсор мыши и выбрав команду Изменить ( edit

) из отобразившегося меню действий more vertical

Редактирование метаданных плейбука

Чтобы отредактировать метаданные плейбука:

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

Структура полей метаданных плейбука

Конструктор Код

Конструктор	Код
ID	`id`
Тип экспертизы	`type`
Название плейбука	`name`
Пользователь (Автор)	`author`
Версия	`version`
Теги	`tags`

id

Тип экспертизы

type

Название плейбука

name

Пользователь (Автор)

author

Версия

version

Теги

tags

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

Редактирование настроек выполнения плейбука

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

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

Структура полей настроек выполнения плейбука

Конструктор (просмотр) Конструктор (редактирование) Код

Конструктор (просмотр)	Конструктор (редактирование)	Код
Выполнение на одном воркере Показывает, будут ли текущий плейбук и дочерние задачи выполняться на одном воркере.	Выполнение на одном воркере Установите переключатель, чтобы текущий плейбук и его дочерние задачи выполнялись на одном и том же воркере.	`same_worker`
Кэширование Показывается время кэширования результатов работы.	Кэширование результатов Чтобы результаты работы плейбука кэшировались, в поле Секунды укажите время жизни кэша данных плейбука в секундах.	`cache_ttl`
Приоритет Показывается приоритет выполнения плейбука.	Приоритет В поле Приоритетность укажите приоритет выполнения плейбука в очереди задач воркеров по сравнению с другими элементами экспертизы.	`priority`
Конкурентность (Лимит) Лимит — количество параллельных выполнений плейбука Временное окно (сек.) — максимально допустимое время выполнения задачи при параллельном выполнении	Конкурентность (Лимит) Заполните следующие поля: Лимит — количество параллельных выполнений плейбука. Временное окно (сек.) — максимально допустимое время выполнения задачи при параллельном выполнении в секундах.	`concurrent_limit`
Пропустить выполнение Плейбук не будет запущен, если входные данные удовлетворяют отображаемому условию.	Пропустить выполнение В поле Условие на языке JavaScript задайте условие. Если входные данные плейбука удовлетворяют ему, плейбук не будет запущен.	`skip_expr`
Мгновенный отклик Отображает ID блока, при выполнении которого пользователю будет отправляться немедленное подтверждение. Если блок не выбран, отображается информация Статус — Выключен. Если у пользователя есть разрешение на просмотр запусков, в подтверждении отображается кнопка, позволяющая просмотреть статус обработки плейбука на странице запусков.	Мгновенный отклик В выпадающем списке ID блока выберите идентификатор блока плейбука, в начале выполнения которого система отправит пользователю подтверждение.	`early_return`

Выполнение на одном воркере

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

Выполнение на одном воркере

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

same_worker

Кэширование

Показывается время кэширования результатов работы.

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

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

cache_ttl

Приоритет

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

Приоритет

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

priority

Конкурентность (Лимит)

Лимит — количество параллельных выполнений плейбука
Временное окно (сек.) — максимально допустимое время выполнения задачи при параллельном выполнении

Конкурентность (Лимит)

Заполните следующие поля:

Лимит — количество параллельных выполнений плейбука.
Временное окно (сек.) — максимально допустимое время выполнения задачи при параллельном выполнении в секундах.

concurrent_limit

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

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

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

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

skip_expr

Мгновенный отклик

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

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

Мгновенный отклик

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

early_return

Настройки модуля обработки ошибок

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

Работа с модулем обработки ошибок в конструкторе выполняется в панели настроек. Панель отображается при нажатии кнопки bug в правой верхней части экрана.

Просмотр настроек модуля обработки ошибок

Просмотреть настройки модуля обработки ошибок плейбука можно в панели настроек конструктора плейбуков.

Если в настройках модуля обработки ошибок выбран скрипт, запускаемый в случае ошибки выполнения плейбука:

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

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

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

ID скрипта — идентификатор скрипта, запускаемого в случае ошибки.
Название скрипта — название скрипта, запускаемого в случае ошибки.
Тип — тип скрипта. По умолчанию используется значение Скрипт.
Пользователь (Автор) — имя пользователя, указанное в схеме плейбука.
Версия — версия скрипта, указанная в схеме плейбука.
Теги — теги скрипта, указанные в схеме плейбука.

Вкладка Аргументы

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

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

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

Редактирование настроек модуля обработки ошибок

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

Нажмите на кнопку . Панель настроек отобразится в рабочей области справа.
Нажмите на кнопку в верхней части панели. Отобразится модальное окно редактирования настроек.
Отредактируйте информацию в разделах окна Информация о блоке, Аргументы и Настройки:
- Информация о блоке
  
  Для редактирования в разделе доступно поле ID. Вы можете указать пользовательский ID вместо ID, созданного системой. Он должен быть уникальным.
- Аргументы
  
  Для всех аргументов, заданных в выбранном скрипте, отображаются доступные для редактирования поля, позволяющие изменить текущие данные аргументов.
- Настройки
  
  Для редактирования доступны следующие поля:
  - Название блока
  - Поля настроек модуля обработки ошибок
Нажмите на кнопку Сохранить. Информация будет сохранена.

Чтобы добавить скрипт в модуль:

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

Структура полей модуля настроек обработки ошибок
Конструктор (просмотр)	Конструктор (редактирование)	Код	Значок настройки
Повторы при ошибке В разделе Статические повторы отображается количество попыток выполнения элемента и интервал между ними. В разделе Возрастающие повторы отображается количество попыток выполнения элемента, множитель, определяющий фактический интервал между попытками и интервал между ними. При установленном флажке Возрастающие повторы ниже отображается расчет возрастающих повторов для текущих параметров.	Повторы при ошибке Установите переключатель, чтобы настроить повторы выполнения элемента. Установите флажок Статические повторы, чтобы настроить повторы через определенный фиксированный интервал: Укажите в поле Попытки количество повторных попыток выполнения элемента. Укажите в поле Интервал интервал между попытками выполнения в секундах. Установите флажок Возрастающие повторы, чтобы настроить гибко заданное количество повторов: Укажите в поле Попытки количество попыток выполнения элемента. Укажите в поле Интервал базовый интервал между попытками выполнения элемента. В поле Множитель укажите множитель, определяющий фактический интервал между попытками выполнения элемента. При установленном флажке Возрастающие повторы ниже отображается расчет возрастающих повторов для текущих параметров.	`retry`

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

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