Действия в домене

Этот раздел описывает действия, выполняемые в домене.

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

О действиях

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

Структура `actions`

Путь в схеме: actions[]

Поле actions представляет собой массив записей действий. Описания действий включают общие поля и специфические в зависимости от типа действия.

Общие поля для всех типов действий

Описание каждого пользовательского типа включает следующие поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`id`	Да	Уникальный идентификатор действия.	View ID
`name`	Нет (по умолчанию: пустая строка)	Наименование действия. Используется, если не определен или не может быть определен `label` для элемента управления в представлении.	строка
`description`	Нет (по умолчанию: пустая строка)	Описание действия. Не выводится в представлениях, но отображается в схеме домена.	строка
`type`	Да	Тип действия. Ознакомьтесь со списком доступных действий.	перечисление

id

Да

Уникальный идентификатор действия.

View ID

name

Нет (по умолчанию: пустая строка)

Наименование действия. Используется, если не определен или не может быть определен label для элемента управления в представлении.

строка

description

Нет (по умолчанию: пустая строка)

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

строка

type

Да

Тип действия. Ознакомьтесь со списком доступных действий.

перечисление

Типы действий (`type`)

Путь в схеме: actions[].type

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

open_panel — открыть панель деталей объекта;
open_modal — открыть модальное окно для создания или редактирования объекта;
open_page — открыть полноэкранную карточку объекта;
open_graph_view — открыть диаграмму связей объекта, позволяющую создавать, изменять и удалять экземпляры связей, а также просматривать связи объекта на разных уровнях;
open_board_view — открыть диаграмму связей объекта в режиме доски.
open_list — открыть списочное представление объектов с заполненным контекстом на основании выбранного объекта в текущем списке;
open_tree — открыть древовидное представление;
open_view — открыть списочное или древовидное представление без контекста наличия связи с объектом;
remove — удалить объект;
bulk — выполнить массовое действие;
set_attribute_value — установить указанные значения для атрибутов;
automation — запустить автоматизацию;
playbook — запустить выполнение указанного плейбука или скрипта;
generate_qr_code — открыть модальное окно со сгенерированным QR-кодом, содержащим ссылку на компактное представление сущности;
copy_entity_link — скопировать полный URL объекта, включая параметры текущего состояния формы.

Открытие панели (`type: open_panel`)

Описание действия типа open_panel дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`panel`	Да	Ссылка на панель, которая будет открываться при этом действии.	строка
`entity`	Да	Ссылка на сущность, над экземпляром которой производится действие.	Data ID Ref или FQID

panel

Да

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

строка

entity

Да

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

Data ID Ref или FQID

Открытие модального окна (`type: open_modal`)

Описание действия типа open_modal дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`modal`	Да	Ссылка на модальное окно, которое будет открываться при этом действии.	строка
`entity`	Да	Ссылка на сущность, над экземпляром которой производится действие.	Data ID Ref или FQID
`operation`	Да	Тип операции над объектом. Доступные значения: `create` — добавление объекта; `edit` — изменение выбранного объекта.	перечисление

modal

Да

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

строка

entity

Да

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

Data ID Ref или FQID

operation

Да

Тип операции над объектом. Доступные значения:

create — добавление объекта;
edit — изменение выбранного объекта.

перечисление

Открытие полноэкранной карточки (`type: open_page`)

Описание действия типа open_page дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`view`	Да	Ссылка на списочное представление объектов, зависимых от контекста.	View ID Ref
`entity`	Да	Ссылка на сущность, над экземпляром которой производится действие.	Data ID Ref или FQID
`operation`	Да	Тип операции над объектом. Доступные значения: `create` — добавление объекта; `edit` — изменение выбранного объекта; `view` — просмотр выбранного объекта.	перечисление

view

Да

Ссылка на списочное представление объектов, зависимых от контекста.

View ID Ref

entity

Да

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

Data ID Ref или FQID

operation

Да

Тип операции над объектом. Доступные значения:

create — добавление объекта;
edit — изменение выбранного объекта;
view — просмотр выбранного объекта.

перечисление

Открытие диаграммы связей (`type: open_graph_view`)

Описание действия типа open_graph_view дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`entity`	Да	Ссылка на сущность, над экземпляром которой производится действие.	Data ID Ref или FQID
`defaultViewMode`	Нет (по умолчанию — `cola`)	Настройка отображения графа связей при открытии. Доступные значения: `cola` — центральное упорядочивание; `vertical` — вертикальное упорядочивание; `horizontal` — горизонтальное упорядочивание.	перечисление
`openBoardsFromGraph`	нет	Возможность перехода к режиму доски при просмотре диаграммы. Ознакомьтесь с описанием поля.	объект

