Для каждого ресурса, действия или сценария администратор платформы может добавить неограниченное количество параметров одного из следующих типов:
- Array - список значений
- Boolean - булево значение
- Date - дата
- JSON - текст в JSON формате
- Entities - сущность, один из параметров которой можно выбрать в качестве значения
- Enum - перечисление значений с ключом и отображаемым значением
- List - список значений с возможностью выбора одного из них
- Markdown - текст в Markdown формате
- Number - число
- Object - произвольный объект в JSON формате
- Percentage - процент
- String - строка
- YAML - текст в YAML формате
- Teams - команды
- URL - строка в формате URL
- Users - пользователи
Ресурсы
После добавления параметра для ресурса он будет отображаться у всех сущностей данного ресурса в их карточках и в таблице каталога. Для каждого параметра можно задать значение по умолчанию. Значение каждого параметра можно изменить для каждой сущности по отдельности.
Заполненность параметров проверяется для каждой сущности, результат проверки выводится в карточке сущности в заголовке.
Синхронизация параметров ресурса
По различным причинам у сущностей могут появиться параметры, которых нет у ресурса. Для того, чтобы удалить подобные параметры доступна кнопка “Синхронизировать параметры” в меню ресурса.
При синхронизации параметров:
- Для каждого параметра ресурса будет получен его идентификатор.
- Для каждой сущности ресурса будут получен список ее параметров.
- Те параметры сущности, название которых не соответствует ни одному из идентификаторов параметров ресурса, будут удалены из спецификации сущности.
Действия и сценарии
Для каждого действия и сценария задается пользовательская форма, состоящая из параметров, которые пользователь должен заполнить при запуске.
Ограничения
Идентификатор кажого параметра должен:
- Содержать символы
a-z,A-Z, цифры, либо подчеркивания - Не начинаться с цифры
Конфигурация
- Редактируемый параметр - для каждого параметра можно настроить разрешение, либо запрет редактирования пользователем. В случае запрета редактирования пользователь при запуске действий или сценариев не сможет изменить значение параметра, то есть всегда будет использоваться значение по умолчанию.
- Обязательный параметр - каждый параметр может быть обязательным, либо опциональным. Значение обязательного параметра не может быть пустым при запуске действий или сценариев. При этом значение опционального параметра может оставаться пустым без влияния на работоспособность действия.
- Скрытый параметр - скрытый параметр не отображается в таблицах и карточках сущностей, а также при запуске действий и сценариев.
Типы параметров
Date
Параметр типа “Date” может принимать значение даты с определенным пользователем форматом. При этом в спецификации значение всегда хранится в формате ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ).
Конфигурация параметра
- Формат - настройка отображения даты. Если формат не задан явно, то используется формат по умолчанию:
YYYY-MM-DDTHH:mm:ss.sssZ. Описание конфигурации формата доступно по ссылке. Настройка формата влияет на:- отображение даты в таблицах и карточках сущностей;
- значение параметра при запуске действий или сценариев.
- Текущая дата по умолчанию - подстановка текущей даты в качестве значения по умолчанию при редактировании сущностей, а также при запуске действий или сценариев.
- Значение по умолчанию - заранее заданное значение по умолчанию. Не применяется, если активирован переключатель “Текущая дата по умолчанию”.
При запуске действий или сценариев и использовании текущей даты по умолчанию, параметр не должен быть скрытым в пользовательской форме. В противном случае текущая дата подставлена не будет.
При запуске действий или сценариев в параметр типа «дата» нельзя подставить значения с использованием Go template.
List
Параметр типа “List” позволяет выбрать одно значение из предопределенного списка.
Enum
Параметр типа “Enum” позволяет выбрать один элемент из предопределенного списка. В отличие от типа “List”, параметр “Enum” использует пару ключ-значение, где ключ хранится в спецификации, а значение отображается пользователю. Это позволяет изменять отображаемый текст без изменения ключей.