Элементы-расширения BPMN OpenBPM

Этот раздел перенесён из документации Camunda 7 и в дальнейшем будет доработан с учётом особенностей OpenBPM Engine

Ниже перечислены элементы-расширения для пространства имён camunda http://camunda.org/schema/1.0/bpmn.

connector

Описание

Конфигурация коннектора OpenBPM.

Атрибуты

Ограничения

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

Родительские элементы

Дочерние элементы

connectorId

Описание

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

Атрибуты

Ограничения

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

Родительские элементы

Дочерние элементы

constraint

Описание

Метаданные отдельного ограничения валидации для поля формы (см. Form Field Validation).

Атрибуты

name

Имя типа ограничения поля формы

config

Конфигурация типа ограничения поля формы

Ограничения

Атрибут name должен быть одним из известных валидаторов (required, minlength, maxlength, min, max, readonly или validator)

Родительские элементы

Дочерние элементы

entry

Описание

Отдельная запись структуры map. Значением может быть константа, выражение, скрипт, list или другой map.

Атрибуты

key

Ключ записи в map. Может быть строкой или выражением.

Ограничения

Атрибут key обязателен

Родительские элементы

errorEventDefinition

Описание

Определение события ошибки, которое может быть инициировано выражением. Этот элемент расширяет элемент errorEventDefinition из пространства имён bpmn, наследуя все его атрибуты: id, errorRef

Атрибуты

expression

Выражение, которое инициирует ошибку, если вычисляется в true.

Ограничения

Атрибут errorRef обязателен

Родительские элементы

executionListener

Описание

Добавляет слушатель выполнения к событию.

Атрибуты

event

Тип события, для которого вызывается слушатель

class

см. camunda:class

expression

см. camunda:expression

delegateExpression

см. camunda:delegateExpression

Ограничения

  • Атрибут event обязателен (кроме переходов) и должен быть одним из событий задачи: start или end

  • Один из атрибутов class, expression или delegateExpression является обязательным

Родительские элементы

expression

Описание

Задаёт выражение для внедрения в делегированные классы (см. Field Injection).

Атрибуты

Текстовое содержимое

Внедряемое выражение

Ограничения

Родительские элементы

Дочерние элементы

failedJobRetryTimeCycle

Описание

Задаёт пользовательское расписание повторных попыток для упавшего джоба (см. Failed Jobs).

Атрибуты

Текстовое содержимое

Значение или выражение цикла времени повторных попыток

Ограничения

Родительские элементы

Дочерние элементы

field

Описание

Задаёт значение для внедрения в делегированные классы (см. Field Injection).

Атрибуты

name

Имя поля

expression

Значение поля в виде выражения

stringValue

Значение поля в виде String

Ограничения

Может использоваться только один из атрибутов stringValue и expression либо один из дочерних элементов string и expression

Родительские элементы

formData

Описание

Метаданные для определения полей формы, которые используются для генерации форм задач (см. Generated Task Forms).

Атрибуты

Ограничения

Родительские элементы

Дочерние элементы

formField

Описание

Метаданные для определения отдельного поля формы (см. Generated Task Forms).

Атрибуты

id

Идентификатор поля формы, соответствующий имени переменной процесса

label

Подпись, отображаемая рядом с полем формы

type

Тип поля формы

datePattern

Шаблон поля формы типа date

defaultValue

Значение, используемое по умолчанию (предварительный выбор) для поля

Ограничения

  • Атрибут id не может быть пустым

  • Атрибут type может быть одним из известных типов полей формы (string, long, boolean, date или enum) либо пользовательским

  • Атрибут datePattern можно использовать, только если атрибут type установлен в date

  • Дочерний элемент camunda:properties допускается только один раз

  • Дочерний элемент camunda:validation допускается только один раз

  • Дочерние элементы camunda:values можно использовать, только если атрибут type установлен в enum

Родительские элементы

Дочерние элементы

formProperty

Описание

Метаданные для определения поля формы (устарело, используйте camunda:formData).

Атрибуты

id

Ключ, используемый для отправки свойства через API

name

Отображаемая подпись свойства

type

Тип свойства

required

True, если поле формы обязательно (по умолчанию: false)

readable

True, если поле формы доступно для чтения и будет отображаться (по умолчанию: true)

writeable

True, если поле формы доступно для записи (по умолчанию: true)

variable

Задаёт переменную процесса, на которую отображается переменная

expression

Задаёт выражение, отображающее свойство, например ${street.address}

datePattern

Шаблон поля формы типа date

default

Значение по умолчанию или выражение свойства

Ограничения

  • Атрибут id обязателен

  • Атрибут type может быть одним из известных типов (string, long, boolean, date или enum) либо пользовательским

  • Атрибут datePattern можно использовать, только если атрибут type установлен в date

  • Дочерние элементы camunda:values можно использовать, только если атрибут type установлен в enum

Родительские элементы

in

Описание

Элемент задаёт переменные, которые должны быть переданы в подпроцесс; подробнее см. passing variables.

Атрибуты

source

Имя передаваемой переменной процесса

sourceExpression

Выражение, которое будет вычислено и передано

variables

Можно установить в all, чтобы передать все переменные процесса

target

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

