Атрибуты-расширения BPMN OpenBPM

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

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

assignee

Описание

Атрибут задаёт исполнителя-человека для User Task.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Имя исполнителя в виде java.lang.String или выражение, вычисляемое в java.lang.String, например $\{initiator}

Значение по умолчанию

Элементы BPMN 2.0

asyncAfter

Описание

Задаёт асинхронное продолжение после активности; подробнее см. Асинхронные продолжения.

Тип

java.lang.Boolean

Возможные значения

true, false

Значение по умолчанию

false

Элементы BPMN 2.0

asyncBefore

Описание

Задаёт асинхронное продолжение перед активностью; подробнее см. Асинхронные продолжения.

Тип

java.lang.Boolean

Возможные значения

true, false

Значение по умолчанию

false

Элементы BPMN 2.0

calledElementBinding

Описание

Атрибут задаёт, какую версию определения процесса подпроцесса вызывает операция вызова. Если значение равно version, требуется атрибут camunda:calledElementVersion. Если значение равно versionTag, требуется атрибут camunda:calledElementVersionTag. Подробнее см. Called Element Binding.

Тип

java.lang.String

Возможные значения

latest, deployment, version, versionTag

Значение по умолчанию

latest

Элементы BPMN 2.0

calledElementVersion

Описание

Атрибут задаёт, какую версию определения процесса подпроцесса вызывает операция вызова, если camunda:calledElementBinding установлен в version; подробнее см. Called Element Binding.

Тип

java.lang.Integer or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Конкретная версия из всех задеплоенных номеров версий вызываемого подпроцесса в виде java.lang.Integer или выражение, вычисляемое в java.lang.Integer, например $\{versionToCall}

Значение по умолчанию

Элементы BPMN 2.0

calledElementVersionTag

Описание

Атрибут задаёт, какой тег версии определения процесса подпроцесса вызывает операция вызова, если camunda:calledElementBinding установлен в versionTag; подробнее см. Called Element Binding.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Конкретный тег версии из всех задеплоенных номеров версий вызываемого подпроцесса в виде java.lang.String или выражение, вычисляемое в java.lang.String, например $\{versionTagToCall}

Значение по умолчанию

Элементы BPMN 2.0

calledElementTenantId

Описание

Атрибут задаёт идентификатор арендатора определения процесса, который должен быть разрешён операцией вызова; подробнее см. Called Element Tenant Id.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Конкретный идентификатор арендатора или выражение, вычисляемое в java.lang.String, например ${execution.tenantId}

Значение по умолчанию

Элементы BPMN 2.0

candidateGroups

Описание

Атрибут задаёт, какие группы будут кандидатами на выполнение User Task.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Список идентификаторов групп через запятую в виде java.lang.String либо выражения, вычисляемые в java.lang.String или в java.util.Collection из java.lang.String, например management или management, ${accountancyGroupId()}

Значение по умолчанию

Элементы BPMN 2.0

candidateStarterGroups

Описание

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

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Список идентификаторов групп через запятую в виде java.lang.String либо выражения, вычисляемые в java.lang.String или в java.util.Collection из java.lang.String, например management или management, ${accountancyGroupId()}

Значение по умолчанию

Элементы BPMN 2.0

Process

candidateStarterUsers

Описание

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

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Список идентификаторов пользователей через запятую в виде java.lang.String либо выражения, вычисляемые в java.lang.String или в java.util.Collection из java.lang.String, например kermit, gonzo или ${ldapService.findAllSales()}

Значение по умолчанию

Элементы BPMN 2.0

Process

candidateUsers

Описание

Атрибут задаёт, какие пользователи будут кандидатами на выполнение User Task.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Список идентификаторов пользователей через запятую в виде java.lang.String либо выражения, вычисляемые в java.lang.String или в java.util.Collection из java.lang.String, например kermit, gonzo или ${ldapService.findAllSales()}

Значение по умолчанию

Элементы BPMN 2.0

caseBinding

Описание

Атрибут задаёт, какую версию определения case подчинённого case вызывает операция вызова. Если значение равно version, требуется атрибут camunda:caseVersion; подробнее см. Case Binding.

Тип

java.lang.String

Возможные значения

latest, deployment, version

Значение по умолчанию

Элементы BPMN 2.0

caseRef

Описание

Атрибут ссылается на вызываемое определение case по его ключу.

Тип

java.lang.String

Возможные значения

Значение по умолчанию

Элементы BPMN 2.0

caseVersion

Описание

Атрибут задаёт, какую версию определения case подчинённого case вызывает операция вызова, если camunda:caseBinding установлен в version; подробнее см. Case Binding.

Тип

java.lang.Integer

Возможные значения

Все задеплоенные номера версий вызываемого подпроцесса

Значение по умолчанию

Элементы BPMN 2.0

caseTenantId