entity

Да

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

Data ID Ref или FQID

defaultViewMode

Нет (по умолчанию — cola)

Настройка отображения графа связей при открытии. Доступные значения:

cola — центральное упорядочивание;
vertical — вертикальное упорядочивание;
horizontal — горизонтальное упорядочивание.

перечисление

openBoardsFromGraph

нет

Возможность перехода к режиму доски при просмотре диаграммы.

Ознакомьтесь с описанием поля.

объект

Настройки открытия диаграммы связей в режиме доски (`openBoardsFromGraph`)

Путь в схеме: actions[].openBoardsFromGraph

Поле openBoardsFromGraph описывает настройки открытия диаграммы связей в режиме доски.

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`openBoards`	да	Флаг, позволяющий открыть диаграмму в режиме доски.	логическое
`name`	да (при `openBoards: true`)	Название кнопки для открытия доски.	строка

openBoards

да

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

логическое

name

да (при openBoards: true)

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

строка

Открытие доски (`type: open_board_view`)

Описание действия типа open_board_view дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`entity`	да	Ссылка на сущность, над экземпляром которой производится действие.	Data ID Ref или FQID

entity

да

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

Data ID Ref или FQID

Открытие списочного представления (`type: open_list`)

Описание действия типа open_list дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`view`	Да	Ссылка на списочное представление объектов, зависимых от контекста.	View ID Ref
`contextPin`	Нет (по умолчанию: `false`)	Флаг, запрещающий удаление контекста из фильтра списка объектов.	булево
`page`	Нет	Окно, в котором будет отображен список. Возможные значения: `blank` — показать список в новом окне; `current` — показать список в текущем окне.	перечисление
`attribute`	Нет	Ссылка на атрибут-ссылку, для которого будет применен контекст. Список объектов можно отфильтровать по значению атрибута-ссылки. Нельзя указывать одновременно с `linkage`.	строка
`linkage`	Нет	Ссылка на связь, для которой будет применен контекст. Список объектов можно отфильтровать по одной из сторон связи. Нельзя указывать одновременно с `attribute`.	строка
`side`	Нет	Сторона ссылки или связи, в соответствии с которой отображаются объекты в списочном представлении с контекстом. Указывается только для симметричной направленной связи. Возможные значения: `1` — первая сторона связи; `2` — вторая сторона связи.	Data ID Ref или FQID

view

Да

Ссылка на списочное представление объектов, зависимых от контекста.

View ID Ref

contextPin

Нет (по умолчанию: false)

Флаг, запрещающий удаление контекста из фильтра списка объектов.

булево

page

Нет

Окно, в котором будет отображен список. Возможные значения:

blank — показать список в новом окне;
current — показать список в текущем окне.

перечисление

attribute

Нет

Ссылка на атрибут-ссылку, для которого будет применен контекст. Список объектов можно отфильтровать по значению атрибута-ссылки. Нельзя указывать одновременно с linkage.

строка

linkage

Нет

Ссылка на связь, для которой будет применен контекст. Список объектов можно отфильтровать по одной из сторон связи. Нельзя указывать одновременно с attribute.

строка

side

Нет

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

1 — первая сторона связи;
2 — вторая сторона связи.

Data ID Ref или FQID

Открытие древовидного представления (`type: open_tree`)

Описание действия типа open_tree дополнительно включает поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`view`	да	View ID Ref	Ссылка на древовидное представление.
`page`	нет	перечисление	Окно, в котором будет отображено представление. Возможные значения: `blank` — новое окно; `current` — текущее окно.

view

да

View ID Ref

Ссылка на древовидное представление.

page

нет

перечисление

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

blank — новое окно;
current — текущее окно.

Открытие представления без контекста (`type: open_view`)

Описание действия типа open_view дополнительно включает поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`view`	да	View ID Ref	Ссылка на списочное или древовидное представление объектов.
`page`	нет	перечисление	Окно, в котором будет отображено представление. Возможные значения: `blank` — новое окно; `current` — текущее окно.

view

да

View ID Ref

Ссылка на списочное или древовидное представление объектов.

page

нет

перечисление

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

blank — новое окно;
current — текущее окно.

Удаление объекта (`type: remove`)

Описание действия типа remove дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`entity`	Да	Ссылка на сущность, над экземпляром которой производится действие.	Data ID Ref или FQID

entity

Да

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

Data ID Ref или FQID

Массовые действия (`type: bulk`)

