Configure a String Report Parameter

String parameters enable entry of text; that is, sequences of characters such as names or IDs or descriptions, in order to filter billboard or report results.

For examples, see Configure a String Billboard Parameter.

Security Note: You need the Allow report maintenance security right in the Reporting domain security rights group for this activity.

Activity Steps

1. Open the Report (configuration).
2. Select the Parameters tab.
3. Right-click in the Parameters field group and select New » String Parameter from the menu.
4. Complete the following fields.
   • Name—Case-sensitive name of the parameter that is used in the query.
   • Caption—Caption used when prompting for the parameter value.
   • Required—Whether the parameter must be defined before data can be retrieved.
   • Force Refresh—Whether the parameter is refreshed if its value is dynamic.
   • Default Value—Default value of the parameter, used to display a preview of the SQL query. The maximum length of the default value for string parameters is 2000 characters.
   • Display Parameter in Report Header—Only applicable to parameters used in reports with a report header, such as MineMarket standard reports. Default: Checked.

     Note: When running a report, only parameters with selected values can be displayed in the report header. If no value is selected for an optional parameter, the parameter does not display, even if Display Parameter in Report Header is checked in the parameter configuration.

5. Click Save.