<param> Element (N1 Grid Service Provisioning System 5.0 XML Schema Reference Guide)

N1 Grid Service Provisioning System 5.0 XML Schema Reference Guide

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

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.