Описание

Атрибут задаёт идентификатор арендатора определения case, который должен быть разрешён операцией вызова; подробнее см. Case Tenant Id.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Конкретный идентификатор арендатора или выражение, вычисляемое в java.lang.String, например ${execution.tenantId}

Значение по умолчанию

Элементы BPMN 2.0

class

Описание

Атрибут задаёт, какой Java-класс будет выполнен во время исполнения. Указанный класс должен реализовывать интерфейс Java delegate.

Тип

java.lang.String

Возможные значения

Полное имя Java-класса, реализующего интерфейс Java Delegate, например io.openbpm.bpm.MyJavaDelegate

Значение по умолчанию

Элементы BPMN 2.0

collection

Описание

Атрибут задаёт коллекцию, для каждого элемента которой будет создан отдельный экземпляр; подробнее см. Multiple Instance.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Имя переменной процесса типа java.util.Collection в виде java.lang.String или выражение, вычисляемое в имя коллекции

Значение по умолчанию

Элементы BPMN 2.0

decisionRef

Описание

Атрибут ссылается на вычисляемое определение решения по его ключу.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Строка или выражение, вычисляемое в ключ определения решения, которое должна вычислить эта задача, например myDecisionDefinitionKey или $\{decisionKey}

Значение по умолчанию

Элементы BPMN 2.0

decisionRefBinding

Описание

Атрибут задаёт, какую версию определения решения вычисляет задача. Если значение равно version, требуется атрибут camunda:decisionRefVersion. Если значение равно versionTag, требуется атрибут camunda:decisionRefVersionTag.

Тип

java.lang.String

Возможные значения

latest, deployment, version, versionTag

Значение по умолчанию

latest

Элементы BPMN 2.0

decisionRefVersion

Описание

Атрибут задаёт, какую версию определения решения вычисляет задача, если camunda:decisionRefBinding установлен в version.

Тип

java.lang.Integer or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Конкретная версия из всех задеплоенных номеров версий вызываемого решения в виде java.lang.Integer или выражение, вычисляемое в java.lang.Integer, например $\{versionToCall}

Значение по умолчанию

Элементы BPMN 2.0

decisionRefVersionTag

Описание

Атрибут задаёт, какой тег версии определения решения вычисляет задача, если camunda:decisionRefBinding установлен в versionTag.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Конкретный тег версии из всех задеплоенных тегов версий вызываемого решения в виде java.lang.String или выражение, вычисляемое в java.lang.String, например $\{versionTagToCall}

Значение по умолчанию

Элементы BPMN 2.0

decisionRefTenantId

Описание

Атрибут задаёт идентификатор арендатора определения решения, который должен быть разрешён задачей бизнес-правила; подробнее см. DecisionRef Tenant Id.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Конкретный идентификатор арендатора или выражение, вычисляемое в java.lang.String, например ${execution.tenantId}

Значение по умолчанию

Элементы BPMN 2.0

delegateExpression

Описание

Атрибут позволяет задать выражение, которое должно разрешаться в объект, реализующий соответствующий интерфейс (см. delegation code).

Тип

io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Выражение, вычисляемое в Java-класс, реализующий интерфейс delegation, например $\{myJavaDelegate} или #\{myTaskListener}

Значение по умолчанию

Элементы BPMN 2.0

dueDate

Описание

Атрибут задаёт начальный срок выполнения User Task при её создании.

Тип

io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Выражение, вычисляемое в java.util.Date, java.util.String (в формате ISO 8601) или null, например $\{dateVariable}

Значение по умолчанию

Элементы BPMN 2.0

elementVariable

Описание

Атрибут задаёт переменную процесса, которая будет установлена для каждого созданного экземпляра и будет содержать элемент указанной коллекции; подробнее см. Multiple Instance.

Тип

java.lang.String

Возможные значения

Имя переменной процесса в виде java.lang.String

Значение по умолчанию

Элементы BPMN 2.0

errorMessage

Описание

Атрибут задаёт сообщение с дополнительной информацией об ошибке. Когда стартовое или граничное событие ошибки перехватывает ошибку, это сообщение сохраняется в переменную процесса, если настроен errorMessageVariable. Подробнее см. Error Events.

Тип

java.lang.String

Возможные значения

Сообщение об ошибке в виде java.lang.String

Значение по умолчанию

Элементы BPMN 2.0

errorCodeVariable

Описание

Атрибут задаёт переменную процесса, в которой хранится код ошибки; errorCodeVariable устанавливается, если стартовое или граничное событие ошибки получило ошибку; подробнее см. Error Events.

Тип

java.lang.String

Возможные значения

Имя переменной процесса в виде java.lang.String

Значение по умолчанию

Элементы BPMN 2.0

errorMessageVariable

Описание

