Типы действий
Справочник по встроенным типам действий Citeck: идентификатор типа (type) и доступные параметры config.
Поддержка режима определяется методами исполнителя. Флажок features может запретить режим, но не добавляет отсутствующую реализацию. См. Общие настройки.
Обзор типов
Типы, для которых ниже есть подробное описание, оформлены ссылками.
Просмотр и навигация
Тип |
Что делает |
|---|---|
открыть запись |
|
|
открыть в фоновой вкладке |
перейти по URL |
|
предпросмотр контента в модальном окне |
|
просмотр печатной формы карточки |
|
|
просмотр меню |
Создание и редактирование
Тип |
Что делает |
|---|---|
создать запись |
|
редактировать |
|
|
редактировать JSON |
|
редактировать меню |
|
редактировать пресет журнала |
|
права на запись |
|
права на тип |
|
зарегистрированный обработчик без реализации выполнения |
|
копировать запись |
|
копировать ECOS-модуль |
сохранить как шаблон кейса |
|
|
загрузить новую версию |
|
отладка формы |
Удаление и выгрузка
Тип |
Что делает |
|---|---|
удалить |
|
скачать |
|
|
скачать архивом |
скачать по шаблону |
|
скачать печатную форму |
|
|
экспорт записей |
Серверные и скриптовые действия
Тип |
Что делает |
|---|---|
изменить атрибуты |
|
HTTP-запрос |
|
выполнить JS-скрипт |
|
трансформация |
|
|
групповое серверное действие |
пользовательское событие |
|
действие над ассоциацией |
|
|
адаптер UI-действия; текущая реализация поддерживает |
|
миграция токена |
загрузить действия из атрибута записи (алиас |
Бизнес-процессы и задачи
Тип |
Что делает |
|---|---|
завершить задачу с выбранным вариантом |
|
загрузить варианты завершения задач |
|
открыть форму с отправкой на рассмотрение |
|
|
открыть действия задачи |
|
назначить исполнителя задачи |
|
изменить исполнителя задачи |
просмотреть бизнес-процесс |
|
|
отменить бизнес-процесс |
Общедоступные действия
view
id типа: view
Описание |
Конфигурация |
|---|---|
Открыть запись на просмотр. |
Дополнительные параметры для config:
background: Bool - открыть запись в новой вкладке приложения в фоновом режиме;
reopen: Bool - открыть запись в текущей вкладке приложения;
newBrowserTab: Bool - открыть запись в новой вкладке браузера
reopenBrowserTab: Bool - открыть запись в текущей вкладке браузера (с перезагрузкой страницы).
viewType: String -
task-document-dashboard открывает документ задачи; view-task разрешает запись задачи в документ или процесс. Без значения открывается карточка переданной записи. |
edit
id типа: edit
Описание |
Конфигурация |
|---|---|
Открывает форму редактирования записи в модальном окне.
Доступно только для
execForRecord: групповое редактирование не поддерживается. |
formId: String - форма, которой редактировать запись. По умолчанию - форма записи;
recordId: String - редактировать другую запись вместо записи действия;
mode: String - значение
task включает режим задачи;saveOnSubmit: Bool -
false - форма не сохраняет запись сама (по умолчанию true);attributes: Object<String, String> - атрибуты, которые будут переданы в форму редактирования. Необязательный параметр;
recordsToReset: String[] - ссылки на записи, у которых после успешного редактирования сбрасывается кэш.
|
Примечание
Колбэки формы (onFormCancel, onAfterHideModal, onPreSettingSubmit, handlers) - функции, поэтому в JSON-конфигурации действия их не задать. Они передаются только при вызове действия из кода.
Какая форма открывается
Условия проверяются сверху вниз, срабатывает первое подходящее:
Условие |
Что открывается |
|---|---|
|
форма задачи с панелью назначения |
не указан |
специальный редактор дашборда |
все остальные случаи |
обычная форма редактирования |
Если указан formId, редактор дашборда не используется: у дашборда тоже откроется указанная форма.
Кастомная форма (formId)
id: edit-contract-details
type: edit
name:
ru: Редактировать договор
config:
formId: contract-details
Конфигурация действия в журнале действий или в артефакте действия:
{ "formId": "custom-edit" }
formIdможно указать как локальный id (custom-edit) или как полную ссылку (uiserv/form@custom-edit).Указанная форма меняет только то, какой формой редактировать. Запись остаётся прежней: текущая запись действия или
config.recordId.Если указана
formId, проверяется наличие самой этой формы, поэтому запись без формы по умолчанию тоже можно редактировать.Если формы нет или запрос не выполнился, показывается уведомление об ошибке. Форма по умолчанию вместо неё не подставляется.
Сохранение, отмена, передача
attributesи проверка прав работают так же, как безformId.В режиме задачи
formIdтоже учитывается, панель назначения при этом остаётся.
Режим задачи
Id задачи берётся из атрибута cm:name записи:
если атрибут пустой, пользователь получает уведомление об ошибке;
если у задачи нет формы, действие завершается с результатом
falseбез уведомления.
Результат действия
Действие возвращает true, если форму отправили, и false, если её закрыли без сохранения. Только при true сбрасывается кэш записей из recordsToReset и отправляется событие RECORD_ACTION_COMPLETED.
Предупреждение
Права на запись фактически проверяются только для журналов (uiserv/journal@…) и досок (uiserv/board@…): без прав вместо формы открываются их предварительные настройки. Для остальных записей форма откроется и без прав на запись; сохранение в этом случае, вероятно, отклонит сервер (не проверено).
download
id типа: download
Описание |
Конфигурация |
|---|---|
Скачать некоторый контент связанный (или не связанный) с записью.
По умолчанию скачивается контент записи
|
url - URL для скачивания. Можно добавлять
${recordRef} для подстановки текущей записи.filename (алиас fileName) - имя скачиваемого файла.
downloadType -
base64, ecos_module или text; без специального режима используется URL или основной контент записи.attribute - атрибут содержимого: по умолчанию
data для base64 и ?json для text.extension - расширение при формировании имени в режимах
base64 и text; для text по умолчанию json. |
Доступно только для execForRecord. В режиме ecos_module выгружается JSON модуля; в режиме text нестроковое значение сериализуется в JSON. Исполнитель возвращает false после запуска скачивания.
delete
id типа: delete
Описание |
Конфигурация |
|---|---|
Удалить запись |
{
"config" : {
"isWaitResponse" : false,
"withoutConfirm" : true
},
"type" : "delete"
}
isWaitResponse - ожидание ответа удаления (по умолчанию
true)withoutConfirm - удаление без подтверждения (по умолчанию
false) |
download-card-template
id типа: download-card-template
Описание |
Конфигурация |
|---|---|
Скачать печатную версию документа
|
templateType - тип шаблона
format - формат (html, pdf, pdf2, docx)
|
download-by-template
id типа: download-by-template
Описание |
Конфигурация |
|---|---|
Скачать документ по шаблону
|
templateRef - ссылка на шаблон
resultName - имя файла, который будет скачан
requestParams - дополнительные параметры, которые будут отправлены на сервер
|
view-card-template
id типа: view-card-template
Описание |
Конфигурация |
|---|---|
Просмотр печатной версии документа в новой вкладке браузера
(возвращаемый документ такой же как для события
download-card-template) |
templateType - тип шаблона
format - формат (html, pdf, pdf2, docx)
includeTimezone (по умолчанию -
true) |
create
id типа: create
Описание |
Конфигурация |
|---|---|
Действие для создания нового документа.
Обычно применяется когда требуется создать новый документ, в котором некоторые поля будут предзаполнены из данных текущего открытого документа.
|
typeRef: String - тип данных для создания в основном режиме;
createVariantId: String - Идентификатор варианта создания для типа. Если не указан, то используется первый доступный вариант
createVariant: Object - Вариант создания для ситуаций, когда ни один вариант создания из типа не походит и требуется его полностью определить в действии
attributes: Object - Предопределенные атрибуты для создания новой сущности. Для прокидывания атрибутов с текущей записи (т.е. той, с которой выполняется действие) на форму создания можно использовать вставки вида
${attribute_name}options: Object - Опции формы
redirectToPage: Bool - перейти на карточку созданной записи после отправки формы; по умолчанию
true.Пример:
Создание сущности с типом emodel/type@request-to-manager и проставлением в атрибут «incident» ссылки на текущий документ
|
Если typeRef не задан, используется legacy-ветка с formId или formKey и recordRef создаваемой записи. Для новых конфигураций используйте режим создания по типу. Действие реализует только execForRecord.
save-as-case-template
id типа: save-as-case-template
Описание |
Конфигурация |
|---|---|
Создается шаблон, затем по условию конфигурации - скачивание или переход на дашборд.
|
download
По умолчанию скачивается контент записи.
|
open-url
id типа: open-url
Описание |
Конфигурация |
|---|---|
Открывает относительный или абсолютный URL. Только
execForRecord. |
url - обязательный URL; можно добавлять
${recordRef} для подстановки текущей записи.args - дополнительные параметры URL.
target - цель открытия; по умолчанию
_blank.withinEcosTab: Bool -
true открывает URL через вкладки приложения; иначе используется window.open.openNewTab: Bool - при
withinEcosTab: true явно запрашивает новую вкладку приложения. Новая вкладка также выбирается при незаданном target или target: _blank. |
assoc-action
id типа: assoc-action
Описание |
Конфигурация |
|---|---|
Выполняет действие над указанной ассоциацией.
|
assoc - ассоциация
action - объект действия
|
content-preview-modal
id типа: content-preview-modal
Описание |
Конфигурация |
|---|---|
Модальное окно с предпросмотром документа.
В конфигурации действия ожидается поле scale.
Возможные значения:
| auto
| 0…4
| page-fit
| page-height
| page-width
|
scale - масштаб предпросмотра. Запись берётся из
record.id действия; поле config.recordRef не используется. |
fetch
id типа: fetch
Описание |
Конфигурация |
|---|---|
Отправляет запрос на указанный URL
|
url
method
args - аргументы, которые будут переданы в URL
body - аргументы, которые будут переданы в тело запроса
|
script
id типа: script
Описание |
Конфигурация |
|---|---|
Выполняет на клиенте JS-код из конфигурации действия.
Доступно только для
execForRecord. |
fn: String - JS-код, который будет выполнен;
module: String - путь к JS-модулю, который будет загружен и выполнен;
noResultModal: Bool - не показывать окно результата.
Если указаны и
fn, и module, выполняется fn.Если не указан ни один из них, показывается ошибка.
|
Режим fn
id: show-record-id
type: script
name:
ru: Показать id
config:
fn: alert(record.id); return true;
Код из fn оборачивается в функцию и выполняется через eval:
await eval(`(function() { ${config.fn} })();`);
В коде доступны переменные:
record- текущая запись (record.id,record.load(...));action- конфигурация действия;context- контекст выполнения;config- конфигурация действия (action.config).
Перед выполнением в конфигурацию подставляются атрибуты записи, поэтому вставки вида ${attribute_name} в тексте fn разворачиваются до вызова eval.
Примечание
Обёртка - обычная, не async функция, поэтому await внутри fn вызовет синтаксическую ошибку. Для асинхронной логики верните Promise - действие дождётся его выполнения:
return record.load('status?str').then(s => s === 'done');
Результат действия зависит от того, что вернул код:
Что вернул код |
Результат действия |
|---|---|
|
это значение |
ничего ( |
|
любое другое значение |
возвращается как есть |
исключение |
|
Если результат - объект { type, data } с type из списка msg, info, error, link, results, открывается окно результата. Чтобы его отключить, укажите noResultModal: true.
После выполнения запись обновляется; при истинном результате отправляется событие RECORD_ACTION_COMPLETED. Если в действии настроен confirm, перед выполнением показывается диалог подтверждения.
Режим module
type: script
config:
module: /path/to/module.js
Модуль загружается, затем вызывается module.default.execute({ record, action, context }):
вернулся Promise - действие дожидается его; если Promise отклонён, показывается уведомление об ошибке, а результат -
true;вернулось пустое значение - результат
true;модуль не загрузился - уведомление об ошибке, результат
false.
Предупреждение
Режим module может не работать для обычного ES-модуля с export default { execute }: при загрузке default извлекается дважды, и действие завершается уведомлением об ошибке с результатом false (поведение не проверено на живом модуле).
Пути, начинающиеся с /js/, загружаются как классический <script>, и модуль ищется в window только по фиксированному списку имён (quill, ckeditor, ace, mermaid). Произвольный скрипт по такому пути не будет найден.
Надёжно работает режим fn - рекомендуется использовать его.
view-business-process
id типа: view-business-process
Описание |
Конфигурация |
|---|---|
Просмотреть Бизнес-процесс
(окно с превью процесса и доп. действиями).
|
workflowFromRecord [true/ false] - поле верхнего уровня действия, вне
config.
|
Пример выполнения для процесса, связанного с записью:
{
"id": "show-related-process",
"type": "view-business-process",
"workflowFromRecord": true
}
Исполнитель читает именно action.workflowFromRecord. При загрузке через общий список доступных действий это дополнительное поле не запрашивается; для такого вызова его нужно передать в модель из кода. config.workflowFromRecord не заменяет это поле.
mutate
id типа: mutate
Описание |
Конфигурация |
|---|---|
Внесение изменений без участия пользователя посредством передачи атрибутов.
Доступно для
execForRecord, execForRecords |
config:
record:
id: ${recordRef}
attributes:
key: value
implSourceId - альтернативный режим: источник серверного RecordsDAO, например
my-app/my-action. Завершающий @ не указывается — исполнитель добавляет его сам.record.id - необязательный параметр
record.attributes - изменяемые поля и их значения
|
Без implSourceId изменяются атрибуты record.id из конфигурации или текущей записи. В групповом режиме подстановки разворачиваются отдельно для каждой записи.
Если задан implSourceId, серверному обработчику передаются records (массив ссылок), attributes (значение config.record.attributes) и actionConfig (весь config). Ответ сервера становится результатом действия; он может содержать ссылку на файл, сообщение или таблицу результатов. Режим execForQuery не реализован.
Пример: Настройка группового действия Изменить инициатора
В журнале перейти во вкладку «Действия»:
п/п |
Наименование |
Описание |
Пример заполнения |
|---|---|---|---|
1 |
Id |
уникальный идентификатор |
guide-action |
2 |
Имя |
наименование действия |
Изменить инициатора |
3 |
Тип |
тип действия |
mutate |
4 |
Ключ |
ключ конфигурации |
|
5 |
Значение |
значение конфигурации |
|
6 |
Форма |
выбрать форму ввода данных |
Изменить инициатора (form-action-guide) |
7 |
Ключ |
ключ параметра формы подтверждения |
|
8 |
Значение |
значение параметра формы подтверждения |
|
9 |
Применимость |
Применить для одной или выбранных записей. См. подробно |
|
Пользователь отмечает некоторые строки в журнале и выбирает в выпадающем меню над журналом действие:
Открывается форма для уточнения значений атрибута для выполнения действия и нажимает кнопку:
Пример: Настройка действия Изменить статус
Конфиг действия:
{
"id": "change-status",
"name": {
"ru": "Изменить статус",
"en": "Change status"
},
"confirm":{
"title": {
"ru": "Изменить",
"en": "Change"
},
"message":{},
"formRef":"uiserv/form@change-status-form",
"formAttributes":{},
"attributesMapping":{
"record.attributes._status": "statuses"
}
},
"type": "mutate",
"config": {
"record": {
"id": "${recordRef}",
"attributes": {}
}
}
}
Форма, которая предлагается пользователю:
Через компонент Async Data добавляются статусы типа данных:
Настройки компонента ECOS Select:
Скрипт для перебора массива для получения id статуса:
var statuses = _.get(data, "stats.statuses");
var arr = [];
for(var i = 0; i < statuses.length; i++) {
var id = statuses[i].id;
arr.push(id);
}
values = arr;
Полученные статусы в форме локализуются:
Действие в интерфейсе:
Пример: Настройка группового действия Выгрузить данные в файл
Пример группового действия для выгрузки в txt файл некоторых данных из выбранных записей (в примере - _created) с возможностью скачивания.
Конфиг действия:
id: example-unload-to-file
type: mutate
name:
ru: Выгрузить в файл
en: Unload
confirm:
title:
ru: Подтвердите действие
en: Confirm the action
message:
ru: Выгрузить в файл
en: Unload
config:
implSourceId: ЗДЕСЬ_ARTIFACTID_ВАШЕГО_ПРОЕКТА/example-unload
features:
execForQuery: false
execForRecord: true
execForRecords: true
RecordsDAO для действия (метод getId() должен возвращать значение из implSourceId в конфигурации):
import lombok.extern.slf4j.Slf4j;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import ru.citeck.ecos.commons.data.DataValue;
import ru.citeck.ecos.records3.RecordsService;
import ru.citeck.ecos.records3.record.dao.mutate.ValueMutateDao;
import ru.citeck.ecos.webapp.api.content.EcosContentApi;
import ru.citeck.ecos.webapp.api.entity.EntityRef;
import java.util.*;
@Component
@Slf4j
public class ExampleUnloadToFileRecordsDao implements ValueMutateDao<DataValue> {
private final RecordsService recordsService;
private final EcosContentApi contentApi;
@Autowired
public ExampleUnloadToFileRecordsDao(RecordsService recordsService, EcosContentApi contentApi) {
this.recordsService = recordsService;
this.contentApi = contentApi;
}
@NotNull
@Override
public String getId() {
return "example-unload";
}
@Nullable
@Override
public Object mutate(@NotNull DataValue selectedRecords) throws Exception {
List<String> recordRefs = selectedRecords.get("records").asList(String.class);
List<String> data = new ArrayList<>(Collections.emptyList());
for (String record : recordRefs) {
data.add(recordsService.getAtt(record,"_created").asText());
}
EntityRef tempRef = contentApi.uploadTempFile()
.writeContent(writer -> {
writer.writeText(data.toString());
return null;
});
String url = recordsService.getAtt(tempRef, "_content.url").asText();
return DataValue.createObj()
.set("type", "link")
.set("data", DataValue.createObj()
.set("url", url)
);
}
}
В интерфейсе при активации действия из выбранных записей были получены их _created и записаны в файл, который доступен для скачивания:
Подробнее о EcosContentApi
Пример: Действие для вывода в консоль информации о данных
Конфиг действия:
{
"id": "print-to-console",
"name": {
"ru": "Вывести в консоль",
"en": "Print to console"
},
"confirm": {
"title": {
"ru": "Подтвердите действие",
"en": "Confirm the action"
},
"message": {
"ru": "Вывести в консоль",
"en": "Print to console"
},
"formRef": "",
"formAttributes": {},
"attributesMapping": {}
},
"type": "mutate",
"config": {
"record": {
"id": "minimal-webapp/print-to-console@",
"attributes": {
"employee": "${employee}",
"position": "${position}",
"start_date": "${start_date}"
}
}
},
"features": {
"execForRecords": false,
"execForQuery": false,
"execForRecord": true
}
}
DTO для необходимого набора данных - SalaryDataDto.java
package ru.citeck.ecos.webapp.sample.minimal.dto;
import lombok.Data;
import java.util.Date;
@Data
public class SalaryDataDto {
private String employee;
private String position;
private Date start_date;
}
И DAO класс, который будет все это обрабатывать - JavaPrintToConsoleRecordsDao.java
package ru.citeck.ecos.webapp.sample.minimal.service.java.action;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.springframework.stereotype.Component;
import ru.citeck.ecos.records3.record.dao.mutate.ValueMutateDao;
import ru.citeck.ecos.webapp.sample.minimal.dto.SalaryDataDto;
@Component
public class JavaPrintToConsoleRecordsDao implements ValueMutateDao<SalaryDataDto> {
@NotNull
@Override
public String getId() {
return "print-to-console";
}
@Nullable
@Override
public Object mutate(@NotNull SalaryDataDto salaryDataRecord) {
String salaryInfo = String.format("Сотрудник: %s%nДолжность: %s%nДата приема: %s%n",
salaryDataRecord.getEmployee(), salaryDataRecord.getPosition(), salaryDataRecord.getStart_date());
System.out.println("###################\n");
System.out.println(salaryInfo);
System.out.println("###################");
return null;
}
}
Обратите внимание, связь между конфигой и обработчиком осуществляется за счет указания ID обработчика в конфиге.
Пример: Групповое действие с выгрузкой данных в файл
Конфиг действия:
{
"id": "unload-salary-data-to-file",
"name": {
"ru": "Выгрузить в файл",
"en": "Unload to file"
},
"confirm": {
"title": {
"ru": "Подтвердите действие",
"en": "Confirm the action"
},
"message": {
"ru": "Выгрузить в файл",
"en": "Unload to file"
},
"formRef": "",
"formAttributes": {},
"attributesMapping": {}
},
"type": "mutate",
"config": {
"implSourceId": "minimal-webapp/unload-to-file"
},
"features": {
"execForRecords": true,
"execForQuery": false,
"execForRecord": false
}
}
DAO класс - JavaUnloadToFileRecordsDao.java
package ru.citeck.ecos.webapp.sample.minimal.service.java.action;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import ru.citeck.ecos.commons.data.DataValue;
import ru.citeck.ecos.records3.RecordsService;
import ru.citeck.ecos.records3.record.dao.mutate.ValueMutateDao;
import ru.citeck.ecos.webapp.api.content.EcosContentApi;
import ru.citeck.ecos.webapp.api.entity.EntityRef;
import java.util.Date;
import java.util.List;
@Component
public class JavaUnloadToFileRecordsDao implements ValueMutateDao<DataValue> {
private final RecordsService recordsService;
private final EcosContentApi contentApi;
@Autowired
public JavaUnloadToFileRecordsDao(RecordsService recordsService, EcosContentApi contentApi) {
this.recordsService = recordsService;
this.contentApi = contentApi;
}
@NotNull
@Override
public String getId() {
return "unload-to-file";
}
@Nullable
@Override
public Object mutate(@NotNull DataValue selectedRecords) {
List<String> recordRefs = selectedRecords.get("records").asList(String.class);
List<SalaryRecordData> salaryRecordsData = recordsService.getAtts(recordRefs, SalaryRecordData.class);
String salaryDataAsPrettyString = formatSalaryDataList(salaryRecordsData);
EntityRef tempRef = contentApi.uploadTempFile()
.writeContentJ(writer -> {
writer.writeText(salaryDataAsPrettyString);
});
String url = recordsService.getAtt(tempRef, "_content.url").asText();
return DataValue.createObj()
.set("type", "link")
.set("data", DataValue.createObj()
.set("url", url)
);
}
public String formatSalaryDataList(List<SalaryRecordData> salaryRecordsData) {
StringBuilder sb = new StringBuilder();
for (SalaryRecordData record : salaryRecordsData) {
sb.append("\nСотрудник: ").append(record.getEmployee()).append(",\n");
sb.append("Должность: ").append(record.getPosition()).append(",\n");
sb.append("Дата приема: ").append(record.getStart_date()).append(",\n\n");
}
sb.append("\n");
return sb.toString();
}
@Data
@NoArgsConstructor
@AllArgsConstructor
static class SalaryRecordData {
private String employee;
private String position;
private Date start_date;
}
}
task-outcome
id типа: task-outcome
Описание |
Конфигурация |
|---|---|
Действие используется в связке с
tasks-actions.Действие связано с бизнес-процессом записи.
|
label - заголовок варианта завершения задачи
outcome - идентификатор варианта завершения задачи
formRef - ссылка на форму задачи, полученная от
uiserv/task-form.taskRef - полная ссылка на задачу, например
eproc/wftask@flowable$12345.hideConfirmEmptyForm: Bool - не показывать подтверждение, если у формы нет полей ввода.
|
tasks-actions
id типа: tasks-actions
Описание |
Конфигурация |
|---|---|
Действие для загрузки вариантов завершения задач
|
На выходе для каждой задачи получается основное действие и
variants с типом task-outcome где перечислены варианты завершенияСписок задач и вариантов завершения загружается с сервера через
uiserv/task-form с языком запроса tasks. Отбор задач по правам и получение outcomes определяет сервер.Фронтенд преобразует полученные outcomes в варианты
task-outcome. Если у задачи нет outcomes, создаётся действие open-task-actions.Если у задачи на форме есть поля, то показывается всплывающая форма с этими полями:
Если у задачи на форме нет полей, то показывается следующее окно:
Если форма пустая и в конфигурации для tasks-actions задано как
hideConfirmEmptyForm=true, окно не появляется, форма выполняется, действие завершается, уведомление, если успешно, появляется.
При выполнение вариантов действия, в каждый вариант передаются некоторые конфигурации:
то есть
config из tasks-actions передается в task-outcome.При этом у
task-outcome может быть свой конфиг, который может перезаписать прошедшие настройки. |
Дополнительные параметры tasks-actions.config:
evalOutcomesForTasks— передаётся в серверный запрос задач;isViewTaskInfoInModal— используется для просмотра информации о задаче без вариантов завершения; по умолчаниюfalse.
open-submit-form
id типа: open-submit-form
Описание |
Конфигурация |
|---|---|
Вызов формы редактирования с попыткой отправить в рассмотрение.
Действие связано с бизнес-процессом записи.
|
Если все поля заполнены корректны, форма отправляется и закрывается.
Иначе отображается список ошибок, после их исправления отправление вручную.
config.formId - необязательный параметр; без указания загружается форма по умолчанию.
|
user-event
id типа: user-event
Для формирования пользовательских эвентов и возможности на них реагировать в BPMN добавлен новый тип действия user-event, которое кидает ecos-event.
Например:
---
id: user-event-action1
name:
ru: Пользовательское действие 1
en: User event action 1
type: user-event
config:
record: ${?id}
eventData:
priority: 1
counterpartInitiator: ${counterparty.initiator}
counterpartyRef: ${counterparty?id}
house:
kitchen: red
livingRoom: blue
В итоге в системе будет сформирован ecos event:
Тип. Всегда равен id действия. В данном случае user-event-action1
Рекорд, по которому произошел эвент. Задаётся в
record;${?id}означает текущий документ, из которого вызывается действие. Если record не указан, эвент глобальный (не привязан к конкретному рекорду).Полезная нагрузка эвента. Все, что указано в eventData. На первом уровне атрибутов можно передавать данные в виде entityRef, для этого можно воспользоваться синтаксисом ${some_attribute?id}.
Другие типы и их параметры
Ниже приведены параметры типов, перечисленных в обзоре. Настройки серверных операций должны соответствовать возможностям целевого сервиса.
Тип |
Режимы |
Параметры и поведение |
|---|---|---|
|
Одна запись |
|
|
Одна запись |
|
|
Одна запись |
Находит настройки типа |
|
Одна запись |
Открывает настройки прав типа. Собственные параметры config не требуются. |
|
Одна запись |
Запрашивает новый идентификатор и сохраняет копию. Из кода можно передать |
|
Одна запись |
Копирует ECOS-модуль, используя его |
|
Одна запись |
Отлаживает форму текущей записи. |
|
Выбранные записи |
|
|
Выбранные записи / запрос |
|
|
Выбранные записи / запрос |
Legacy-механизм серверных групповых действий. Весь config используется как модель группового действия; поддерживает |
|
Одна запись / выбранные записи / запрос |
|
attribute-actions
id типа: attribute-actions; алиас: record-actions.
Это обработчик раскрытия списка действий, а не исполнитель операции. Он загружает действия из атрибута каждой записи. Параметр config.attribute по умолчанию равен _actions. Поддерживается режим для одной записи; из атрибута загружаются поля действий, включая config, features и confirm.
{
"id": "load-record-actions",
"type": "attribute-actions",
"config": {
"attribute": "_actions"
}
}
Legacy-действия кейсов
В реестре также присутствуют типы совместимости для кейсов. Они выполняются для одной записи:
CREATE_NODE— передаёт config в создание узла пользовательского действия; в options формы передаётсяactionRecord;REDIRECT— открываетconfig.urlсconfig.target(по умолчанию_self). Значениеconfig.context: PAGECONTEXTдобавляет префикс/share/page/;REQUEST— отправляет запрос через прокси Alfresco с параметрамиconfig.urlиconfig.requestMethod.config.confirmationMessageзадаёт подтверждение; после успешного выполнения страница перезагружается.
Типы без дополнительных параметров
Для действий ниже собственные параметры config не требуются. Исключения и ограничения указаны в описании:
open-in-background
Открыть запись в новой фоновой вкладке.
Наследует параметры
view, принудительно устанавливаяbackground: true. Остальные поляconfigсохраняются.
upload-new-version
Загрузка новой версии документа.
cancel-business-process
Отменить бизнес-процесс.
change-user-password
Обработчик зарегистрирован, но методы выполнения в текущем ecos-ui не реализованы. Общий механизм отключает все режимы; использовать этот тип для смены пароля нельзя.
edit-menu
Запустить редактор конфигурации меню.
Действие для версии конфигурации > 0.
view-menu
Открыть конфигурацию меню с отключённым редактированием.
Действие для версии конфигурации > 0.
Преобразование контента
Фронтенд регистрирует transform без проверки лицензии. Доступность серверных преобразований и их лицензионные ограничения определяются сервисом transformations.
transform
id типа: transform
Описание |
Конфигурация |
|---|---|
Трансформация содержимого по заданным правилам и его скачивание или загрузка в атрибут с типом «контент»
|
input: Object // источник содержимого. По умолчанию - основное содержимое текущего документа;
transformations: Object[] // описание трансформаций;
output: Object // цель для результата трансформации. По умолчанию - временный файл, контент которого сразу же скачивается.
Подробнее о возможных настройках input, transformations и output можно прочитать здесь
Пример:
1. Сконвертировать содержимое в PDF и скачать:
|
Пример: Настройка действия Скачать с штрихкод
Конфиг действия:
{
"id": "test-action-transform",
"name": {
"ru": "Скачать с штрих-код",
"en": "Download with barcode"
},
"type": "transform",
"config": {
"transformations": [
{
"type": "convert",
"config": {
"toMimeType": "application/pdf"
}
},
{
"type": "barcode",
"config": {
"entityRef": "${?id}",
"layout": "BOTTOM_RIGHT",
"pages": "ALL"
}
}
]
}
}
layout - выбор положения баркода с возможными значениями: TOP_LEFT, TOP_CENTER, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT
До добавления действия в тип данных необходимо:
добавить аспект Имеет штрих-код в тип данных;
добавить шаблон нумерации в тип данных.