The parameter settings definition is used to define the parameters that can be configured in the software. Specify the list of parameters (key name, type, and default value), method, and script package for this definition.
In the parameter list, specify multiple parameters that can be configured in the software. Each parameter is represented by a key name, type, and default value. However, the default value can also be omitted.
For the parameter setup method, specify which method should be used to configure the parameter values in the software. Select either a batch file parameter settings script that can be used in Windows, or a shell script parameter settings script that can be used in Linux as the method.
A script package is a package file containing the parameter settings script compressed in ZIP format.
Required information
The information to be specified in the parameter settings definition is shown below.
Tag name | Allowable range | Description | Mandatory | Settings | |
|---|---|---|---|---|---|
name | 256 characters or less | Specifies the parameter settings definition name. | Y | ||
description | 256 characters or less | Specifies the parameter settings definition description. | Y | ||
method | Select an option | Specifies the parameter setup method script. | Y | Select from the following options:
| |
parameters | 1 or more | Specifies multiple parameters that can be configured in the software. | Y | ||
key | 1 to 256 bytes | Specifies the parameter key. | Y | Characters that can be used are alphanumeric characters, ".", "_", and "-". However, the first character must only be alphabetic. | |
type | Select an option | Specifies the value type. | Y | Select from the following options:
Refer to "2.1.2 Parameter Types" for details. | |
value | 4096 characters or less | Specifies the default value if a value must be set. The value can be changed when configuring this parameter, but it cannot be left blank. | N | Values that can be specified are determined by 'type'. The string "__EMPTY__" (prefixed and suffixed by 2 underscores) cannot be specified. Variables can be specified as values by prefixing them with # (to specify # or \ as part of the value, prefix them with the \ escape character). Refer to "2.1.3 Variables that can be Specified as Values" for details. | |
label | 64 characters or less | Specifies the label used to display the parameter in the window. | N | ||
description | 256 characters or less | Specifies the parameter description. | N | ||
Script package | 2 MB or less | Specifies the package file containing the parameter settings script compressed in ZIP format. | Y | For details on parameter settings scripts, refer to "2.1.4 Parameter Settings Scripts". For details on package files, refer to "2.1.5 Package Files". | |
