Creating Input Parameters

You can define input parameters, and use them anywhere in an operator expression, to inject values dynamically.

Input parameters are preceded by a $ sign. For example, p.name = $player_name AND p.level > $level_threshold

  1. From the top bar, click $ Input parameters.
  2. In the Parameters panel:
    1. Give a name to the parameter. For example, MyParam.
    2. Optional: Define arguments.
    3. Specify a Return type. For example, string.
    4. In Default value, enter the default value that the input parameter will give to the variable.

      If you do not specify any value, the value is NULL. You can use double quotes "" to get an empty value by default.

    5. Select DataQuery parameter, to make the input parameter available in data queries.
  3. Save your configuration.

Then, by binding the input parameter to a variable, the variable can take dynamic values. This is typically useful to filter hits by comparing a field value with a variable value.

For example, you can filter objects by country, with a FILTER operator and a predicate expression calling the input parameter.