IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Developing business processes > Building human tasks > Create human tasks > Replacement variables and context variables
Replacement variables in staff e-mails
When used in escalation-based staff emails, replacement variables can be used to represent context variables that will be fully resolved in the runtime environment.
To use a replacement variable in a template, encapsulate it in '%' signs, for example: %htm:task.originator%
- Using percent signs within variable names is not allowed.
- If you want to use a percent sign in a string within the replacement variable, then you will need to use two percent signs (“%%”) instead of one.
- Variables can contain XPath expressions. If an XPath expression contains a “%” sign, it must be escaped as specified by XML (using %).
A list of all expressions that can be used in e-mails. Type of variable Expression Description Staff Variables htm:task.originator the user ID of the originator of this task instance htm:task.owner the user ID of the owner of this task instance htm:task.starter task starter name htm:task.administratorss list of task administrators htm:task.potentialOwners list of potential task owners htm:task.editors list of task editors htm:task.readers list of task readers htm:task.potentialStarters list of potential task starters htm:task.potentialInstanceCreators list of potential creators Task variables htm:task.property.customPropertyName value of the task's custom properties If that only the string value of properties can be evaluated. For binary custom properties, the query string will be evaluated.
htm:task.displayName default task display name htm:task.description default task description htm:task.instanceID task instance id htm:task.URLPrefix the link to the client that displays the task details used to construct HTTP references in e-mails. htm:task.URLPrefixAdmin the link to the administrative client when a custom admin client is used (otherwise, use htm:task.URLBPCExplorer instead). htm:task.URLBPCExplorer the link to the Business Process Choreographer Explorer URL with task details htm:input.[part][\XPath] (or htm:input.part[\XPath])
data from task's input message is provided using XPath expressions (Process Server messages usually have a single part, in which case the part name does not have to be specified. When using messages with multiple parts then the syntax in parenthesis has to be used.)
htm:output.[part][\XPath] (or htm:output.part[\XPath])
data from task's output message is provided using XPath expressions (Process Server messages usually have a single part, in which case the part name does not have to be specified. When using messages with multiple parts then the syntax in parenthesis has to be used.)
If that task instances have no default message. Escalation variables htm:escalation.activationState escalation's activation state htm:escalation.description default escalation description htm:escalation.displayName escalation display name htm:escalation.expectedTaskState escalation's expected task state htm:escalation.instanceID a string representation of the escalation instance id htm:escalation(escalationName).receivers escalation receivers htm:escalation.property.customPropertyName value of escalation's custom properties If that only the string value of properties can be evaluated. For binary custom properties, the query string will be evaluated.
htm:escalation.receivers list of users who receive the escalation htm:escalation.URLPrefix the link to the client that displays the escalation details used to construct HTTP references in e-mails. htm:escalation.URLBPCExplorer the link to the Business Process Choreographer Explorer URL with escalation details Process variables wf:variable.\messagePartName[\XPathExpression] This resolves the variable and expression. wf:property.customPropertyName This resolves the custom property. Inline staff variables wf:process.starter The starter of the process. wf:process.administrators The administrators of the process. wf:process.readers The readers of the process. wf:activity(activityName).potentialOwners The potential owners of either the current activity or the activity named in brackets wf:activity(activityName).owner The owner of either the activity named in brackets wf:activity(activityName).editors The editors of either the current activity or the activity named in brackets wf:activity(activityName).readers The readers of either the current activity or the activity named in brackets
For those expressions with XPath, it is expected that XPath will point to objects of type String, or String List. In general, and object will be replaced by what the toString() method returns.
Replacement variables and context variables
Related concepts:
Replacement variables in process and activity descriptions
Replacement variables in people assignment criteria and task descriptions
Replacement variables for escalation duration expressions