Back Forward TaskStatus-Set method

Methods and instructions by function

Use this method in activities with an Activity Type of Utility that return a value that a flow rule can examine to make decisions. The system can test the output of this method to determine which connector to take.

On the Visio presentation of a flow, the Utility shape shape identifies a utility task.

For example, a utility task named Direction could analyze geographic information and return one of four values, North, South, East,. and West. Four connector lines leading from this utility task in the flow diagram can correspond to these four values.

NoteDon't confuse the output of this method (the property Code-Pega-Thread.pxTaskStatus on the pxThread page, returned to a flow, to be tested by connectors) with the method status (a property on the pxResults page indicating whether method execution was successful). All but a few methods set the method status.

NoteThe value you set through this method remains until the next execution of the TaskStatus-Set, or a decision shape is processed, or the user completes a flow action. Advancing to another utility task or testing the value does not clear the value.

Parameters

This method has two parameters:

Parameter

Description

TaskStatus Enter a literal text value to be returned to in the flow instance following the activity. The system sets this value in the pxTaskStatus property. Connectors (Visio arrows) on the Diagram tab of the flow rule can test this property value.
TaskStatusInfo Optional. Enter a short explanation for the status.

Results

This method sets the text value supplied in the TaskStatus parameter into the pxTaskStatus property on the pxThread page. This property value is arbitrary and unedited. The flow can examine this value to make a decision.

Also, this method sets the text value supplied in the TaskStatusInfo parameter into the pxTaskStatusInfo property.

Checking the method status

This method updates the pxMethodStatus property. See How to test method results using a transition.

Definitions connector, activity type, utility task
Related topics Flow form — Editing in Visio — Connectors and Flow Actions
Flow form — Editing in Visio — Utilities

zzzMethods and instructions by function