我的书签
添加书签
移除书签connector
connectorId
| Description |
|---|
| The unique identifier of the connector type to instantiate. |
| Attributes |
| ——- |
| – |
| Constraints |
| ——- |
| The connector type has to be known to the process engine |
| Parent elements |
| ——- |
| Child elements |
| ——- |
| – |
constraint
| Description | ||
|---|---|---|
| Metadata of an individual validation constraint for a form field (see ). | ||
| Attributes | ||
| ——- | ||
name |
The name of the form field constraint type | |
config |
The configuration of the form field constraint type | |
| Constraints | ||
| ——- | ||
The name attribute must be one of the known validators (required, minlength, maxlength, min, max, readonly or validator) |
||
| Parent elements | ||
| ——- | ||
| camunda:validation | ||
| Child elements | ||
| ——- | ||
| – |
entry
| Description | |
|---|---|
| A single entry of a map structure. The value can be a constant, expression, script, list or another map. | |
| Attributes | |
| ——- | |
key |
The key of the entry in the map. Can be a string or an expression. |
| Constraints | |
| ——- | |
The key attribute is required |
|
| Parent elements | |
| ——- | |
| camunda:map | |
| Child elements | |
| ——- | |
| , camunda:map, |
executionListener
| Description | ||
|---|---|---|
| Add an execution listener to an event. | ||
| Attributes | ||
| ——- | ||
event |
The type of the event for which the listener is called | |
class |
see | |
expression |
see camunda:expression | |
delegateExpression |
see | |
| Constraints | ||
| ——- | ||
The event attribute is required (except for transitions) and must be one of the task events: start or end |
||
One of the attributes class, expression or delegateExpression is mandatory |
||
| Parent elements | ||
| ——- | ||
| Process, Task, Service Task, , User Task, , Script Task, , Manual Task, , Sequence Flow, , Inclusive Gateway, , Start Event, , Intermediate Throw Event, , Boundary Events, , Call Activity, , Transaction Subprocess | ||
| Child elements | ||
| ——- | ||
| , camunda:script |
expression
| Description |
|---|
| Defines an expression to inject in delegated classes (see Field Injection). |
| Attributes |
| ——- |
| – |
| Text Content |
| ——- |
| The expression to inject |
| Constraints |
| ——- |
| – |
| Parent elements |
| ——- |
| Child elements |
| ——- |
| – |
failedJobRetryTimeCycle
| Description |
|---|
| Defines the custom retry schedule for a failed job (see ). |
| Attributes |
| ——- |
| – |
| Text Content |
| ——- |
| The retry time cycle value or expression |
| Constraints |
| ——- |
| The configuration follows the ISO 8601 standard for repeating time intervals |
| Parent elements |
| ——- |
| Task, , Send Task, , Business Rule Task, , Receive Task, , Timer Intermediate Catching Event, , Intermediate Signal Throw Event, , Call Activity, , Multi Instance Loop Characteristics |
| Child elements |
| ——- |
| – |
field
| Description | ||
|---|---|---|
| Defines the value to inject in delegated classes (see Field Injection). | ||
| Attributes | ||
| ——- | ||
name |
The name of the field | |
expression |
The value of the field as expression | |
stringValue |
The value of the field as String | |
| Constraints | ||
| ——- | ||
Only one attribute of stringValue and expression or one of the child elements string and expression can be used |
||
| Parent elements | ||
| ——- | ||
| , Business Rule Task, , Message Event Definition of Message Intermediate Throwing Event or , camunda:taskListener, | ||
| Child elements | ||
| ——- | ||
| camunda:expression, |
formData
| Description |
|---|
| Metadata to define fields of a form, which are used to generate task forms (see ). |
| Attributes |
| ——- |
| – |
| Constraints |
| ——- |
| – |
| Parent elements |
| ——- |
| Start Event, |
| Child elements |
| ——- |
| camunda:formField |
formField
formProperty
| Description | ||
|---|---|---|
| Metadata to define a form field (Deprecated, use ). | ||
| Attributes | ||
| ——- | ||
id |
The key used to submit the property through the API | |
name |
The display label of the property | |
type |
The type of the property | |
required |
True if the form field is required (default: false) |
|
readable |
True if the form field is readable and will be displayed (default: true) |
|
writeable |
True if the form field is writeable (default: true) |
|
variable |
Specifies the process variable on which the variable is mapped | |
expression |
Specifies an expression that maps the property, e.g., ${street.address} |
|
datePattern |
The pattern of a date type form field | |
default |
The default value or expression of the property | |
| Constraints | ||
| ——- | ||
The id attribute is required |
||
The attribute type can be one of the known types (string, long, boolean, date or enum) or a custom one |
||
The attribute datePattern can only be used if the type attribute is set to date |
||
The child elements camunda:values can only be used if the type attribute is set to enum |
||
| Parent elements | ||
| ——- | ||
| Start Event, | ||
| Child elements | ||
| ——- | ||
| camunda:value |
in
| Description | ||
|---|---|---|
| The element specifies variables which should be passed to the subprocess, see passing variables for more information. | ||
| Attributes | ||
| ——- | ||
source |
A name of a process variable to be passed in | |
sourceExpression |
An expression to be evaluated and passed in | |
variables |
Can be set to all to pass all process variables in |
|
target |
Name of the process variable inside the subprocess instance | |
local |
Can be set to true to only pass local variables of the execution that executes the call activity. |
|
businessKey |
Set the business key of the subprocess process instance | |
| Constraints | ||
| ——- | ||
Only one of the attributes source, sourceExpression, variables or businessKey can be used |
||
The attribute target is required if the source or sourceExpression attribute is used |
||
| Parent elements | ||
| ——- | ||
| , Signal Events (in Intermediate and End Throwing Events) | ||
| Child elements | ||
| ——- | ||
| – |
inputParameter
| Description | |
|---|---|
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. |
|
| Attributes | |
| ——- | |
| The name of the variable inside the activity. | |
| Constraints | |
| ——- | |
The name attribute is required. |
|
| The element can have one child element, a constant string or an expression as text content. | |
| Parent elements | |
| ——- | |
| camunda:inputOutput | |
| Child elements | |
| ——- | |
| , camunda:map, |
inputOutput
| Description |
|---|
| The element describes an input/output mapping for the activity. |
| Attributes |
| ——- |
| – |
| Constraints |
| ——- |
| – |
| Parent elements |
| ——- |
| , All Events (except Start and Boundary Events), , Embedded Subprocess, , camunda:connector |
| Child elements |
| ——- |
| , camunda:outputParameter |
list
| Description |
|---|
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.,: |
| Attributes |
|---|
| – |
| Constraints |
| ——- |
| Multiple values have to be encapsulated in child elements. |
| Parent elements |
| ——- |
| camunda:inputParameter, , camunda:list, |
| Child elements |
| ——- |
| Any child element, camunda:list, |
map
| Description |
|---|
| A map structure. The entries can be constants, expressions, scripts, nested maps and lists. |
| Attributes |
| ——- |
| – |
| Constraints |
| ——- |
| – |
| Parent elements |
| ——- |
| , camunda:outputParameter, , camunda:entry |
| Child elements |
| ——- |
out
| Description | ||
|---|---|---|
| The element specifies variables which should be passed back from the subprocess, see for more information. | ||
| Attributes | ||
| ——- | ||
source |
A name of a process variable to be passed back | |
sourceExpression |
An expression to be evaluated and passed back | |
variables |
Can be set to all to pass all subprocess variables back |
|
target |
Name of the process variable inside the subprocess instance | |
local |
Can be set to true to pass variables from the called case/process instance to local variables of the execution executing the call activity. |
|
| Constraints | ||
| ——- | ||
Only one of the attributes source, sourceExpression or variables can be used |
||
The attribute target is required if the source or sourceExpression attribute is used |
||
| Parent elements | ||
| ——- | ||
| Call Activity | ||
| Child elements | ||
| ——- | ||
| – |
outputParameter
potentialStarter
| Description |
|---|
| Defines which users or groups can start the process. |
| Attributes |
| ——- |
| – |
| Constraints |
| ——- |
| – |
| Parent elements |
| ——- |
| Process |
| Child elements |
| ——- |
| resourceAssignmentExpression |
properties
| Description |
|---|
| A key value list of properties which be can be interpreted freely. |
| Attributes |
| ——- |
| – |
| Constraints |
| ——- |
| – |
| Parent elements |
| ——- |
| Base Element, camunda:formField |
| Child elements |
| ——- |
property
| Description | ||
|---|---|---|
| A key value pair which can be interpreted freely. | ||
| Attributes | ||
| ——- | ||
id |
The id of the form field property | |
name |
The name of the property | |
value |
The value of the property | |
| Constraints | ||
| ——- | ||
If the property belongs to a camunda:formField extension element, only the attributes id and value are used. |
||
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. |
||
| Parent elements | ||
| ——- | ||
| Child elements | ||
| ——- | ||
| – |
script
| Description | ||
|---|---|---|
| A script element. The script is executed and the return value is used as mapping value. | ||
| Attributes | ||
| ——- | ||
scriptFormat |
The format identifier, normally the language of the script source code | |
resource |
equivalent to | |
| Constraints | ||
| ——- | ||
The scriptFormat attribute is required |
||
If the resource attribute is used, no source code text content is allowed |
||
| Parent elements | ||
| ——- | ||
| camunda:inputParameter, , camunda:entry, , camunda:executionListener, | ||
| Child elements | ||
| ——- | ||
| – |
string
| Description |
|---|
| Defines a String value to inject in delegated classes (see ). |
| Attributes |
| ——- |
| – |
| Text Content |
| ——- |
| The String value to inject |
| Constraints |
| ——- |
| – |
| Parent elements |
| ——- |
| camunda:field |
| Child elements |
| ——- |
| – |
taskListener
| Description | ||
|---|---|---|
| Adds a task listener to a task event. | ||
| Attributes | ||
| ——- | ||
event |
The type of the event for which the listener is called | |
class |
see camunda:class | |
expression |
see | |
delegateExpression |
see camunda:delegateExpression | |
| Constraints | ||
| ——- | ||
The event attribute is required and must be one of the task events: create, assignment, complete or delete |
||
One of the attributes class, expression or delegateExpression is mandatory |
||
| Parent elements | ||
| ——- | ||
| Child elements | ||
| ——- | ||
| camunda:field, |
validation
| Description |
|---|
| Metadata to define a list of validation constraints for form fields (see ). |
| Attributes |
| ——- |
| – |
| Constraints |
| ——- |
| – |
| Parent elements |
| ——- |
| camunda:formField |
| Child elements |
| ——- |
value
| Description | ||
|---|---|---|
Possible values of a form field with the type enum. |
||
| Attributes | ||
| ——- | ||
id |
The id of the value | |
name |
The name of the value | |
| Constraints | ||
| ——- | ||
| – | ||
| Parent elements | ||
| ——- | ||
| , camunda:formProperty | ||
| Child elements | ||
| ——- | ||
| – |
