Configure a List Report Parameter

List parameters create selection criteria for multiple or single values from a list. The item query returns the list of values from which the selection is made. The setting parameters are used for creating criteria for parameters. For example, the user could select a location and then select a stockpile from that location.

For examples, see Configure a List 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 » List 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. For single-select lists, this is a single value. For multi-select lists, this can be a list of values, separated by a semicolon. The default value(s) supplied correspond to values in the Key Field column that are returned by the list’s SQL query. The maximum length of the default value for list parameters is 4000 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.

    • Database Connection
    • Multi Select—If checked, the list table includes a Selected column with checkboxes for selecting multiple list items. If unchecked, the Selected column does not display.
  5. If Setting Parameters are referenced in the Item Query:
    1. To add a setting parameter, right-click in Setting Parameters and select Add Report Parameter » [selected parameter] from the menu.
    2. To use an existing setting parameter in the item query, right-click in Setting Parameters and select Add Report Parameter » [selected parameter] from the menu.

      Note: The query string itself does not have to include quotes around the parameter (that is, {Parameter} and not '{Parameter}') because the quotes are automatically added when the actual value is substituted.

  6. Enter the following details for the query.
    • Item Query
    • Key Field—Name of the key field to be returned as the list item. The key field should be included in the select clause of the item query.
    • Show Key Field—Whether the key field displays when selecting a value or values for the list parameter. If checked, the key field is included as a column in the list table. If unchecked, the key field does not display.
  7. Click Save.