Атрибут задаёт переменную процесса, в которой хранится сообщение об ошибке; errorMessageVariable устанавливается, если стартовое или граничное событие ошибки получило ошибку; подробнее см. Error Events.

Тип

java.lang.String

Возможные значения

Имя переменной процесса в виде java.lang.String

Значение по умолчанию

Элементы BPMN 2.0

escalationCodeVariable

Описание

Атрибут задаёт переменную процесса, которая устанавливается, если стартовое или граничное событие эскалации получило эскалацию; подробнее см. Escalation Events.

Тип

java.lang.String

Возможные значения

Имя переменной процесса в виде java.lang.String

Значение по умолчанию

Элементы BPMN 2.0

exclusive

Описание

Атрибут указывает, что джобы должны выполняться эксклюзивно. Подробнее см. Exclusive Jobs.

Тип

java.lang.Boolean

Возможные значения

true, false

Значение по умолчанию

true

Элементы BPMN 2.0

expression

Описание

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

Тип

io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Выражение, например ${gender == 'male' ? 'Mr.' : 'Mrs.'} или #{printer.printMessage()}

Значение по умолчанию

Элементы BPMN 2.0

followUpDate

Описание

Атрибут задаёт начальную дату контрольного срока User Task при её создании.

Тип

io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Выражение, вычисляемое в java.util.Date, java.util.String (в формате ISO 8601) или null, например $\{dateVariable}

Значение по умолчанию

Элементы BPMN 2.0

formHandlerClass

Описание

Атрибут задаёт класс, который будет вызван при разборе информации о форме Start Event или User Task.

Тип

java.lang.String

Возможные значения

Полное имя Java-класса, реализующего интерфейс io.openbpm.bpm.engine.impl.form.handler.StartFormHandler или io.openbpm.bpm.engine.impl.form.handler.TaskFormHandler, например io.openbpm.bpm.MyUserTaskFormHandler

Значение по умолчанию

Элементы BPMN 2.0

Initial Start Event of a Process, User Task

formKey

Описание

Атрибут задаёт ресурс формы. Подробнее см. task forms.

Тип

java.lang.String

Возможные значения

java.lang.String с ресурсом формы, который может быть обработан компонентом Tasklist

Значение по умолчанию

Элементы BPMN 2.0

Initial Start Event of a Process, User Task

formRef

Описание

Атрибут ссылается на определение OpenBPM Form по его ключу. Подробнее см. task forms.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

java.lang.String или io.openbpm.bpm.engine.delegate.Expression, который Tasklist может вычислить для отображения указанной OpenBPM Form, например myCamundaFormDefinitionKey или ${\formKey}.

Значение по умолчанию

Элементы BPMN 2.0

Initial Start Event of a Process, User Task

formRefBinding

Описание

Атрибут задаёт, на какую версию определения OpenBPM Form ссылается активность. Если значение равно version, требуется атрибут camunda:formRefVersion.

Тип

java.lang.String

Возможные значения

latest, deployment, version

Значение по умолчанию

latest

Элементы BPMN 2.0

Initial Start Event of a Process, User Task

formRefVersion

Описание

Атрибут задаёт, на какую версию определения OpenBPM Form ссылается активность, если camunda:formRefBinding установлен в version.

Тип

java.lang.Integer or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Конкретная версия из всех задеплоенных номеров версий определения OpenBPM Form в виде java.lang.Integer или выражение, вычисляемое в java.lang.Integer, например $\{versionToReference}

Значение по умолчанию

Элементы BPMN 2.0

Initial Start Event of a Process, User Task

historyTimeToLive

Описание

Атрибут задаёт время жизни истории (в днях) для определения процесса. Используется при History cleanup.

Тип

java.lang.Integer or java.lang.String

Возможные значения

Любое неотрицательное целое число или строка, содержащая время в днях в формате даты ISO-8601.

Значение по умолчанию

null — означает, что история определения процесса никогда не будет удаляться при запуске очистки истории

Элементы BPMN 2.0

Process

initiator

Описание

Атрибут задаёт переменную процесса, в которую записывается идентификатор пользователя — инициатора процесса.

Тип

java.lang.String

Возможные значения

Имя переменной процесса для сохранения инициатора процесса

Значение по умолчанию

Элементы BPMN 2.0

Start Event of a Process

isStartableInTasklist

Описание

Атрибут задаёт, можно ли запускать процесс из Tasklist.

Тип

java.lang.Boolean

Возможные значения

true, false

Значение по умолчанию

true

Элементы BPMN 2.0

Process

jobPriority

Описание

Задаёт приоритет, который получает джоб, создаваемый в контексте выполнения данного элемента процесса (например, события-таймера или в случае asyncBefore и asyncAfter). Подробнее см. руководство Job Prioritization.

Тип

Число в диапазоне значения Java long или io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Выражение должно разрешаться в корректное значение Java long.

