Report URLs can include query string parameters where the values are passed into filters that have been added within the report.
Parameters can be used in part filters, column filters, or row group filters.
These filters must accept values that are typed in, unless a custom filter is built specifically with parameters in mind.
- To use a parameter in a report, it must first be declared.
a. In your report, click Edit.
b. On the Edit Report window, in the 'Parameters' box, declare the desired parameter(s) using a tag.
<param id="NAME_OF_PARAMETER" />
- In the relevant filter, rather than filtering on a particular value, a declared parameter would be specified instead (prefixed with @).
The "Application Submitted" filter normally filters on a date value that is typed in. However, we want the filter to instead accept some value that would actually be passed into the report via its URL.
Example of a parameter used in a column filter:
- Append your report URL (in the rendered view, i.e. where the URL contains /render) to include the parameter(s) and the value(s) to be passed in, e.g.,
a. Replace parameter with the parameter(s) used in Step 2 above.
b. Replace value with the value(s) you'd like to pass into the filter(s) in question.
In this Class Profile report, we want to compare application data from 2018 and 2017.
In the columns under the 2017 group, rather than filtering for applications that were submitted after a specific date, @submitted2017 is set as a parameter.
The same has been done with the 2018 column group, using the parameter @submitted2018.
Both of these parameters are declared in the Edit Report section:
When the parameters and desired values are appended to the render URL, like so: &submitted2017=9/1/2016&submitted2018=9/1/2017, data will display based on the values passed in.
Using parameters in reports is particularly helpful for sharing the same report with multiple users, but where each individual user's view may need to be slightly different based on particular parameters.