Task parameters
A task parameter is a variable that is used by a task or task action. It is optional and dependant upon the defined task or task action. Administration Services currently supports four data types for parameters.
Table 1 summarizes the metadata that you define for a task parameter.
| Metadata | Description |
|---|---|
| name | The unique name for the task parameter. Note: Ensure
that the name matches the variable that is specified in the script
for the task action.
|
| type | The supported data type for the parameter as follows:
When the administrator specifies a value for the task parameter, validation for the data type occurs on the web client. Note: When performing a task,
if an input parameter is of the File type, any file
that you upload for executing a task is saved to the location JazzSM_Home/admin/var/download.
You can clean this folder as required.
|
| defaultValue | The optional default value for the task parameter. For the List type parameter, this field is mandatory and it must contain one or more comma-separated values. |
| isOptional | The flag to indicate whether the task parameter is optional. If it is optional, the administrator can choose to specify a value when you run the task in the CLI or the Administration Services UI. If it is not optional and static, you must specify a value when you first deploy the task bundle in the Administration Services command-line interface. If it is not static but mandatory, the administrator must specify a value when the task is run in the CLI or the Administration Services UI, otherwise the task cannot run. |
| isStatic | The flag to indicate whether the task parameter represents a static variable. For the File type parameter, set this value to false. If it is static, the value is specified once, when you first deploy the task bundle in the Administration Services command-line interface. The variable cannot be optional. If it is not static, the administrator can specify it when the task is run in the CLI or the Administration Services UI; alternatively, you can specify it when you define the task parameter metadata. |
| displayName | The display name for the parameter. It can contain English characters only and the field is translatable. |
| description | The description of the parameter. It can contain English characters only and the field is translatable. |