EPM Automate Run Supplemental Data Report, How to generate relational repors on Supplemental Data

runSupplementalDataReport

Generates relational reports that display data from Supplemental Data Manager.

Supplemental Data Reports are grouped as Non-Consolidation Reports in Financial Consolidation and Close and Tax Reporting. See "List of Predefined Reports and Parameters" section in Generate Report for Financial Consolidation and Close and Tax Reporting in the REST APIs guide for a list of reports you can generate and the parameters for generating them.

Applies to

Financial Consolidation and Close, and Tax Reporting.

Required Roles

Service Administrator
Power User
User
Viewer

Usage

epmautomate runSupplementalDataReport FILE_NAME GROUP_NAME REPORT_NAME REPORT_FORMAT [Param=value] where:

FILE_NAME is a unique file name for the report, including the extension specified as the value of the REPORT_FORMAT parameter.
GROUP_NAME is the name of the group with which the report is associated.
REPORT_NAME is a unique name for the report to be generated.
REPORT_FORMAT is one of the following formats for the report:
- PDF
- HTML (not supported for graphs and charts)
- XLSX (not supported for graphs)
- CSV
- CSV2
REPORT_FORMAT CSV does not permit the formatting of data based on a template while CSV2 does. Generating CSV2 formatted report takes more time compared to CSV output.
Param=value, optionally identifies the required parameters for generating the report. For example, to generate the At Risk Tasks report, which takes a schedule name with the value monthly and a period with the value Jan, specify "schedule name"=monthly period=Jan.

Example

epmautomate
                runSupplementalDataReport "Example_File_name.html" Group1 "At Risk Tasks" html
                    "schedule name"=monthly period=Jan