Reporting Dashboards supports parameterization to allow dynamic runtime parameters to be resolved when a dashboard is accessed and the configured data provider is used. Dynamic parameters can be placed anywhere in the statement of Custom Query data providers and all instances of them are replaced by the supplied values when the data provider is used.
The following rules must be followed for parameterization to function as expected:
-
Dynamic parameters must be added to the statement as @{YourName}, where YourName is the name you have defined for the dynamic parameter.
-
Parameter names are case-sensitive.
-
Parameter names must begin with an alphabetic characters or an underscore (_).
-
Parameter names can only contain alphanumeric characters and underscores (_).
-
Parameter names cannot contain spaces.
-
To prevent a parameter name from being replaced, prepend an additional @ symbol before the parameter. For example, @@{YourName}.
-
Macro expansion always occurs before parameter expansion (see Query Macros).
When using a parameter that is not required, enclosing the parameter in parentheses is recommended. This ensures that the statement respects the proper order of operations and returns the expected results.
Parameters require additional configuration when the data provider is configured. This configuration is done from the Edit Parameters dialog box. See Adding a Custom SQL Query Data Provider Type.