7.11. JBPM Configuration Properties

Table 7.3. JBPM Configuration Properties

Property Description Required?
command
This must be one of: NewProcessInstanceCommand, StartProcessInstanceCommand, GetProcessInstanceVariablesCommand or CancelProcessInstanceCommand.
Yes
process-definition-name
Required for the NewProcessInstanceCommand and StartProcessInstanceCommand if the process-definition-id property is not used. The value of this property should reference the already-deployed process definition that needs a new instance. (This property does not apply to the CancelProcessInstanceCommand.)
Sometimes
process-definition-id
Required for the NewProcessInstanceCommand and StartProcessInstanceCommand if the process-definition-name property is not used. The value of this property should refer to the already-deployed process definition for which a new instance is to be created. (This property does not apply to the CancelProcessInstanceCommand.)
Sometimes
actor
Specifies the JBPM actor identifier. (Only applies to the NewProcessInstanceCommand and the StartProcessInstanceCommand
.)
No
key
Specifies the value of the JBPM key. The key is a string-based business key property on the process instance. The combination of business key and process definition must be unique if a business key is supplied. The key value can hold an MVEL expression to extract the desired value from the EsbMessage. For example, if you were to have a named parameter called businessKey in the body of a message, body.businessKey would be used. (This property only applies to NewProcessInstanceCommand and StartProcessInstanceCommand.)
No
transition-name
This only applies to StartProcessInstanceCommand. Use it only if there is more than one transition out of the current node. If this property is not specified, then the default transition out of the node is taken. The default transition is the first transition in the list of transitions defined for that node in the JBPM processdefinition.xml.
No
esbToBpmVars
This is an optional property for the New- and StartProcessInstanceCommand. It defines a list of variables which need to be extracted from the ESB Message and set into the JBPM context for that particular process instance. The list consists of mapping elements, each of which can have the following attributes:
  • esb
    This is a required attribute. Place an MVEL expression in it and use it to extract a value from anywhere in the ESB message.
  • bpm
    This is an optional attribute containing the name to use on the JBPM side. (If it is omitted, the Enterprise Service Bus name is used instead.)
  • default
    This is an optional attribute which can hold a default value if the ESB's MVEL expression does not find a value set in the ESB message.
  • bpmToEsbVars
    This is structurally identical to the esbToBpmVars property above. Use it in conjunction with the GetProcessInstanceVariablesCommand to map JBPM process instance variables (root token variables) to the ESB message.
  • reply-to-originator
    This is an optional property for the New - and StartProcessInstanceCommand. Specify a value of true to make the process instance store the ReplyTo / FaultTo values of the invoking message's endpoint references within the process instance. These values can then be used within subsequent EsbNotifier / EsbActionHandler invocations to deliver a message to the ReplyTo / FaultTo addresses.
No