<paramList> Element

The <paramList> element is an optional child of the <executionPlan> element. This element is used to declare a list of parameters for use by the steps contained in the plan and any components that they reference. If specified, this element can only appear one time.

When this plan is run as a top-level plan, the caller is prompted to enter values for all parameters declared in this list. When this plan is invoked as the result of an <execSubplan> step in another plan, the calling plan must explicitly pass values for all parameters that are declared by <paramList> that do not have default values.

The <paramList> element has one required child element, <param>, which is a plan parameter declaration. The declaration includes a name, a prompt, and a default value. You can specify one <param> element for each parameter that you want to declare.

<param> Element

The <param> element is a child of the plan <paramList> element and is used to declare a parameter for use within the plan.

Attributes for the <param> Element

The <param> element has the following attributes:

• name – A required attribute of type identifier, which is the name of the plan parameter. The name must be unique among all top-level plan parameters and variables.

• prompt – An optional attribute that is a string that is displayed in the user interface when prompting for the value of the parameter. If this attribute is omitted, the value of name is used.

• default – An optional attribute that is a string that is the default value of the parameter. The default value can include references to session variables.

• displayMode – An optional attribute that specifies the display mode of the parameter. The following legal values are permitted:

  • PASSWORD – The user-specified value is hidden, which means that the password is not shown or is replaced by asterisks.

  • BOOLEAN – The parameter is specified by means of a check box.

  • CLEAR – The value is displayed as entered.

  If the value is CLEAR or BOOLEAN, the value can be safely displayed as entered. If the attribute is omitted, the value is CLEAR.