Camunda BPMN Extension Elements
|
Этот раздел перенесён из документации Camunda 7 и в дальнейшем будет доработан с учётом особенностей OpenBPM Engine |
The following attributes are extension attributes for the camunda namespace http://camunda.org/schema/1.0/bpmn.
connector
| Description <td colspan="2"> The configuration of a camunda connector. </td> | Attributes <td colspan="2">–</td> | Constraints <td colspan="2"> The <a href="[connectorid]"> camunda:connectorId</a> child element is required and must identify a connector implementation known to the process engine </td> |
|---|
connectorId
| Description <td colspan="2"> The unique identifier of the connector type to instantiate. </td> | Attributes <td colspan="2">–</td> | Constraints <td colspan="2"> The connector type has to be known to the process engine </td> |
|---|
constraint
| Description <td colspan="2"> Metadata of an individual validation constraint for a form field (see <a href="openbpm:engine:user-guide/task-forms/index.adoc#form-field-validation">Form Field Validation</a>). </td> | Attributes | name <td> The name of the form field constraint type </td> |
|---|---|---|
config <td> The configuration of the form field constraint type </td> |
Constraints <td colspan="2"> The name attribute must be one of the known validators (required, minlength, maxlength, min, max, readonly or validator) </td> |
entry
| Description <td colspan="2"> A single entry of a map structure. The value can be a constant, expression, script, list or another map. </td> | Attributes | key <td> The key of the entry in the map. Can be a string or an expression. </td> |
|---|---|---|
Constraints <td colspan="2"> The key attribute is required </td> |
Parent elements <td colspan="2"> <a href="[map]">camunda:map</a> </td> |
Child elements <td colspan="2"> <a href="[list]">camunda:list</a>, <a href="[map]">camunda:map</a>, <a href="[script]">camunda:script</a> </td> |
errorEventDefinition
| Description <td colspan="2"> Definition of an error event that can be triggered by an expression. This element extends the <a href="openbpm:engine:reference/bpmn20/events/error-events.adoc#defining-an-error">errorEventDefinition</a> element from the bpmn namespace inheriting all of its attributes: id, errorRef </td> | Attributes | expression <td> An expression that will trigger the error if it evaluates to true. </td> |
|---|---|---|
Constraints <td colspan="2"> The errorRef attribute is required </td> |
Parent elements <td colspan="2"> <a href="Сервисная задача">Service Task</a> of type external </td> |
Child elements <td colspan="2"> – </td> |
executionListener
| Description <td colspan="2"> Add an execution listener to an event. </td> | Attributes | event <td> The type of the event for which the listener is called </td> |
|---|---|---|
class <td> see <a href="openbpm:engine:reference/bpmn20/custom-extensions/extension-attributes.adoc#class">camunda:class</a> </td> |
||
expression <td> see <a href="openbpm:engine:reference/bpmn20/custom-extensions/extension-attributes.adoc#expression">camunda:expression</a> </td> |
delegateExpression <td> see <a href="openbpm:engine:reference/bpmn20/custom-extensions/extension-attributes.adoc#delegateexpression">camunda:delegateExpression</a> </td> |
|
Constraints <td colspan="2"> The event attribute is required (except for transitions) and must be one of the task events: start or end </td> |
<td colspan="2"> One of the attributes class, expression or delegateExpression is mandatory </td> |
Parent elements <td colspan="2"> Process, Task, <a href="Сервисная задача">Service Task</a>, <a href="Задача отправки">Send Task</a>, <a href="User Task">User Task</a>, <a href="Задача бизнес-правил (Business Rule Task)">Business Rule Task</a>, <a href="Скриптовая задача">Script Task</a>, <a href="Задача получения">Receive Task</a>, <a href="Ручная задача">Manual Task</a>, <a href="Эксклюзивный шлюз на основе данных (Data-based Exclusive Gateway, XOR)">Exclusive Gateway</a>, <a href="Conditional and Default Sequence Flows">Sequence Flow</a>, <a href="Parallel Gateway">Parallel Gateway</a>, <a href="Inclusive Gateway">Inclusive Gateway</a>, <a href="Событийный шлюз (Event-based Gateway)">Event Based Gateway</a>, <a href="Стартовые события (Start Events)">Start Event</a>, <a href="Events">Intermediate Catch Event</a>, <a href="Events">Intermediate Throw Event</a>, <a href="Events">End Events</a>, <a href="Events">Boundary Events</a>, <a href="Embedded Subprocess">Embedded Subprocess</a>, <a href="Call Activity">Call Activity</a>, <a href="Event Subprocess">Event Subprocess</a>, <a href="Transaction Subprocess">Transaction Subprocess</a> </td> |
expression
| Description <td colspan="2"> Defines an expression to inject in delegated classes (see <a href="openbpm:engine:user-guide/process-engine/delegation-code.adoc#field-injection">Field Injection</a>). </td> | Attributes <td colspan="2"> – </td> | Text Content <td colspan="2"> The expression to inject </td> |
|---|---|---|
Constraints <td colspan="2"> – </td> |
Parent elements <td colspan="2"> <a href="[field]">camunda:field</a> </td> |
Child elements <td colspan="2"> – </td> |
failedJobRetryTimeCycle
| Description <td colspan="2"> Defines the custom retry schedule for a failed job (see <a href="openbpm:engine:user-guide/process-engine/the-job-executor.adoc#failed-jobs">Failed Jobs</a>). </td> | Attributes <td colspan="2"> – </td> | Text Content <td colspan="2"> The retry time cycle value or expression </td> |
|---|---|---|
Constraints <td colspan="2"> The configuration follows the <a href="http://en.wikipedia.org/wiki/ISO_8601#Repeating_intervals">ISO 8601 standard for repeating time intervals</a> </td> |
Parent elements <td colspan="2"> Task, <a href="Сервисная задача">Service Task</a>, <a href="Задача отправки">Send Task</a>, <a href="User Task">User Task</a>, <a href="Задача бизнес-правил (Business Rule Task)">Business Rule Task</a>, <a href="Скриптовая задача">Script Task</a>, <a href="Задача получения">Receive Task</a>, <a href="openbpm:engine:reference/bpmn20/events/timer-events.adoc#timer-start-event">Timer Start Event</a>, <a href="openbpm:engine:reference/bpmn20/events/timer-events.adoc#timer-intermediate-catching-event">Timer Intermediate Catching Event</a>, <a href="openbpm:engine:reference/bpmn20/events/timer-events.adoc#timer-boundary-event">Timer Boundary Event</a>, <a href="События сигналов (Signal Events)">Intermediate Signal Throw Event</a>, <a href="Embedded Subprocess">Embedded Subprocess</a>, <a href="Call Activity">Call Activity</a>, <a href="Transaction Subprocess">Transaction Subprocess</a>, <a href="openbpm:engine:reference/bpmn20/tasks/task-markers.adoc#multiple-instance">Multi Instance Loop Characteristics</a> </td> |
Child elements <td colspan="2"> – </td> |
field
| Description <td colspan="2"> Defines the value to inject in delegated classes (see <a href="openbpm:engine:user-guide/process-engine/delegation-code.adoc#field-injection">Field Injection</a>). </td> | Attributes | name <td> The name of the field </td> |
|---|---|---|
expression |
The value of the field as expression |
|
stringValue |
The value of the field as String |
|
Constraints <td colspan="2"> Only one attribute of stringValue and expression or one of the child elements string and expression can be used </td> |
Parent elements <td colspan="2"> <a href="Сервисная задача">Service Task</a>, <a href="Задача бизнес-правил (Business Rule Task)">Business Rule Task</a>, <a href="Задача отправки">Send Task</a>, Message Event Definition of <a href="openbpm:engine:reference/bpmn20/events/message-events.adoc#message-intermediate-throwing-event">Message Intermediate Throwing Event</a> or <a href="openbpm:engine:reference/bpmn20/events/message-events.adoc#message-end-event">Message End Event</a>, <a href="[tasklistener]">camunda:taskListener</a>, <a href="[executionlistener]">camunda:executionListner</a> </td> |
Child elements <td colspan="2"> <a href="[expression]">camunda:expression</a>, <a href="[string]">camunda:string</a> </td> |
formData
| Description <td colspan="2"> Metadata to define fields of a form, which are used to generate task forms (see <a href="openbpm:engine:user-guide/task-forms/index.adoc#generated-task-forms">Generated Task Forms</a>). </td> | Attributes <td colspan="2"> – </td> | Constraints <td colspan="2"> – </td> |
|---|
formField
| Description <td colspan="2"> Metadata to define a single form field (see <a href="openbpm:engine:user-guide/task-forms/index.adoc#generated-task-forms">Generated Task Forms</a>). </td> | Attributes | id <td> The id of the form field, corresponding to the name of a process variable </td> |
|---|---|---|
label <td> The label to be displayed next to the form field </td> |
||
type <td> The type of the form field </td> |
datePattern <td> The pattern of a date type form field </td> |
|
defaultValue <td> The value to be used as a default (pre-selection) for the field </td> |
Constraints <td colspan="2"> The attribute id may not be empty </td> |
|
<td colspan="2"> The attribute type can be one of the known form field types (string, long, boolean, date or enum) or a custom one </td> |
<td colspan="2"> The attribute datePattern can only be used if the type attribute is set to date </td> |
<td colspan="2"> The child element camunda:properties is only allowed once </td> |
<td colspan="2"> The child element camunda:validation is only allowed once </td> |
<td colspan="2"> The child elements camunda:values can only be used if the type attribute is set to enum </td> |
Parent elements <td colspan="2"> <a href="[formdata]">camunda:formData</a> </td> |
formProperty
| Description <td colspan="2"> Metadata to define a form field (Deprecated, use <a href="[formdata]">camunda:formData</a>). </td> | Attributes | id <td> The key used to submit the property through the API </td> |
|---|---|---|
name <td> The display label of the property </td> |
||
type <td> The type of the property </td> |
required <td> True if the form field is required (default: false) </td> |
|
readable <td> True if the form field is readable and will be displayed (default: true) </td> |
||
writeable <td> True if the form field is writeable (default: true) </td> |
variable <td> Specifies the process variable on which the variable is mapped </td> |
|
expression <td> Specifies an expression that maps the property, e.g., ${street.address} </td> |
||
datePattern <td> The pattern of a date type form field </td> |
default <td> The default value or expression of the property </td> |
|
Constraints <td colspan="2"> The id attribute is required </td> |
<td colspan="2"> The attribute type can be one of the known types (string, long, boolean, date or enum) or a custom one </td> |
<td colspan="2"> The attribute datePattern can only be used if the type attribute is set to date </td> |
<td colspan="2"> The child elements camunda:values can only be used if the type attribute is set to enum </td> |
Parent elements <td colspan="2"> <a href="Стартовые события (Start Events)">Start Event</a>, <a href="User Task">User Task</a> </td> |
Child elements <td colspan="2"> <a href="[value]">camunda:value</a> </td> |
in
| Description <td colspan="2"> The element specifies variables which should be passed to the subprocess, see <a href="openbpm:engine:reference/bpmn20/subprocesses/call-activity.adoc#passing-variables">passing variables</a> for more information. </td> | Attributes | source <td> A name of a process variable to be passed in </td> |
|---|---|---|
sourceExpression <td> An expression to be evaluated and passed in </td> |
||
variables <td> Can be set to all to pass all process variables in </td> |
target <td> Name of the process variable inside the subprocess instance </td> |
|
local <td> Can be set to true to only pass local variables of the execution that executes the call activity. </td> |
||
businessKey <td> Set the business key of the subprocess process instance </td> |
Constraints <td colspan="2"> Only one of the attributes source, sourceExpression, variables or businessKey can be used </td> |
<td colspan="2"> The attribute target is required if the source or sourceExpression attribute is used </td> |
inputParameter
| Description <td colspan="2"> An single input mapping for the activity. If the element has no child element, the text content of this element is mapped into the activity. The text content can be a constant string value or an expression. If no child element or text content exists, the variable inside the activity is set to the special value null. </td> | Attributes | name <td> The name of the variable inside the activity. </td> |
|---|---|---|
Constraints <td colspan="2"> The name attribute is required. </td> |
<td colspan="2"> The element can have one child element, a constant string or an expression as text content. </td> |
Parent elements <td colspan="2"> <a href="[inputoutput]"> camunda:inputOutput</a> </td> |
inputOutput
| Description <td colspan="2"> The element describes an input/output mapping for the activity. </td> | Attributes <td colspan="2"> – </td> | Constraints <td colspan="2"> – </td> |
|---|
list
| Description
<td colspan="2">
A list structure. If the list contains multiple values, they should be added as
text content of child elements. Which child elements are used is arbitrary, e.g.,:
<code> <camunda:list> <camunda:value>one</camunda:value> <camunda:value>two</camunda:value> <camunda:value>three</camunda:value> </camunda:list> </code> A <a href="[script]"> camunda:script</a> element can also be used as a list element. The return value of the script is added to the list. Furthermore, lists can contain nested lists and maps. </td> |
Attributes <td colspan="2"> – </td> | Constraints <td colspan="2"> Multiple values have to be encapsulated in child elements. </td> |
|---|
map
| Description <td colspan="2"> A map structure. The entries can be constants, expressions, scripts, nested maps and lists. </td> | Attributes <td colspan="2"> – </td> | Constraints <td colspan="2"> – </td> |
|---|
out
| Description <td colspan="2"> The element specifies variables which should be passed back from the subprocess, see <a href="openbpm:engine:reference/bpmn20/subprocesses/call-activity.adoc#passing-variables">passing variables</a> for more information. </td> | Attributes | source <td> A name of a process variable to be passed back </td> |
|---|---|---|
sourceExpression <td> An expression to be evaluated and passed back </td> |
||
variables <td> Can be set to all to pass all subprocess variables back </td> |
target <td> Name of the process variable inside the subprocess instance </td> |
|
local <td> Can be set to true to pass variables from the called case/process instance to local variables of the execution executing the call activity. </td> |
Constraints <td colspan="2"> Only one of the attributes source, sourceExpression or variables can be used </td> |
|
<td colspan="2"> The attribute target is required if the source or sourceExpression attribute is used </td> |
Parent elements <td colspan="2"> <a href="Call Activity">Call Activity</a> </td> |
Child elements <td colspan="2"> – </td> |
outputParameter
| Description <td colspan="2"> An single output mapping for the activity. If the element has no child element, the text content of this element is mapped out of the activity. The text content can be a constant string value or an expression. If no child element or text content exists, the variable outside of the activity is set to the special value null. </td> | Attributes | name <td> The name of the variable outside of the activity. </td> |
|---|---|---|
Constraints <td colspan="2"> The name attribute is required. </td> |
<td colspan="2"> The element can have one child element, a constant string or an expression as text content. </td> |
Parent elements <td colspan="2"> <a href="[inputoutput]"> camunda:inputOutput</a> </td> |
potentialStarter
| Description <td colspan="2"> Defines which users or groups can start the process. </td> | Attributes <td colspan="2"> – </td> | Constraints <td colspan="2"> – </td> |
|---|
properties
| Description <td colspan="2"> A key value list of properties which be can be interpreted freely. </td> | Attributes <td colspan="2"> – </td> | Constraints <td colspan="2"> – </td> |
|---|
property
| Description <td colspan="2"> A key value pair which can be interpreted freely. </td> | Attributes | id <td> The id of the form field property </td> |
|---|---|---|
name <td> The name of the property </td> |
||
value <td> The value of the property </td> |
Constraints <td colspan="2"> If the property belongs to a camunda:formField extension element, only the attributes id and value are used. </td> |
<td colspan="2"> If the parent camunda:properties element is directly added as an extension element, for example by the camunda Modeler, only the attributes name and value are used. </td> |
script
| Description <td colspan="2"> A script element. The script is executed and the return value is used as mapping value. </td> | Attributes | scriptFormat <td> The format identifier, normally the language of the script source code </td> |
|---|---|---|
resource <td> equivalent to <a href="openbpm:engine:reference/bpmn20/custom-extensions/extension-attributes.adoc#resource"> camunda:resource</a> </td> |
Constraints <td colspan="2"> The scriptFormat attribute is required </td> |
|
<td colspan="2"> If the resource attribute is used, no source code text content is allowed </td> |
Parent elements <td colspan="2"> <a href="[inputparameter]"> camunda:inputParameter</a>, <a href="[outputparameter]"> camunda:outputParameter</a>, <a href="[entry]">camunda:entry</a>, <a href="[list]">camunda:list</a>, <a href="[executionlistener]"> camunda:executionListener</a>, <a href="[tasklistener]"> camunda:taskListener</a> </td> |
Child elements <td colspan="2"> – </td> |
string
| Description <td colspan="2"> Defines a String value to inject in delegated classes (see <a href="openbpm:engine:user-guide/process-engine/delegation-code.adoc#field-injection">Field Injection</a>). </td> | Attributes <td colspan="2"> – </td> | Text Content <td colspan="2"> The String value to inject </td> |
|---|---|---|
Constraints <td colspan="2"> – </td> |
Parent elements <td colspan="2"> <a href="[field]">camunda:field</a> </td> |
Child elements <td colspan="2"> – </td> |
taskListener
| Description <td colspan="2"> Adds a task listener to a task event. </td> | Attributes | event <td> The type of the event for which the listener is called </td> |
|---|---|---|
class <td> see <a href="openbpm:engine:reference/bpmn20/custom-extensions/extension-attributes.adoc#class">camunda:class</a> </td> |
||
expression <td> see <a href="openbpm:engine:reference/bpmn20/custom-extensions/extension-attributes.adoc#expression">camunda:expression</a> </td> |
delegateExpression <td> see <a href="openbpm:engine:reference/bpmn20/custom-extensions/extension-attributes.adoc#delegateexpression">camunda:delegateExpression</a> </td> |
|
id <td> The id of the task listener in the parent scope, only required when event is set to timeout </td> |
Constraints <td colspan="2"> The event attribute is required and must be one of the task events: create, assignment, update, complete, delete or timeout </td> |
|
<td colspan="2"> One of the attributes class, expression or delegateExpression is mandatory </td> |
<td colspan="2"> If the attribute event is set to timeout, the attribute id and exactly one child element of type <a href="openbpm:engine:reference/bpmn20/events/timer-events.adoc#defining-a-timer">timerEventDefinition</a> are mandatory </td> |
Parent elements <td colspan="2"> <a href="User Task">User Task</a> </td> |
validation
| Description <td colspan="2"> Metadata to define a list of validation constraints for form fields (see <a href="openbpm:engine:user-guide/task-forms/index.adoc#form-field-validation">Form Field Validation</a>). </td> | Attributes <td colspan="2"> – </td> | Constraints <td colspan="2"> – </td> |
|---|
value
| Description <td colspan="2"> Possible values of a form field with the type enum. </td> | Attributes | id <td> The id of the value </td> |
|---|---|---|
name <td> The name of the value </td> |
Constraints <td colspan="2"> – </td> |
Лицензия и атрибуция
Эта документация была создана на базе материала "Camunda 7 Docs" от Camunda, находится под лицензией Creative Commons Attribution-ShareAlike 3.0 Unported License .
Оригинал документации: https://docs.camunda.org