Back Forward Activity-Set-Status method

Methods and instructions by function

Use this method to force the value of a the pxMethodStatus property to a specific value.

For example, use the Activity-Set-Status method as the final executed method in an activity to convey the outcome of the activity execution to the calling activity. (In many other situations, this method is unneeded as it unconditionally overwrites the current value of pxMethodStatus, which may contain useful information.)

TipThe pxMethodStatus property value is volatile. Many other methods also set this property value. If such a method executes after the Activity-Set-Status method, the value set in this method may be overwritten and lost.

Parameters

This method has two required parameters.

Parameter

Description

Severity Select a return status: Good, Info, Warn, or Fail.
Message Enter a text message to be associated with this status (as a literal constant), or the key of a Rule-Message rule containing a text message to be associated with this status.

Results

The pxMethodStatus property is set to the value specified in the Severity parameter. The message is added to the page.

Definitions Activity-Clear-Status method
How to customize the activity success and exception windows

zzzMethods and instructions by function