Skip to main content
Adaptive Insights
Knowledge and Support - Adaptive Insights

Report Parameters

You can add up to 20 different parameters while building a Matrix Report, which will appear as selectors at the top of the report. Report Parameters allow a user viewing a report to adjust its filtering without having to modify the report using the Report Builder. You can also choose to require that users viewing a report must specify an initial value for one or more parameters prior to running the report, by marking those parameters as prompting parameters.

Time Saving Benefits

Parameters allow end users to quickly change the filters in reports without having to edit the report and change the elements. This reduces the training time for end users and reduces the amount of time end users spend editing reports. 

Parameters can reduce the amount of reports an Administrative user has to create and manage. This is because you can create a report and give the report viewers the option to select specific elements rather than having to create and maintain several iterations of the report for different users. You can also parameterize time in a report so that it updates automatically as time passes. This can help eliminate the need to have to update reports on a monthly basis. 

Common Scenarios

  • Parameterize time in a report so that it dynamically adjusts as time passes or as you import actuals data. 
  • Parameterize currency in a report so that users can quickly run the report in one currency and then switch to another. 
  • Parameterize levels in a report so the users with access to multiple levels can easily choose the level on which they want to base the report. 

Add a Parameter to a Report

Parameters are created by first adding a dimensional element (Accounts, Time, Levels, Versions, Currencies, and/or Custom Dimensions) to an axis or the filter of a report, then dragging that element onto the Parameters area at the top of the Report Builder. This creates a new parameter which is connected to that element, and therefore controls that element. All parameters must be connected to one or more elements in a report, since they must be able to control some aspect of the report. The order in which parameters appear in the Report Builder is the order in which they will appear on the report. Only the first two parameters will appear directly on the face of the report when viewing the report. 

Right-click on a parameter in the Parameter area and select its Properties option, to specify attributes of the parameter: 

  • Label: The text that appears next to the parameter when viewing the report. 
  • Dimension: A read-only field that indicates the type of dimension which the parameter controls. 
  • Prompt before viewing: Checking this box makes a parameter a prompting parameter, which will force the user running the report to specify a parameter choice before viewing the report. Any number of parameters on a report can be marked as prompting parameters. 
  • Initial Choice: The default selection for a parameter when running a report, used when a report is initially viewed. The possible selections for an initial choice are all the available choices for the parameter. The value of the initial choice is the same as the value of its connected element. Changing the initial choice of a parameter will change the value of the connected element displayed in the report builder. For time parameters, the initial choice can be a specific time period or can be a relative choice which will set the initial choice based on the day the report is run: 
  • Current Month/Quarter/Year: Use the month, quarter, or year when the report is run. 
  • Previous Month/Quarter/Year: Use the month, quarter, or year immediately previous to the one when the report is run. 
  • Next Month/Quarter/Year: Use the month, quarter, or year immediately after the one when the report is run. 
  • First Fiscal Month: Use the first month of the current fiscal year. 
  • Last Fiscal Month: Use the last month of the current fiscal year. 
  • First Plan Data Month: Use the earliest First Plan Data month of all versions used in the report. 
  • Last Actuals Month: Use the latest Last Actuals month of all versions used in the report. 
  • Available Choices: Specifies the choices to be displayed in the parameter drop-down list when users run a report. 
  • Connected To: A read-only field which shows which elements on the report are connected to this parameter. 

Disconnect an Element from a Parameter 

Deleting a parameter disconnects it from its connected elements, leaving the elements in place. Deleting an element disconnects it from its connected parameter.

To disconnect an element from a parameter without deleting the element:

  1. Right-click the element and select Properties.
  2. Clear the Connected to parameter check box.

If disconnecting an element from a parameter leaves the parameter with no other connected elements, the parameter is deleted. 

Difference Elements With Parameters 

A difference element can have one or both of its operands parameterized, as long as the difference element is not in the Filters area. To parameterize an operand of a difference element, edit the properties of the difference element and select an existing single-select parameter to control the operand. Parameters must already exist before they can be connected to a difference element. 

  • Was this article helpful?