Описание действия типа bulk дополнительно включает поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`entity`	да	Data ID Ref или FQID	Ссылка на сущность, над экземпляром которой производится действие.
`operation`	да	перечисление	Тип операции над объектом. Ознакомьтесь с описанием поля `operation`.
`attribute`	нет	Data ID Ref	Ссылка на атрибут-ссылку, для которого будет применен контекст.
`attributes`	да (для `operation: edit`)	массив	Массив параметров атрибутов, доступных для массового редактирования. Ознакомьтесь с описанием поля `attributes`.
`linkages`	да (для `operation: edit`)	массив	Массив связей, доступных для массового редактирования. Ознакомьтесь с описанием поля `linkages`.
`values`	да (при `operation: edit_attribute`)	Массив атрибутов и значений. Доступно при `operation: edit_attribute`. Ознакомьтесь с описанием поля `values`.	массив
`control`	нет	Описывает отображаемые тексты для элемента управления. Доступно при `operation: edit_attribute` и атрибуте с `dataType: bool`. Ознакомьтесь с описанием поля `control`.	объект

entity

да

Data ID Ref или FQID

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

operation

да

перечисление

Тип операции над объектом.

Ознакомьтесь с описанием поля operation.

attribute

нет

Data ID Ref

Ссылка на атрибут-ссылку, для которого будет применен контекст.

attributes

да (для operation: edit)

массив

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

Ознакомьтесь с описанием поля attributes.

linkages

да (для operation: edit)

массив

Массив связей, доступных для массового редактирования.

Ознакомьтесь с описанием поля linkages.

values

да (при operation: edit_attribute)

Массив атрибутов и значений. Доступно при operation: edit_attribute.

Ознакомьтесь с описанием поля values.

массив

control

нет

Описывает отображаемые тексты для элемента управления. Доступно при operation: edit_attribute и атрибуте с dataType: bool.

Ознакомьтесь с описанием поля control.

объект

Типы операций при массовом редактировании (`operation`)

Путь в схеме: actions[].operation

Доступны следующие типы массовых операций:

remove — удаление выбранных объектов;
edit_attribute — изменение атрибута с типом workflow или bool в выбранных объектах;
edit — редактирование выбранных объектов.

Атрибуты для массового редактирования (`attributes`)

Путь в схеме: actions[].attributes[]

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

Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`type`	да	перечисление	Тип атрибутов. Указывается значение `specific`.
`use`	да	массив	Массив полей `attribute` с атрибутами сущности, доступными для массового редактирования. В полях нужно указывать Data ID Ref атрибутов сущности, на которую ссылается действие, в текущем домене.

type

да

перечисление

Тип атрибутов. Указывается значение specific.

use

да

массив

Массив полей attribute с атрибутами сущности, доступными для массового редактирования.

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

Связи для массового редактирования (`linkages`)

Путь в схеме: actions[].linkages[]

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

Поле имеет следующую структуру:

Поле Обязательное поле Описание Тип данных

Поле	Обязательное поле	Описание	Тип данных
`type`	да	Указывается значение `specific`.	перечисление
`use`	да	Массив полей `widget` со ссылками на виджеты связей, доступных для массового редактирования. Виджет должен отображать сторону N.	массив

type

да

Указывается значение specific.

перечисление

use

да

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

массив

Отображаемый текст для значений истины и лжи (`control`)

Путь в схеме: actions[].control

Поле имеет следующую структуру:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`type`	нет	строка	Тип редактора, используемый в столбце.
`trueText`	да	строка	Отображаемая строка для значения `True`.
`falseText`	да	строка	Отображаемая строка для значения `False`.

type

нет

строка

Тип редактора, используемый в столбце.

trueText

да

строка

Отображаемая строка для значения True.

falseText

да

строка

Отображаемая строка для значения False.

Установка значения атрибутов (`type: set_attribute_value`)

Описание действия типа set_attribute_value дополнительно включает поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`entity`	да	Data ID Ref или FQID	Ссылка на сущность, над экземпляром которой производится действие.
`values`	да	массив	Массив атрибутов и значений. Ознакомьтесь с описанием поля `values` и примером использования.

entity

да

Data ID Ref или FQID

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

values

да

массив

Массив атрибутов и значений.

Ознакомьтесь с описанием поля values и примером использования.

Атрибуты и установленные значения (`values`)

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

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`attribute`	да	Data ID Ref	Ссылка на атрибут типа `bool`, для которого будет установлено новое значение.
`value`	нет	строка	Значение, которое будет установлено для указанного атрибута. Должно соответствовать типу атрибута.

attribute

да

Data ID Ref

Ссылка на атрибут типа bool, для которого будет установлено новое значение.

value

нет

строка

