PARAM (Wizards)VTML 2

PARAM defines a parameter for a Wizard or a Wizard page.

The following subjects are covered in this document:


Related information about VTML and WIZML:

Tutorial
The Visual Tool Markup Language (VTML)
Reference
VTML reference - overview
Context
VTML for Wizards
WIZARD
PAGE
Related tags
INPUT

top

Tools

PARAM plays a role in the following VTML-driven tools:

  1. Wizard

top


Location

This tag can occur only within the WIZARD tag or within a PAGE tag in a Wizard profile file.

top


Function

The PARAM tag can occur in two different contexts: both the WIZARD tag and the PAGE tag can have parameters defined; the semantics are very different though:

Wizard
Every variable that will be passed on to the WIZML template and that will be given a value somewhere in the Wizard as a result of user input should be defined in a PARAM tag. A default value for the variable can be supplied but this is not required. Whether a value for this variable is required or not can also be defined on this global level.
Page
For page, a parameter value serves as input to be used by a page class: a predefined page from a library like the Wizard Definition Page Library. The value itself can be a variable set on a previous page by user input, a default value set for a variable with a PARAM tag at the WIZARD level, or a constant. A value is required here (which doesn't mean the value cannot be empty - it just needs to be specified).
PARAM is ignored in pages with TYPE="Dynamic".

As follows from this explanation, possible attributes for PARAM depend on the context where it is used.

top


Syntax and Attributes (PARAM for WIZARD tag)

<PARAM .../>
NAME Required. Name of the parameter.
VALUE Initial value of the parameter.
REQUIRED True/False or YES/NO (can be the result of a dynamic expression). Determines whether a value for the parameter is required. The Wizard manager will not enable the Finish button until all required parameters are entered.
Note: This does not work completely reliably: even if a parameter marked as REQUIRED still does not have a value when you arrive on the Wizard's final page, the Finish button will be enabled on that page (though it's disabled on all other pages).

top


Syntax and Attributes (PARAM for PAGE tag)

<PARAM .../>
NAME Required. Name of the parameter.
VALUE Required. Value of the parameter.

top