Report Collection - Substitution Variables
  • 1 Minute to read
  • Dark
    Light
  • PDF

Report Collection - Substitution Variables

  • Dark
    Light
  • PDF

Article summary

Planful automatically recognizes reports that contain substitution variables added to a Report Collection and provides output with substitution variable names and values. This includes both standard and dynamic substitution variables used in report headers and footers, report member selections, substitution variables used in Report Sets, and line headers.

You can do the following to use substitution variables in your report collection:

  1. Create a Report Collection and select substitution variable members, for example, @CURFCST@.
    RC16
  2. Save the Report Collection and Run it. 
  3. When you click Run, you can select a value for an alternative variable. To select a different value, click the Browse icon next to the substitution variable value.
    RC17
  4. The list represents all substitution variables used in all reports added to the Report Collection. If a single variable is used in multiple reports or multiple times in a single report, it is displayed only once in the list. In this case, 2023 Forecast is the current value selected. Optionally, select another value from the list to replace 2023 Forecast
  5. Click Run to process the Report Collection. 

Each report is run based on the selected substitution variable value(s). The values selected are not saved and are only used for the individual report run. 

Usage Column

In the Usage column, the following are the indicators used to denote where the substitution variables are used in the selected reports:

  • - Used in Dimensions
  • R - Report Sets
  • H - Headers

You can view a combination of indicators if the substitution variable is used at multiple locations within the selected reports. Navigate to Cloud Scheduler, Job Manager. Select Report Collection and click Detail Log. The Detail View page appears. The substitution variable name and value are displayed as part of the report name. Download the output in Excel.


Was this article helpful?