SETSTEPSTATUS

Usage

TIBCO iProcess Workspace (Browser)

TIBCO iProcess Workspace (Windows)

Sets the status of one or more steps in the current case to either Not processed or Released.

The SETSTEPSTATUS function returns a Boolean value, and so can be used in any iProcess condition expression. It would normally be used as a conditional action when a step is released. When the function is processed by the TIBCO iProcess Engine, the status of the specified steps is changed to the specified value.

The function:

• makes it easier to handle loop constructs which involve waits, by resetting step status before each iteration of the loop.
• allows the use of a wait to synchronize a number of concurrent paths in a procedure, some of which are exclusive, by setting the status of dependent steps on exclusive paths which are not traveled.
Note: For more information about using SETSTEPSTATUS with waits, please see “Using SETSTEPSTATUS to Control the Loop” in the TIBCO iProcess Modeler Basic Design.

Syntax

SETSTEPSTATUS (StepNameList, NewStatus)

where:

• StepNameList is a string which contains the names of all the steps whose status is to be changed. If more than one step name is supplied, the names should be separated by commas.
• NewStatus is one of the following numeric values:

Value

New step status

0

Not Processed

1

Released

Remarks

SETSTEPSTATUS can only be used to set the status of steps which are either Not Processed, Released, or Withdrawn when the function is processed. If a step is Outstanding, the function will return a FAIL value.

Note: Steps named in StepNameList are processed sequentially from left to right. A failure to set the requested status on a specific step does not prevent processing of the remainder of the steps in the list.

Returns

One of the following Boolean values:

Value

Description

TRUE

if the specified status is successfully set for all specified steps

FALSE

otherwise

A FALSE return value will generate one or more of the following entries in the SWDIR\Logs\Sw_warn file.

SWDIR\logs\sw_warn Entry

Meaning

SetStepStatus - not processed StepNameList

The supplied StepNameList argument has an invalid value or is SW_NA.

SetStepStatus - not processed NewStatus

The supplied NewStatus argument has an invalid value or is SW_NA.

SetStepStatus - step stepname does not exist in procedure

The stepname supplied in StepNameList does not exist.

SetStepStatus - step stepname is outstanding, cannot be set to status.

The stepname supplied in StepNameList is Outstanding, so it could not be set to the indicated status (Not Processed or Released).

SetStepStatus - Failed to set the status of step stepname to status.

The stepname supplied in StepNameList could not be set to the indicated status (Not Processed or Released), because the SETSTEPSTATUS function is not supported on the executing platform (for example, on an earlier version of the iProcess Engine).

Examples

TIBCO iProcess Modeler:

1. This example sets the status of step1 to Not Processed.

SETSTEPSTATUS ("step1", 0)

2. This example sets the status of step1, step2 and step3 to Released.

SETSTEPSTATUS ("step1, step2, step3", 1)

3. In this example, if step1 was Outstanding when the function was processed by the server, the function would return a FAIL value. step2 would still be set to Released.

SETSTEPSTATUS ("step1, step2", 1)

Also, the following entry would be added to the SWDIR\Logs\Sw_warn file:

SetStepStatus - step step1 is outstanding, cannot be set to Released.

TIBCO Business Studio:

IPEEnvironmentUtil.SETSTEPSTATUS("step1",0);
IPEEnvironmentUtil.SETSTEPSTATUS("step1,step2,step3",1);
IPEEnvironmentUtil.SETSTEPSTATUS("step1,step2",1);