Report Parameters
Add | Add a new report parameter to the template. You can add any number of report parameters. |
Remove | Remove the selected report parameter from the template. If the report parameter is used anywhere in the template, you will be asked to confirm the deletion. |
| Move the selected report parameter upwards. |
| Move the selected report parameter downwards. The input fields for the report parameters in the template preview are shown in the same order as given in this list. |
Properties
Parameter name | Provide a unique name for the report parameter. The parameter name will be used to in expressions and will also appear in the Expression Editor. You can use alphanumeric characters or Underscore. If you rename a parameter, the system will automatically update all expressions associated with this parameter. |
Data type | Select the required type of the report parameter. |
Prompt name | This text will be shown as a field label for the report parameter in the preview. Here, you can enter any text. If you do not provide a prompt name, the system will use the parameter name instead. |
Internal | For internal report parameters, no input field is shown in the report preview. |
Multi-Value | If you select this check box, multiple available values are shown as a list of check boxes in the report preview. If this check box is cleared, multiple available values are shown as a simple drop-down list where only one single value can be selected. |
Available Fields
Here, you can provide multiple values for the report parameter. In the report preview, the labels will be shown either as a drop-down list or as a multiple-selection list box, depending on the status of the Multi-Value check box.
If you do not provide any values in the Available Fields list, the report parameter will be shown as a single field in the report preview.
|
The Available Fields section will be disabled for Boolean report parameters. |
Default Values
You must provide a default value for each report parameter. If there are multiple available values, the default value must correspond to one of the available values.
For Boolean report parameters, you can use check box to set the default value to either True or False.
Report templates with report parameters are mainly used for a manual review. However, the report template might still be used in an automated sequence run. In this case, there will be no user who can provide a specific value, the system will therefore use the default value. |