Concept: Matrix Report Parameters
Parameters enable report viewers to narrow the focus of a report. Example: A parameter for levels has
Engineering
and Sales
as options. Viewers can select either option from the parameter drop-down menu. When they rerun the report, the report displays data at the level they selected.Parameters are available for matrix reports only.
Benefits
Adding parameters to a report enables:
- Improved performance by limiting the data that larger reports display.
- Administrators to maintain fewer report iterations for different users.
Parameters also work with reports that display charts.
Adding Parameters
To add parameters, the element must already be in the report rows, columns, or filters. You drag the element from the rows, columns, or filters to the
Parameters
area.You can use these elements as parameters:
- Accounts
- Time
- Levels
- Versions
- Currencies
- Custom dimensions
Initial Choice
You can set an initial choice for parameters. The initial choice is the default choice of the parameter when viewers first run the report.
When you select an initial choice for a parameter, you update the associated element in the columns, rows, or filters. Example: You can add FY 2019 as a column, and make time a parameter. In the parameter properties, set FY 2020 as the initial choice. After you apply the setting, the time element in the column changes from FY 2019 to FY 2020 in the report for the initial run.
Report Viewer
If a report contains parameters, all parameters display as fields with options in the report viewer. You can:
- Click the caret (arrow icon) in the toolbar to collapse the parameters list. You can still use the carousel to navigate the parameters list.
- ClickExpand All Parametersto display all the parameters in the report.
- Save the expansion state of the parameters with the report. The state also persists when you run the report.
- Select a parameter option and rerun the report to focus on specific data in the report.
- Reset the parameters to their prior values before running the report.
Multi-Select Parameters
When users create report parameters from the filters, the
Allow multi-select
option is auto-selected by default. The option enables report viewers to create their own rollups and analyze the data.Example: Level is a multi-select parameter in a budget report. Report users can view a summary of the operational expenses for all levels that they select.
Multi-select parameters are connected to filters. If you delete a filter, that deletes the associated parameter.
For prompting parameters that are also multi-select, the Prompting Parameters page displays all the parameter options. Users can select multiple options from the parameter prompt before running the report.
When users create snapshots of reports with level parameters that allow multi-select, the
Include All Levels
option is disabled. The snapshot reports include only the levels that are selected in the viewer.