Wizard Variables

Wizards can use the following RPE variables. RPE variables are accessed with 'get env ...', while MACROs can be used with ${}or as an RPE variable.

Wizard Variables
Macro Meaning

WIZARDNAME

Name of the Business Wizard.

FRAMENAME

Name of the current frame.

FRAMENUMBER

Number of the current frame in the frame sequence (excluding master and status frames). Frame numbers begin with 1. The status frame returns a value of 0.

FRAMETOTAL

Total number of frames in the frame sequence (excluding master and status frames).

FRAMEMOTION

Current state of wizard processing:

start

The wizard has been started; the user has not yet clicked a button.

back

The user clicked the Back button.

next

The user clicked the Next button.

finish

The user clicked the Finish button.

repeat

The current frame has been redisplayed.

status

The current frame is the status frame of the wizard.

WIZARDARG

A single RPE variable that is created from the ARG string in an appl wizard command, which can be read by any of the wizard's supporting code to receive input from its 'caller.'

If you want to pass multiple pieces of information from the caller to the wizard, you would need to format the information into a single string with an identifiable delimiter (for example, |).

For example, to pass a businessobject type, current state and owner, you could collect them into a Tcl variable sArgString as follows:

set sArgString "$sType|$sState|$sOwner"

appl wizard bus $sBusId MyWizard $sArgString

Then, the wizard program that reads the WIZARDARG RPE variable could split it up again as follows:

set sArgString [mql get env WIZARDARG]

set lArgList [split $sArgString |]

set sType [lindex $lArgList 0]

set sState [lindex $lArgList 1]

set sOwner [lindex $lArglist 2]