By default, a process instance is given the same description as the process definition from which it is created. However, its description can be changed while the process instance is running using the Set Process Instance Description Java Action.
To set the process instance description:
Click the empty space in the Process Definition editor or select the node to which you want to assign the Java Action, to display the Properties view for the process definition or the node respectively.
Select the Action Set tab. Click Add corresponding to the position where you want to add the Java Action. The Action Type List dialog is displayed.
Expand Server Actions and double click Set Process Instance Description.
Type a descriptive name and your notes for the Java Action.
Enter a JavaScript expression in the Process Description field that evaluates to a String value.
There are different ways to set the description. You can type a constant (that is, a description), select a User Defined Attribute (UDA) that has the description as its value, or build a complex JavaScript expression that evaluates to a description. For details, refer to section 11.14 Defining JavaScript Expressions.
In the following example, the process instance description is composed of the string Process started and the value of the UDA Description.
Figure 11.19 Setting the Process Instance Description
Click OK.
Note
It is not necessary to compensate this action using a compensation action, because changes made by this action are in Systemwalker Runbook Automation only and they will be rolled back after the process instance goes into error state. For information on compensation actions, refer to section 11.1.7 Dealing With Errors in Java Actions.
