Configure a String Billboard 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.

Copy

Example: Return only stockpiles that match the value entered for the {Mine Source Name} string parameter.

select StockpileID, Name
from Stockpile
where name = {Mine Source Name}
Copy

Example: Return all despatch orders for which the despatch order name includes the value entered for the {DOName} string parameter.

select DespatchOrderID 'ID', Name 'Despatch Order Name'
from DespatchOrder
where Name like ('%' + {DOName} + '%')

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

Activity Steps

  1. Open the Billboard (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.
  5. Click Save.