setMessage

Changes the message of the Step that is currently being evaluated. Note that the message in the Flow UI may not change immediately upon the command's evaluation as the UI has its own message refresh rate which is likely to not keep up with the speed of the logic evaluation.

Attributes

message
Required	Value type	EL-evaluated
No	String	Yes
The resolved value of this attribute is set as the Step's new message. If not defined, the message will be a blank string.

Examples

Unlike the messages written into the Steps themselves, the setMessage command can set messages including variable values since its message attribute is EL-evaluated.

Greet the user running the Flow:

CODE

<setMessage message="Hello ${UserInfo.fullName}">

Provide information of loop progress:

CODE

<forEach value="${longCollection}" var="item" varStatus="status"><setMessage message="Processing item ${status.count} of ${longCollection.size()}">