Extension Elements
|
Этот раздел перенесён из документации Camunda 7 и в дальнейшем будет доработан с учётом особенностей OpenBPM Engine |
The following elements are extension elements for the camunda namespace http://camunda.org/schema/1.0/cmmn.
caseExecutionListener
| Description <td colspan="2"> Add an execution listener to an event in the lifecycle of a case item. </td> | Attributes | event <td> The type of the lifecycle event for which the listener is called </td> |
|---|---|---|
class <td> see <a href="openbpm:engine:reference/cmmn11/custom-extensions/camunda-attributes.adoc#class">camunda:class</a> </td> |
||
expression <td> see <a href="openbpm:engine:reference/cmmn11/custom-extensions/camunda-attributes.adoc#expression">camunda:expression</a> </td> |
delegateExpression <td> see <a href="openbpm:engine:reference/cmmn11/custom-extensions/camunda-attributes.adoc#delegateexpression">camunda:delegateExpression</a> </td> |
|
Constraints <td colspan="2"> The event attribute is required and must be one of the lifecycle events that are valid for the plan item it is defined on. For regular tasks, these are: create, enable, disable, reenable, start, manualStart, complete, reactivate, terminate, exit</code, <code>parentTerminate, suspend, resume, parentSuspend, parentSuspend, close, occur </td> |
<td colspan="2"> One of the attributes class, expression or delegateExpression is mandatory </td> |
Parent elements <td colspan="2"> Case, <a href="Human Task">Human Task</a>, <a href="Process Task">Process Task</a>, <a href="Case Task">Case Task</a>, <a href="Stage">Stage</a>, <a href="Milestones">Milestone</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> |
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="[variablelistener]">camunda:variableListener</a>, camunda:caseExecutionListener </td> |
Child elements <td colspan="2"> <a href="[expression]">camunda:expression</a>, <a href="[string]">camunda:string</a> </td> |
in
| Description <td colspan="2"> This element specifies variables which should be passed to the sub instance (process instance or case instance), see <a href="openbpm:engine:reference/cmmn11/tasks/process-task.adoc#exchange-variables">passing variables to called process</a> or <a href="openbpm:engine:reference/cmmn11/tasks/case-task.adoc#exchange-variables">passing variables to called case</a> for more information. </td> | Attributes | source <td> A name of a 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 variables in </td> |
target <td> Name of the variable inside the sub instance </td> |
|
local <td> Can be set to true to only pass local variables of the case execution that executes this case/process task instance. </td> |
||
businessKey <td> Set the business key of the sub 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> |
out
| Description <td colspan="2"> This element specifies variables which should be passed back from the sub instance (process instance or case instance), see <a href="openbpm:engine:reference/cmmn11/tasks/process-task.adoc#exchange-variables">passing variables to called process</a> or <a href="openbpm:engine:reference/cmmn11/tasks/case-task.adoc#exchange-variables">passing variables to called case</a> for more information. </td> | Attributes | source <td> A name of a 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 sub instance variables back </td> |
target <td> Name of the variable inside the calling case instance </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="Process Task">Process Task</a>, <a href="Case Task">Case Task</a> </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/cmmn11/custom-extensions/camunda-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="[variablelistener]"> camunda:variableListener</a>, camunda:caseExecutionListener </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"> Add 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/cmmn11/custom-extensions/camunda-attributes.adoc#class">camunda:class</a> </td> |
||
expression <td> see <a href="openbpm:engine:reference/cmmn11/custom-extensions/camunda-attributes.adoc#expression">camunda:expression</a> </td> |
delegateExpression <td> see <a href="openbpm:engine:reference/cmmn11/custom-extensions/camunda-attributes.adoc#delegateexpression">camunda:delegateExpression</a> </td> |
|
Constraints <td colspan="2"> The event attribute is required and must be one of the task events: create, assignment, complete or delete </td> |
<td colspan="2"> One of the attributes class, expression or delegateExpression is mandatory </td> |
Parent elements <td colspan="2"> <a href="Human Task">Human Task</a> </td> |
variableListener
| Description <td colspan="2"> Adds custom code to listen to variable events such as the creation, update or deletion of a variable. A listener defined on a model scope (like the case plan model, a human task, etc.) is notified for all variable events that occur in this scope or any of its subordinate scopes. </td> | Attributes | event <td> The type of the event for which the listener is called </td> |
|---|---|---|
class <td> see <a href="openbpm:engine:reference/cmmn11/custom-extensions/camunda-attributes.adoc#class">camunda:class</a> </td> |
||
expression <td> see <a href="openbpm:engine:reference/cmmn11/custom-extensions/camunda-attributes.adoc#expression">camunda:expression</a> </td> |
delegateExpression <td> see <a href="openbpm:engine:reference/cmmn11/custom-extensions/camunda-attributes.adoc#delegateexpression">camunda:delegateExpression</a> </td> |
|
Constraints <td colspan="2"> Valid values for the event attribute are create, update and delete. This attribute is optional and if left out, the listener is notified for all kinds of events. </td> |
<td colspan="2"> Either one of the attributes class, expression or delegateExpression, or a camunda:script child element is mandatory. </td> |
Parent elements <td colspan="2"> Case Plan Model, <a href="Stage">Stage</a>, <a href="Human Task">Human Task</a>, <a href="Process Task">Process Task</a>, <a href="Case Task">Case Task</a> </td> |
variableOnPart
| Description <td colspan="2"> Add variableOnPart to sentry. see <a href="openbpm:engine:reference/cmmn11/sentry.adoc#variableonpart">variableOnPart. </td> | Attributes | variableName <td> see <a href="openbpm:engine:reference/cmmn11/custom-extensions/camunda-attributes.adoc#variablename">camunda:variableName </td> |
|---|---|---|
Constraints <td colspan="2"> variableEvent element and variableName attribute are mandatory fields when the variableOnPart is defined in a sentry. </td> |
Parent element <td colspan="2"> <a href="Sentries">Sentries</a> </td> |
Child element <td colspan="2"> <a href="[variableevent]">camunda:variableEvent</a> </td> |
variableEvent
| Description <td colspan="2"> Add variableEvent to a VariableOnPart. A sentry is evaluated when the variableEvent transition occurs. </td> | Value <td> Valid values are create,update or delete </td> | Parent element <td colspan="2"> <a href="[variableonpart]">VariableOnPart</a> </td> |
|---|
Лицензия и атрибуция
Эта документация была создана на базе материала "Camunda 7 Docs" от Camunda, находится под лицензией Creative Commons Attribution-ShareAlike 3.0 Unported License .
Оригинал документации: https://docs.camunda.org