Using report output macros

Reports in Portable Document Format (PDF) are delivered to the folder defined in the outputPath report parameter.

You can add any of the following macros to create folders that are appropriate for the report output:

  • $MyReports - creates the personal folder of the user running the report
  • $BusinessUnit - identifies the source of the data in the report
  • $BatchID - the unique number assigned to each batch run of the report
  • $KeyValue - the value used to break out, or split, the report
  • $Default - the default path for your reports. The report administrator sets this path.

To define a folder structure for reports that are split by, for example account code, ensure that the report is grouped by the relevant criterion, for example account code, if a separate report is to be output for each account. An output path containing the $KeyValue macro creates a folder structure for the report output, with individual folders for each account, if these folders are not already present.

To organize reports by business unit and then by, for example, customer, add the macros $BusinessUnit and $KeyValue to the output path, as follows:

/Customer Reports/$BusinessUnit/$KeyValue

To define folders for each batch of reports that are run, each of which is assigned a unique number, you can add the macro $BatchID to the output path, as follows:

/Customer
			 Reports/$BusinessUnit/$KeyValue/$BatchID

where BatchId is the unique number assigned to each batch run.

You can specify the output path either in the outputPath report parameter definition, or by selecting one from a list of paths that have been set up by the report administrator.

Where the output path includes a macro for defining a folder that does not yet exist, the folder is created automatically.

If required you can also delete the report output folder. To do this, highlight the folder, then select the delete icon from the toolbar.