How to add parameters to your reports

Sometimes in reporting, you need extra parameters for your users or specific filters. An example of this could be to filter report results or add a list of users by tag.

Requirements

This procedure requires SQL development skills.

Adding parameters: generic steps

The generic steps to add parameters are the following:

  1. Duplicate the report you want to edit
  2. Add the parameter
  3. Modify the query
  4. Save the report
  5. Activate your report in your desired application

In this guide, we will focus on steps 2 and 3.

Adding the parameter

1. To add a parameter, open your report's copy and click on Query Editor

mceclip2.png

2. Click on the query to the left.

Note: if you have more than one query, you might have to add your parameter to all the required queries.

mceclip3.png

3. Click on Add Parameter on the right of the screen.

mceclip4.png

4. Select your parameter type. Which one you select will depend on the type of parameter you need to use. 

mceclip5.png

5. Click on the Add button.

Note: In our example, we will just use a numeric parameter where the user will input a number to filter-out results from the query.

mceclip6.png

The new parameter is now available.

mceclip7.png

Using the parameter: call it from the query

Now that we've added the parameter, we want to do something with it in our report's query.

In this example, we will filter out all results that have fuel refills level above 10 liters. This example applies to the FU1005 report.

1. To do so, we will modify our query calling out this parameter.

mceclip8.png

2. Save the query

3. Click on the Back button at the bottom of the query editor.

4. Save the report.

Results

Before the filter

mceclip9.png

After the filter

With the filter, we will now only observe values that are above 10 liters of fuel in the Refill Volume column.

mceclip12.png