Создание действия через интерфейс

Для просмотра существующих действий и их редактирования создан журнал «Действия» (Рабочее пространство «Раздел администратора» - Конфигурация UI):

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

../../_images/create_01.png

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

Действие можно создать или загрузить уже созданное в систему.

Для создания действия необходимо нажать + - Создать действие:

../../_images/create_01_1.png

Откроется форма действия. Подробно см. ниже.

Для загрузки созданного действия необходимо нажать + - Загрузить действие:

../../_images/create_01_2.png

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

Создание нового действия

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

Кнопка «Сохранить» неактивна, пока в форме есть ошибки валидации (например, не заполнено обязательное поле).

Основные

../../_images/create_02.png

Поле

Ключ

Описание

Идентификатор действия *

id

Уникальный идентификатор действия.
Для локального идентификатора форма может проверять шаблон ^[a-zA-Z][a-zA-Z0-9_-]*$: латинская буква в начале, далее латинские буквы, цифры, _ и -. Допустимость префикса рабочего пространства определяется сервером.
Задается только при создании: при редактировании поле заблокировано.

Название действия *

name

Название, которое увидит пользователь. Поддерживает локализацию.

Название (множ. число)

pluralName

Название действия во множественном числе. Поддерживает локализацию.

Тип действия *

type

Тип определяет логику, которая будет выполнена при запуске действия (view, edit, delete, download, create, open-url, fetch, mutate, script, transform, user-event и др.).
От выбранного типа зависит содержимое вкладки Конфигурация.
Подробно о типах — в разделе Типы действий.

Иконка

icon

Код иконки из иконочного шрифта Citeck, например icon-edit, icon-delete.

Ссылка на тип

typeRef

Тип данных, выбирается из журнала типов данных.

Модуль предобработки

preActionModule

Ссылка на JS-модуль предобработки.

* — обязательное поле.

Конфигурация

На вкладке задаются параметры config действия. Набор параметров зависит от типа действия и описан в разделе Типы действий.

Вид вкладки зависит от значения поля Тип действия:

Отображается редактор Конфигурация (JSON), в котором задается конфигурация действия в формате JSON.

Пример конфигурации для действия с типом mutate, которое меняет статус текущей записи:

../../_images/create_03.png

В конфигурации можно подставлять атрибуты записи, над которой выполняется действие, например ${recordRef}. Подробно — в разделе Общие настройки любого действия.

Отображается редактор JavaScript, в котором пишется код действия. В редакторе доступны AI-подсказки.

Код сохраняется в конфигурацию действия в виде { "fn": "<код>" }.

../../_images/ai_script_help.png

Функции

../../_images/create_04.png

В блоке Применимость указывается, в каких режимах доступно действие (см. категории действий на странице Действия). Каждый флажок имеет три состояния: включено, выключено и не задано. Выключенное состояние запрещает режим; включенное разрешает его только при наличии соответствующего метода в исполнителе. Если значение не задано, используются возможности исполнителя.

Поле

Ключ

Описание

Для записи

features.execForRecord

Действие выполняется над одной записью.

Для записей

features.execForRecords

Действие выполняется над записями, выбранными в журнале.

Для запроса

features.execForQuery

Действие выполняется над всеми записями, которые подходят под фильтрацию журнала.
В форме может дополнительно отображаться execAsForRecords (execForQueryConfig.execAsForRecords) — обрабатывать найденные записи через групповой режим. Настройка не обходит проверку наличия execForQuery у исполнителя. Например, обычный mutate не поддерживает режим запроса.

Размер пакета

execForRecordsBatchSize

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

Количество параллельных пакетов

execForRecordsParallelBatchesCount

Количество пакетов, обрабатываемых одновременно. По умолчанию 1.

Сообщение об ошибке таймаута

timeoutErrorMessage

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

Подтверждение

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

../../_images/create_05.png

Блок Подтвердить (confirm):

Поле

Ключ

Описание

Заголовок подтверждения

confirm.title

Заголовок окна подтверждения. Поддерживает локализацию.

Сообщение подтверждения

confirm.message

Текст в окне подтверждения. Поддерживает локализацию.

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

confirm.formRef

Форма, которая отображается в окне подтверждения. Выбирается из журнала форм. Если форма задана, Сообщение подтверждения не отображается.

Атрибуты формы

confirm.formAttributes

Атрибуты, которые передаются в форму подтверждения: Атрибут — имя атрибута формы, Значение — значение или выражение, например ${name}. Подстановка по текущей записи выполняется в одиночном режиме; в групповом режиме такой записи нет.

Сопоставление атрибутов

confirm.attributesMapping

Куда передать данные, введенные на форме подтверждения: Путь в record — путь в конфигурации действия, Поле формы — ключ поля на форме.
На скриншоте выше значение поля statuses с формы подтверждения записывается в record.attributes._status конфигурации действия.

Блок Результат (result):

Поле

Ключ

Описание

Заголовок результата

result.title

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

Сообщение результата

result.message

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

Заголовок общего окна формируется из config.title или названия действия, содержимое — из возвращённого результата {type, data}. См. Формат результата. При обычной загрузке списка доступных действий фронтенд также не запрашивает поле result.

Примечание

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

Расширенные

../../_images/create_06.png

Поле

Ключ

Описание

Predicate (JSON)

predicate

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

Evaluator (JSON)

evaluator

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

Сохранение действия

После нажатия «Сохранить» форма отправляет данные серверу. Правила создания, копирования и сохранения действия в рабочем пространстве определяет источник uiserv/action. Учитывайте текущее рабочее пространство; поддержку идентификатора с префиксом <wsSysId>:<id> и ограничения его изменения определяет серверная версия. Отдельной универсальной проверки этих правил в исполнителях действий ecos-ui нет.

Подключение действия

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