Report parameters allow users to filter or customize the data displayed when running an RI Visual. When a Visual contains report parameters, Rainmaker Insights displays input controls before generating the report.
Parameters can be created by:
Asking RI Chat to add them while building a Visual.
Adding supported parameter syntax directly in the SQL editor.
For example, you can create parameters for:
Date ranges
Clients
Collectors
Users
Account status
Custom filters
UserID Report Parameters
The UserID parameter displays a user selector when the Visual is run.
By default, the selector displays active standard users.
Use one of the following selector modes to control which users appear.
Parameter | Syntax | Example Use |
|---|---|---|
Active standard users (default) |
| Displays a Collector selector that includes active standard users. |
Users and administrators |
| Displays an Owner selector that includes active standard users and administrators. |
Client Access users |
| Displays a selector that includes active Client Access users. |
All active users |
| Displays a selector that includes all active user types. |
Active and inactive standard users |
| Displays a Collector selector that includes active and inactive standard users. |
Active and inactive users of every type |
| Displays a selector that includes active and inactive users of every type. |
Best Practice
Include inactive users only when historical reporting requires them. Otherwise, use the default selector to simplify the user experience.
Example: UserID Report Parameter
The following example creates an Assigned User parameter that displays all active users. When the Visual is run, the selected user's ID is passed to the SQL query.
SELECT
${UserID[ALL_USERS]:Assigned User} AS assigned_user_id,
'Selected Assigned User' AS parameter_description;
Image displays the Assigned User report parameter
Note
The selector mode inside the brackets ([]) determines which users appear in the dropdown, while the text after the colon (:) determines the label displayed to users when they run the Visual.
Image displays the Assigned User report parameter and preview results
Creating Parameters with RI Chat
Instead of writing parameter syntax manually, you can ask RI Chat to create parameters for you.
For example:
Add a Date Range parameter.
Add a Client selector.
Add a Collector parameter.
Add an Owner selector that includes administrators.
Rainmaker Insights generates the required SQL syntax automatically.
Example: Creating a Report Parameter with RI Chat
Instead of adding parameter syntax manually, you can ask RI Chat to create the parameter for you.
For example, enter the following prompt:
Create a report that displays payments by assigned user and add an Assigned User parameter that includes all active users.
Rainmaker Insights generates the SQL and adds the appropriate UserID report parameter automatically.
Image displays the RI Chat prompt and generated report.