ParameterDocument Structure
Use the ParameterDocument structure to model a parameter, as used by the Action framework.
The ParameterDocument structure is used in the Action Structure.
ParameterDocument Structure Fields
Fields | Description |
---|---|
String Name |
Specifies the name (title) of the parameter. |
String Prompt |
Specifies the prompt displayed to the user for this parameter. |
String Description |
Specifies the description of the parameter document (sometimes displayed as a tooltip). |
String ParameterType |
Specifies the datatype of the parameter which should be one of the following: string integer long float double short decimal boolean byte date dateTime time document |
Array[] ParameterValues |
Specifies an array of parameter value objects. This could be an empty array, or an array with one or more parameter values (see MultiValuesAllowed). |
String ValueFixed |
Specifies whether the parameter values are fixed for this parameter (cannot be overridden). Values are 'true' or 'false'. |
String Order |
Specifies the particular order of parameters in which the owning documents want to keep them. |
String MultiValuesAllowed |
Specifies if the parameter supports multiple values. Values are 'true' or 'false'. |
String Mandatory |
Specifies whether user entry of a value is mandatory.Values are 'true' or 'false'. |