Значение, которое будет установлено для указанного атрибута. Должно соответствовать типу атрибута.

Запуск автоматизации (`type: automation`)

Описание действия типа automation дополнительно включает поля:

Поле Обязательность и значение по умолчанию Тип данных Описание

Поле	Обязательность и значение по умолчанию	Тип данных	Описание
`automation`	нет	объект	Ссылка на автоматизацию, которую запускает действие, в формате `id: <UUID автоматизации>`. Если поле `automation` не задано, при вызове действия в интерфейсе пользователь может выбрать автоматизацию из списка в модальном окне.

automation

нет

объект

Ссылка на автоматизацию, которую запускает действие, в формате id: <UUID автоматизации>.

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

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

Пример действия с выбором автоматизации

actions:
  - id: 'runAutomationBySelect'
    name: 'Выбрать и запустить автоматизацию'
    type: 'automation'

Пример действия с запуском конкретной автоматизации

actions:
  # Идентификатор действия.
  - id: 'runAutomationById'
    name: 'Запустить конкретную автоматизацию по id'
    type: 'automation'
    automation:
      # UUID автоматизации.
      id: '3c521909-cc55-4b0c-b645-f79eb0263296'

Запуск плейбука или скрипта (`type: playbook`)

Описание действия типа playbook дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`playbook`	Нет	Ссылка на плейбук или скрипт. Уникальное наименование плейбука или скрипта в рамках текущей экспертизы.	строка
`workerTag`	Нет	Тег воркера, используемый для выполнения запуска.	строка

playbook

Нет

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

строка

workerTag

Нет

Тег воркера, используемый для выполнения запуска.

строка

Генерация QR-кода (`type: generate_qr_code`)

Описание действия типа generate_qr_code дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`entity`	Да	Ссылка на сущность, для которой генерируется QR-код.	Data ID Ref или FQID

entity

Да

Ссылка на сущность, для которой генерируется QR-код.

Data ID Ref или FQID

Копирование URL объекта (`type: copy_entity_link`)

Описание действия типа copy_entity_link дополнительно включает поля:

Поле Обязательность и значение по умолчанию Описание Тип данных

Поле	Обязательность и значение по умолчанию	Описание	Тип данных
`entity`	Да	Ссылка на сущность, для которой копируется URL.	Data ID Ref или FQID

entity

Да

Ссылка на сущность, для которой копируется URL.

Data ID Ref или FQID

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

Действия в домене

О действиях

Структура actions

Общие поля для всех типов действий

Типы действий (type)

Открытие панели (type: open_panel)

Открытие модального окна (type: open_modal)

Открытие полноэкранной карточки (type: open_page)

Открытие диаграммы связей (type: open_graph_view)

Настройки открытия диаграммы связей в режиме доски (openBoardsFromGraph)

Открытие доски (type: open_board_view)

Открытие списочного представления (type: open_list)

Открытие древовидного представления (type: open_tree)

Открытие представления без контекста (type: open_view)

Удаление объекта (type: remove)

Массовые действия (type: bulk)

Типы операций при массовом редактировании (operation)

Атрибуты для массового редактирования (attributes)

Связи для массового редактирования (linkages)

Отображаемый текст для значений истины и лжи (control)

Установка значения атрибутов (type: set_attribute_value)

Атрибуты и установленные значения (values)

Запуск автоматизации (type: automation)

Запуск плейбука или скрипта (type: playbook)

Генерация QR-кода (type: generate_qr_code)

Копирование URL объекта (type: copy_entity_link)

Структура `actions`

Типы действий (`type`)

Открытие панели (`type: open_panel`)

Открытие модального окна (`type: open_modal`)

Открытие полноэкранной карточки (`type: open_page`)

Открытие диаграммы связей (`type: open_graph_view`)

Настройки открытия диаграммы связей в режиме доски (`openBoardsFromGraph`)

Открытие доски (`type: open_board_view`)

Открытие списочного представления (`type: open_list`)

Открытие древовидного представления (`type: open_tree`)

Открытие представления без контекста (`type: open_view`)

Удаление объекта (`type: remove`)

Массовые действия (`type: bulk`)

Типы операций при массовом редактировании (`operation`)

Атрибуты для массового редактирования (`attributes`)

Связи для массового редактирования (`linkages`)

Отображаемый текст для значений истины и лжи (`control`)

Установка значения атрибутов (`type: set_attribute_value`)

Атрибуты и установленные значения (`values`)

Запуск автоматизации (`type: automation`)

Запуск плейбука или скрипта (`type: playbook`)

Генерация QR-кода (`type: generate_qr_code`)

Копирование URL объекта (`type: copy_entity_link`)