Report Parameters

Report parameters are used by the SQL query, DLL or script to return the dataset that is then passed to the Crystal Reports template.

The following parameter types are available:

  • 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.

  • Boolean parameters represent binary inputs or values that are in one of two possible states: true or false. Boolean parameters are used to toggle specific conditions or filters.

  • Number parameters enable entry of numbers; that is, sequences of numerals such as quantities, in order to filter billboard or report results.

  • Date parameters enable selection of a time and a specific, relative or fixed date, or a shift. Specific date examples: Day 1 of Current Month, Quarter 2 of Previous Year. Relative date examples: Yesterday, Last Day of Previous Month, Previous 2 Days, First Day of Next Month.

  • 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.

  • BTTextList parameters create selection criteria for string fields where the value comes from one of the predefined MineMarket Text Lists.

For all parameters types, a default value is optional, and whether the parameter is required is configurable. Report parameters can be displayed in the report header.

If the method used to populate each table in the report is by SQL query, the report parameters are used in the query string by enclosing the parameter name in curly brackets {}. The query string itself does not have to include quotes around the parameter (that is, {Parameter} and not '{Parameter}'), as the quotes are automatically added when the actual value is substituted.

If the method to be used to populate each table in the report is by external DLL or script, the report parameters can also be referenced and used in a query string.

When the report is run, the actual values are substituted for the report parameters.

Report parameters can be loaded automatically from the report template as well as created manually.

Parameter names are case-sensitive.