Camunda BPMN Extension Attributes
|
Этот раздел перенесён из документации Camunda 7 и в дальнейшем будет доработан с учётом особенностей OpenBPM Engine |
The following attributes are extension attributes for the camunda namespace http://camunda.org/schema/1.0/bpmn.
assignee
| Description <td> The attribute specifies a human performer of a <a href="User Task">User Task</a>. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> The name of a performer as java.lang.String or an expression which evaluates to a java.lang.String e.g., ${initiator} </td> |
Default Value |
– |
asyncAfter
| Description <td> Specifies an asynchronous continuation after an activity, see <a href="openbpm:engine:user-guide/process-engine/transactions-in-processes.adoc#asynchronous-continuations">Asynchronous Continuations</a> for more information. </td> | Type | java.lang.Boolean |
|---|---|---|
Possible Values <td> true, false </td> |
Default Value |
false |
asyncBefore
| Description <td> Specifies an asynchronous continuation before an activity, see <a href="openbpm:engine:user-guide/process-engine/transactions-in-processes.adoc#asynchronous-continuations">Asynchronous Continuations</a> for more information. </td> | Type | java.lang.Boolean |
|---|---|---|
Possible Values <td> true, false </td> |
Default Value |
false |
calledElementBinding
| Description <td> The attribute specifies which process definition version of the subprocess the call activity calls. If the value is version, the attribute <a href="[calledelementversion]">camunda:calledElementVersion</a> is required. If the value is versionTag, the attribute <a href="[calledelementversiontag]">camunda:calledElementVersionTag</a> is required. See <a href="openbpm:engine:reference/bpmn20/subprocesses/call-activity.adoc#calledelement-binding">Called Element Binding</a> for more information. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> latest, deployment, version, versionTag </td> |
Default Value |
latest |
calledElementVersion
| Description <td> The attribute specifies which process definition version of the subprocess the call activity calls if the <a href="[calledelementbinding]">camunda:calledElementBinding</a> is set to version, see <a href="openbpm:engine:reference/bpmn20/subprocesses/call-activity.adoc#calledelement-binding">Called Element Binding</a> for more information. </td> | Type | java.lang.Integer or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> A concrete version of all deployed version numbers of the subprocess to call as java.lang.Integer or an expression which evaluates to a java.lang.Integer e.g., ${versionToCall} </td> |
Default Value |
– |
calledElementVersionTag
| Description <td> The attribute specifies which process definition version tag of the subprocess the call activity calls if the <a href="[calledelementbinding]">camunda:calledElementBinding</a> is set to versionTag, see <a href="openbpm:engine:reference/bpmn20/subprocesses/call-activity.adoc#calledelement-binding">Called Element Binding</a> for more information. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> A concrete version tag of all deployed version numbers of the subprocess to call as java.lang.String or an expression which evaluates to a java.lang.String e.g., ${versionTagToCall} </td> |
Default Value |
– |
calledElementTenantId
| Description <td> The attribute specifies the tenant id of the process definition which is to be resolved by a call activity, see <a href="openbpm:engine:reference/bpmn20/subprocesses/call-activity.adoc#calledelement-tenant-id">Called Element Tenant Id</a> for more information. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> A concrete tenant id or an expression which evaluates to a java.lang.String e.g., ${execution.tenantId} </td> |
Default Value |
– |
candidateGroups
| Description <td> The attribute specifies which group(s) will be candidate for performing the <a href="User Task">User Task</a>. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> Comma separated list of group ids as java.lang.String or expressions that evaluate to a java.lang.String or a java.util.Collection of java.lang.String, e.g., management or management, ${accountancyGroupId()} </td> |
Default Value |
– |
candidateStarterGroups
| Description <td> The attribute specifies which group(s) will be able to start the process. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> Comma separated list of group ids as java.lang.String or expressions that evaluate to a java.lang.String or a java.util.Collection of java.lang.String, e.g., management or management, ${accountancyGroupId()} </td> |
Default Value |
– |
candidateStarterUsers
| Description <td> The attribute specifies which user(s) will be able to start the process. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> Comma separated list of user ids as java.lang.String or expressions that evaluate to a java.lang.String or a java.util.Collection of java.lang.String, e.g., kermit, gonzo or ${ldapService.findAllSales()} </td> |
Default Value |
– |
candidateUsers
| Description <td> The attribute specifies which user(s) will be candidate for performing the <a href="User Task">User Task</a>. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> Comma separated list of user ids as java.lang.String or expressions that evaluate to a java.lang.String or a java.util.Collection of java.lang.String, e.g., kermit, gonzo or ${ldapService.findAllSales()} </td> |
Default Value |
– |
caseBinding
| Description <td> The attribute specifies which case definition version of the subcase the call activity calls. If the value is version, the attribute <a href="[caseversion]">camunda:caseVersion</a> is required, see <a href="openbpm:engine:reference/bpmn20/subprocesses/call-activity.adoc#create-a-case-instance">Case Binding</a> for more information. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> latest, deployment, version </td> |
Default Value |
– |
caseRef
| Description <td> The attribute references a case definition by its key to call. </td> | Type | java.lang.String |
|---|---|---|
Possible Values |
– |
Default Value |
caseVersion
| Description <td> The attribute specifies which case definition version of the subcase the call activity calls if the <a href="[casebinding]">camunda:caseBinding</a> is set to version, see <a href="openbpm:engine:reference/bpmn20/subprocesses/call-activity.adoc#create-a-case-instance">Case Binding</a> for more information. </td> | Type | java.lang.Integer |
|---|---|---|
Possible Values <td> All deployed version numbers of the subprocess to call </td> |
Default Value |
– |
caseTenantId
| Description <td> The attribute specifies the tenant id of the case definition which is to be resolved by a call activity, see <a href="openbpm:engine:reference/bpmn20/subprocesses/call-activity.adoc#case-tenant-id">Case Tenant Id</a> for more information. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> A concrete tenant id or an expression which evaluates to a java.lang.String e.g., ${execution.tenantId} </td> |
Default Value |
– |
class
| Description <td> The attribute specifies which Java class will be executed at runtime. The stated class must implement a <a href="openbpm:engine:user-guide/process-engine/delegation-code.adoc#java-delegate">Java delegate</a> interface. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> Fully qualified Java class name of a class which implements a <a href="openbpm:engine:user-guide/process-engine/delegation-code.adoc#java-delegate">Java Delegate</a> interface, e.g., io.openbpm.bpm.MyJavaDelegate </td> |
Default Value |
– |
collection
| Description <td> The attribute specifies a collection, where an instance will be created for each element, see <a href="openbpm:engine:reference/bpmn20/tasks/task-markers.adoc#multiple-instance">Multiple Instance</a> for more information. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> The name of a java.util.Collection process variable as java.lang.String or an Expression which evaluates to the name of a collection </td> |
Default Value |
– |
decisionRef
| Description <td> The attribute references a decision definition to evalute by its key. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> A String or an expression which evalutes to the key of a decision definition which should be evaluated by this task, e.g., myDecisionDefinitionKey or ${decisionKey} </td> |
Default Value |
– |
decisionRefBinding
| Description <td> The attribute specifies which decision definition version the task evaluates. If the value is version, the attribute <a href="[decisionrefversion]">camunda:decisionRefVersion</a> is required. If the value is versionTag, the attribute <a href="[decisionrefversiontag]">camunda:decisionRefVersionTag</a> is required. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> latest, deployment, version, versionTag </td> |
Default Value |
latest |
decisionRefVersion
| Description <td> The attribute specifies which decision definition version the task evaluates if the <a href="[decisionrefbinding]">camunda:decisionRefBinding</a> is set to version. </td> | Type | java.lang.Integer or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> A concrete version of all deployed version numbers of the decision to call as java.lang.Integer or an expression which evaluates to a java.lang.Integer e.g., ${versionToCall} </td> |
Default Value |
– |
decisionRefVersionTag
| Description <td> The attribute specifies which decision definition version tag the task evaluates if the <a href="[decisionrefbinding]">camunda:decisionRefBinding</a> is set to versionTag. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> A concrete version tag of all deployed version tags of the decision to call as java.lang.String or an expression which evaluates to a java.lang.String e.g., ${versionTagToCall} </td> |
Default Value |
– |
decisionRefTenantId
| Description <td> The attribute specifies the tenant id of the decision definition which is to be resolved by a business rule task, see <a href="openbpm:engine:reference/bpmn20/tasks/business-rule-task.adoc#decisionref-tenant-id">DecisionRef Tenant Id</a> for more information. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> A concrete tenant id or an expression which evaluates to a java.lang.String e.g., ${execution.tenantId} </td> |
Default Value |
– |
delegateExpression
| Description <td> The attribute allows specification of an expression which must resolve to an object that implements the corresponding interface (see <a href="Код делегации">delegation code</a>). </td> | Type | io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> Expression which evaluates to a Java class implementing a <a href="Код делегации">delegation</a> interface, e.g., ${myJavaDelegate} or #{myTaskListener} </td> |
Default Value |
– |
dueDate
| Description <td> The attribute specifies the initial due date of a <a href="User Task">User Task</a> when it is created. </td> | Type | io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> An expression which evaluates to a java.util.Date, java.util.String (<a href="http://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> formatted) or null, e.g., ${dateVariable} </td> |
Default Value |
– |
elementVariable
| Description <td> The attribute specifies the process variable which will be set on each created instance, containing an element of the specified collection see <a href="openbpm:engine:reference/bpmn20/tasks/task-markers.adoc#multiple-instance">Multiple Instance</a> for more information. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> The name of a process variable as java.lang.String </td> |
Default Value |
– |
errorMessage
Description
<td>
The attribute specifies a message to give further information about the error. When an error start event or boudary event catches the error the message will be saved as process variable if errorMessageVariable is configured. See <a href="События ошибок (Error Events)">Error Events</a> for more information.
</td> |
Type | java.lang.String |
|---|---|---|
Possible Values <td> The error message as+java.lang.String+ </td> |
Default Value |
– |
errorCodeVariable
| Description <td> The attribute specifies a process variable that holds the error code and the errorCodevariable will be set if an error has been received by the error start or boundary event, see <a href="События ошибок (Error Events)">Error Events</a> for more information. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> The name of a process variable as java.lang.String </td> |
Default Value |
– |
errorMessageVariable
| Description <td> The attribute specifies a process variable that holds the error message and the errorMessageVariable will be set if an error has been received by the error start or boundary event, see <a href="События ошибок (Error Events)">Error Events</a> for more information. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> The name of a process variable as java.lang.String </td> |
Default Value |
– |
escalationCodeVariable
| Description <td> The attribute specifies a process variable which will be set if an escalation has been received by an escalation start or boundary event, see <a href="События эскалации (Escalation Events)">Escalation Events</a> for more information. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> The name of a process variable as java.lang.String </td> |
Default Value |
– |
exclusive
| Description <td> The attribute specifies that jobs should be executed exclusively. See <a href="openbpm:engine:user-guide/process-engine/the-job-executor.adoc#exclusive-jobs">Exclusive Jobs</a> for more information. </td> | Type | java.lang.Boolean |
|---|---|---|
Possible Values <td> true, false </td> |
Default Value |
true |
expression
| Description <td> The attribute defines an expression which will be evaluated at runtime. </td> | Type | io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> Expression, e.g., ${gender == 'male' ? 'Mr.' : 'Mrs.'} or #{printer.printMessage()} </td> |
Default Value |
– |
followUpDate
| Description <td> The attribute specifies the initial follow-up date of a <a href="User Task">User Task</a> when it is created. </td> | Type | io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> An expression which evaluates to a java.util.Date, java.util.String (<a href="http://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> formatted) or null, e.g., ${dateVariable} </td> |
Default Value |
– |
formHandlerClass
| Description <td> The attribute specifies the class that will be called during the parsing of the form information of a <a href="Стартовые события (Start Events)">Start Event</a> or <a href="User Task">User Task</a>. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> Fully qualified Java class name of a class which implements the io.openbpm.bpm.engine.impl.form.handler.StartFormHandler or io.openbpm.bpm.engine.impl.form.handler.TaskFormHandler interface, e.g., io.openbpm.bpm.MyUserTaskFormHandler </td> |
Default Value |
– |
formKey
| Description <td> The attribute specifies a form resource. See <a href="Формы пользовательских задач">task forms</a> for more information. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> A java.lang.String of a form resource which can be evaluated by the <a href="Tasklist">Tasklist</a> </td> |
Default Value |
– |
formRef
| Description <td> The attribute references a Camunda form definition by its key. See <a href="Формы пользовательских задач">task forms</a> for more information. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> A java.lang.String or a io.openbpm.bpm.engine.delegate.Expression which <a href="Tasklist">Tasklist</a> can evaluate to display the referenced Camunda Form, e.g., myCamundaFormDefinitionKey or ${\formKey}. </td> |
Default Value |
– |
formRefBinding
| Description <td> The attribute specifies which Camunda form definition version the activity references. If the value is version, the attribute <a href="[formrefversion]">camunda:formRefVersion</a> is required. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> latest, deployment, version </td> |
Default Value |
latest |
formRefVersion
| Description <td> The attribute specifies which Camunda form definition version the activity references if the <a href="[formrefbinding]">camunda:formRefBinding</a> is set to version. </td> | Type | java.lang.Integer or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> A concrete version of all deployed version numbers of the Camunda form definition as java.lang.Integer or an expression which evaluates to a java.lang.Integer e.g., ${versionToReference} </td> |
Default Value |
– |
historyTimeToLive
| Description <td> The attribute specifies the history time to live (in days) for the process definition. It is used within <a href="Очистка истории">History cleanup</a>. </td> | Type | java.lang.Integer or java.lang.String |
|---|---|---|
Possible Values <td> Any non-negative integer number or string containing a time in days defined by the ISO-8601 date format. </td> |
Default Value |
null - means that process definition history won’t ever be removed during history cleanup run |
initiator
| Description <td> The attribute specifies a process variable in which the user id of the process initiator is set. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> A process variable name to save the process initiator </td> |
Default Value |
– |
isStartableInTasklist
| Description <td> The attribute specifies whether the process is startable in Tasklist or not. </td> | Type | java.lang.Boolean |
|---|---|---|
Possible Values |
true, false |
Default Value |
true |
BPMN 2.0 Elements |
Process |
jobPriority
| Description <td> Specifies the priority a job receives that is created in the context of executing the given process element (e.g., a timer event, or in the case of <a href="[asyncbefore]">asyncBefore</a> and <a href="[asyncafter]">asyncAfter</a>). See the user guide on <a href="openbpm:engine:user-guide/process-engine/the-job-executor.adoc#job-prioritization">Job Prioritization</a> for details. </td> | Type | A number in the range of a Java long value or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> An expression must resolve to a valid Java long value. </td> |
Default Value |
none |
mapDecisionResult
| Description <td> The attribute references which <a href="openbpm:engine:user-guide/process-engine/decisions/bpmn-cmmn.adoc#predefined-mapping-of-the-decision-result">built-in Decision Result Mapper</a> is used to pass the result of an evaluated decision to a process variable. It should be used in combination with <a href="[resultvariable]">camunda:resultVariable</a>. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> singleEntry, singleResult, collectEntries, resultList </td> |
Default Value |
resultList |
priority
| Description <td> The attribute specifies the initial priority of a <a href="User Task">User Task</a> when it is created. </td> | Type | io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> An expression which evaluates to a java.lang.Number or a java.lang.String which represents a number or null, e.g., ${dateVariable} </td> |
Default Value |
– |
taskPriority
| Description <td> The attribute specifies the initial priority of an <a href="openbpm:engine:reference/bpmn20/tasks/service-task.adoc#external-tasks">External Task</a> when it is created. </td> | Type | A number in the range of a Java long value or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> An expression must resolve to a valid Java long value. </td> |
Default Value |
0 |
resource
| Description <td> The attribute specifies an external resource. The resource can be part of the deployment or exists in the classpath. To specify the type of resource, a URL scheme like prefix deployment:// resp. classpath:// can be supplied. If the scheme is omitted, it is assumed that the resource exists in the classpath. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> The path to a resource or an expression which returns the path. Optional the path can start with an URL like scheme classpath:// or deployment:// to specify where to find the resource. If omitted the resource is assumed to exists in the classpath. </td> |
Default Value |
– |
resultVariable
| Description <td> The attribute specifies the process variable to save the return value of a <a href="[expression]">camunda:expression</a>. Note that when you use camunda:resultVariable in a multi-instance construct, for example in a multi-instance subprocess, the result variable is overwritten every time the task completes, unless the variable is a <a href="openbpm:engine:user-guide/process-engine/variables.adoc#variable-scopes-and-variable-visibility">local variable</a> in the scope of the multi-instance construct. This can lead to seemingly random behavior. This is a known issue. As a workaround, a local variable can be declared by adding an <a href="openbpm:engine:user-guide/process-engine/delegation-code.adoc#execution-listener">execution listener</a> to the subprocess' start event that initializes the variable as null. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> The name of a process variable to save the return value </td> |
Default Value |
– |
versionTag
| Description <td> The attribute specifies a version tag for the process definition. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> Any value that has a meaning as version tag for the process definition. Note: Sorting by versionTag is string based. The version will not be interpreted. As an example, the sorting could return v0.1.0, v0.10.0, v0.2.0. </td> |
Default Value |
– |
topic
| Description <td> The attribute specifies the topic of an external task instance. The task is going to be offered to workers polling for that topic. It is only relevant when <a href="[type]">camunda:type</a> is set to external. </td> | Type | java.lang.String or io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> Any value that has a meaning as a topic identifier as java.lang.String or an expression which evaluates to a java.lang.String, e.g. ${topicName} </td> |
Default Value |
– |
type
| Description <td> The attribute specifies which built-in task implementation to use. Currently an email, a shell service, and an external task exists. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> external, mail, shell </td> |
Default Value |
– |
variableMappingClass
| Description <td> The attribute specifies which Java class will be executed at runtime to map the input and output variables for a call activity. The stated class must implement the <a href="openbpm:engine:user-guide/process-engine/delegation-code.adoc#delegate-variable-mapping">Delegate Variable Mapping</a> interface. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> Fully qualified Java class name of a class which implements the <a href="openbpm:engine:user-guide/process-engine/delegation-code.adoc#delegate-variable-mapping">Delegate Variable Mapping</a> interface, e.g., io.openbpm.bpm.MyVariableMappingDelegate </td> |
Default Value |
– |
variableMappingDelegateExpression
| Description <td> The attribute allows specification of an expression which must resolve to an object that implements the corresponding interface <a href="openbpm:engine:user-guide/process-engine/delegation-code.adoc#delegate-variable-mapping">Delegate Variable Mapping</a>. </td> | Type | io.openbpm.bpm.engine.delegate.Expression |
|---|---|---|
Possible Values <td> Expression which evaluates to a Java class that implements the <a href="openbpm:engine:user-guide/process-engine/delegation-code.adoc#delegate-variable-mapping">Delegate Variable Mapping</a> interface, e.g., ${myVariableMapping}. </td> |
Default Value |
– |
variableName
| Description <td> The attribute allows to specify a variable name on which a condition of a conditional event should be evaluated exclusively. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> The name of a process variable on which a condition should be evaluated after a change happens. </td> |
Default Value |
– |
variableEvents
| Description <td> The attribute allows to specify a comma separated list of variable change events. These events specify the variable change events on which a condition of a conditional event should be evaluated exclusively. </td> | Type | java.lang.String |
|---|---|---|
Possible Values <td> A comma separated list of variable change events. Variable change events are: create, update and delete. </td> |
Default Value |
– |
Лицензия и атрибуция
Эта документация была создана на базе материала "Camunda 7 Docs" от Camunda, находится под лицензией Creative Commons Attribution-ShareAlike 3.0 Unported License .
Оригинал документации: https://docs.camunda.org