FORMCONTROL

TIBCO iProcess Workspace (Windows)

Warning: (iProcess only) This expression is not available to the TIBCO iProcess Script Server Plug-in. Therefore, even though you can successfully enter the expression in your iProcess Script plug-in definition, it will not be processed by the iProcess Engine. It will return SW_NA.

Performs the specified action on the current form.

Syntax

FORMCONTROL (action)

where action is one of the following numeric values, specifying the action to be done:

Value

Action

0

abort the form window; as a result it no longer exists and the form it represents must be kept or released by calling the appropriate SAL interface function

1

undo changes to field values since the form was opened

2

keep the form in the work queue after closing the window

3

Release the form from the work queue after closing the window; this acts like keep if the form is not releasable

4

hide the form window so the user cannot interact with it; the window must subsequently be redisplayed with show or the form closed with keep or Release

5

show the form window after hide

Returns

One of the following numeric values:

Value

Description

0

Action not performed

1

Success

Examples

TIBCO iProcess Modeler:

FORMCONTROL (0) aborts the form window so that all data entry can be performed in a separate application which calls the SAL API functions directly.

TIBCO Business Studio:

IPEEnvironmentUtil.FORMCONTROL(0);