iProcess Variables

The following iProcess variables are defined.

Variable

Description

$RETURN

(any type) $RETURN can only be used in scripts. A value may be assigned as a result of a script being executed or $RETURN may be used in an expression. When a script has finished executing, the value of this variable is used as the return value of the script. If the value of this variable has not been assigned during the execution of the script, the return value of the script is the value of the last expression executed within the script. See SCRIPT for more information about the SCRIPT function.

$ARGn

(text) $ARGn can only be used in scripts. Use $ARGn to pass parameter values into a script. See SCRIPT for more information about the SCRIPT function.

Note: The $ARGn variable is treated as a string by iProcess. This means if you pass a numeric value to $ARGn, you must convert the string back to a numeric value within the script. For example, accnum:=num($ARG1).

$IPn

(any type) $IPn can only be used to change the value of input parameters in a sub-case using an event step in the parent process. $IPn refers to a sub-procedure input parameter where n is a positive integer that is automatically assigned to the sub-procedure input parameter by iProcess. $IPn inherits the type of the sub-procedure input parameter. For more information, see TIBCO iProcess Modeler - Integration Techniques.

$IPTn

(any type) $IPTn can only be used to change the value of input parameters in a sub-case started from a dynamic sub-procedure call. This is done using an event step in the parent process. $IPTn refers to a sub-procedure input parameter derived from a sub-procedure parameter template where n is a positive integer that is automatically assigned to the sub-procedure input parameter by iProcess. $IPTn inherits the type of the sub-procedure template input parameter.

$OPn

(any type) $OPn can only be used in output parameter scripts. $OPn refers to a sub-procedure output parameter where n is a positive integer that is automatically assigned to the sub-procedure output parameter by iProcess. $OPn inherits the type of the sub-procedure output parameter. For more information, see TIBCO iProcess Modeler - Integration Techniques.

$OPTn

(any type) $OPTn can only be used in sub-procedure output parameter scripts. $OPTn refers to a sub-procedure output parameter derived from a sub-procedure parameter template where n is a positive integer that is automatically assigned to the sub-procedure output parameter by iProcess. $OPTn inherits the type of the sub-procedure template output parameter.