local

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

businessKey

Задаёт бизнес-ключ экземпляра процесса подпроцесса

Ограничения

  • Может использоваться только один из атрибутов source, sourceExpression, variables или businessKey

  • Атрибут target обязателен, если используется атрибут source или sourceExpression

Родительские элементы

inputParameter

Описание

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

Атрибуты

name

Имя переменной внутри активности.

Ограничения

  • Атрибут name обязателен.

  • Элемент может иметь один дочерний элемент, константную строку или выражение в качестве текстового содержимого.

Родительские элементы

camunda:inputOutput

Дочерние элементы

inputOutput

Описание

Элемент описывает входное/выходное отображение для активности.

Атрибуты

Ограничения

Родительские элементы

Дочерние элементы

list

Описание

Структура list. Если list содержит несколько значений, их следует добавлять как текстовое содержимое дочерних элементов. Какие дочерние элементы использовать — произвольно, например:

<camunda:list>
  <camunda:value>one</camunda:value>
  <camunda:value>two</camunda:value>
  <camunda:value>three</camunda:value>
</camunda:list>

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

Атрибуты

Ограничения

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

Родительские элементы

Дочерние элементы

Любой дочерний элемент, camunda:list, camunda:map

map

Описание

Структура map. Записями могут быть константы, выражения, скрипты, вложенные map и list.

Атрибуты

Ограничения

Родительские элементы

Дочерние элементы

out

Описание

Элемент задаёт переменные, которые должны быть переданы обратно из подпроцесса; подробнее см. passing variables.

Атрибуты

source

Имя переменной процесса, передаваемой обратно

sourceExpression

Выражение, которое будет вычислено и передано обратно

variables

Можно установить в all, чтобы передать обратно все переменные подпроцесса

target

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

local

Можно установить в true, чтобы передавать переменные из вызванного экземпляра case/процесса в локальные переменные выполнения, запускающего операцию вызова.

Ограничения

  • Может использоваться только один из атрибутов source, sourceExpression или variables

  • Атрибут target обязателен, если используется атрибут source или sourceExpression

Родительские элементы

Дочерние элементы

outputParameter

Описание

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

Атрибуты

name

Имя переменной вне активности.

Ограничения

  • Атрибут name обязателен.

  • Элемент может иметь один дочерний элемент, константную строку или выражение в качестве текстового содержимого.

Родительские элементы

camunda:inputOutput

Дочерние элементы

potentialStarter

Описание

Задаёт, какие пользователи или группы могут запускать процесс.

Атрибуты

Ограничения

Родительские элементы

Process

Дочерние элементы

resourceAssignmentExpression

properties

Описание

Список свойств в виде пар «ключ — значение», который может интерпретироваться произвольно.

Атрибуты

Ограничения

Родительские элементы

Base Element, camunda:formField

Дочерние элементы

property

Описание

Пара «ключ — значение», которая может интерпретироваться произвольно.

Атрибуты

id

Идентификатор свойства поля формы

name

Имя свойства

value

Значение свойства

Ограничения

  • Если свойство принадлежит элементу-расширению camunda:formField, используются только атрибуты id и value.

  • Если родительский элемент camunda:properties добавлен непосредственно как элемент-расширение, например через Camunda Modeler, используются только атрибуты name и value.

Родительские элементы

Дочерние элементы

script

Описание

Элемент скрипта. Скрипт выполняется, а возвращаемое значение используется как значение отображения.

Атрибуты

scriptFormat

Идентификатор формата, обычно язык исходного кода скрипта

resource

эквивалент camunda:resource

Ограничения

  • Атрибут scriptFormat обязателен

  • Если используется атрибут resource, текстовое содержимое с исходным кодом не допускается

Родительские элементы

string

Описание

Задаёт значение String для внедрения в делегированные классы (см. Field Injection).

Атрибуты

Текстовое содержимое

Внедряемое значение String

Ограничения

Родительские элементы

Дочерние элементы

taskListener

Описание

Добавляет слушатель задачи к событию задачи.

Атрибуты

event

Тип события, для которого вызывается слушатель

class

см. camunda:class

expression

см. camunda:expression

delegateExpression

см. camunda:delegateExpression

id

Идентификатор слушателя задачи в родительской области видимости, требуется только когда event установлен в timeout

Ограничения

  • Атрибут event обязателен и должен быть одним из событий задачи: create, assignment, update, complete, delete или timeout

  • Один из атрибутов class, expression или delegateExpression является обязательным

  • Если атрибут event установлен в timeout, обязательны атрибут id и ровно один дочерний элемент типа timerEventDefinition

Родительские элементы

validation

Описание

Метаданные для определения списка ограничений валидации для полей формы (см. Form Field Validation).

Атрибуты

Ограничения

Родительские элементы

Дочерние элементы

value

Описание

Возможные значения поля формы с типом enum.

Атрибуты

id

Идентификатор значения

name

Имя значения

Ограничения

Родительские элементы

Дочерние элементы

Лицензия и атрибуция

Эта документация была создана на базе материала "Camunda 7 Docs" от Camunda, находится под лицензией Creative Commons Attribution-ShareAlike 3.0 Unported License .

Оригинал документации: https://docs.camunda.org