Значение по умолчанию

нет

Элементы BPMN 2.0

mapDecisionResult

Описание

Атрибут указывает, какой встроенный Decision Result Mapper используется для передачи результата вычисленного решения в переменную процесса. Его следует использовать вместе с camunda:resultVariable.

Тип

java.lang.String

Возможные значения

singleEntry, singleResult, collectEntries, resultList

Значение по умолчанию

resultList

Элементы BPMN 2.0

priority

Описание

Атрибут задаёт начальный приоритет User Task при её создании.

Тип

io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Выражение, вычисляемое в java.lang.Number или в java.lang.String, представляющую число, или в null, например $\{dateVariable}

Значение по умолчанию

Элементы BPMN 2.0

taskPriority

Описание

Атрибут задаёт начальный приоритет External Task при её создании.

Тип

Число в диапазоне значения Java long или io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Выражение должно разрешаться в корректное значение Java long.

Значение по умолчанию

0

Элементы BPMN 2.0

resource

Описание

Атрибут задаёт внешний ресурс. Ресурс может входить в состав деплоймента или находиться в classpath. Чтобы указать тип ресурса, можно задать префикс в виде URL-схемы deployment:// или classpath://. Если схема опущена, предполагается, что ресурс находится в classpath.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Путь к ресурсу или выражение, возвращающее путь. Путь может начинаться с URL-подобной схемы classpath:// или deployment://, указывающей, где искать ресурс. Если она опущена, предполагается, что ресурс находится в classpath.

Значение по умолчанию

Элементы BPMN 2.0

resultVariable

Описание

Атрибут задаёт переменную процесса для сохранения возвращаемого значения camunda:expression. Обратите внимание, что при использовании camunda:resultVariable в Multi-Instance-конструкции, например в Multi-Instance-подпроцессе, переменная результата перезаписывается при каждом завершении задачи, если только переменная не является локальной переменной в области видимости Multi-Instance-конструкции. Это может приводить к, казалось бы, случайному поведению. Это известная проблема. В качестве обходного решения локальную переменную можно объявить, добавив к стартовому событию подпроцесса слушатель выполнения, инициализирующий переменную значением null.

Тип

java.lang.String

Возможные значения

Имя переменной процесса для сохранения возвращаемого значения

Значение по умолчанию

Элементы BPMN 2.0

versionTag

Описание

Атрибут задаёт тег версии для определения процесса.

Тип

java.lang.String

Возможные значения

Любое значение, имеющее смысл тега версии для определения процесса. Примечание: сортировка по versionTag выполняется как по строке. Версия не интерпретируется. Например, сортировка может вернуть v0.1.0, v0.10.0, v0.2.0.

Значение по умолчанию

Элементы BPMN 2.0

Process

topic

Описание

Атрибут задаёт топик экземпляра внешней задачи. Задача будет предложена воркерам, опрашивающим этот топик. Имеет значение только тогда, когда camunda:type установлен в external.

Тип

java.lang.String or io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Любое значение, имеющее смысл идентификатора топика, в виде java.lang.String или выражение, вычисляемое в java.lang.String, например $\{topicName}

Значение по умолчанию

Элементы BPMN 2.0

type

Описание

Атрибут задаёт, какую встроенную реализацию задачи использовать. В настоящее время существуют email, shell-сервис и внешняя задача.

Тип

java.lang.String

Возможные значения

external, mail, shell

Значение по умолчанию

Элементы BPMN 2.0

variableMappingClass

Описание

Атрибут задаёт, какой Java-класс будет выполнен во время исполнения для отображения входных и выходных переменных операции вызова. Указанный класс должен реализовывать интерфейс Delegate Variable Mapping.

Тип

java.lang.String

Возможные значения

Полное имя Java-класса, реализующего интерфейс Delegate Variable Mapping, например io.openbpm.bpm.MyVariableMappingDelegate

Значение по умолчанию

Элементы BPMN 2.0

variableMappingDelegateExpression

Описание

Атрибут позволяет задать выражение, которое должно разрешаться в объект, реализующий соответствующий интерфейс Delegate Variable Mapping.

Тип

io.openbpm.bpm.engine.delegate.Expression

Возможные значения

Выражение, вычисляемое в Java-класс, реализующий интерфейс Delegate Variable Mapping, например $\{myVariableMapping}.

Значение по умолчанию

Элементы BPMN 2.0

variableName

Описание

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

Тип

java.lang.String

Возможные значения

Имя переменной процесса, при изменении которой должно вычисляться условие.

Значение по умолчанию

Элементы BPMN 2.0

variableEvents

Описание

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

Тип

java.lang.String

Возможные значения

Список событий изменения переменной через запятую. События изменения переменной: create, update и delete.

Значение по умолчанию

Элементы BPMN 2.0

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

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

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