Generate Report for Oracle Financial Consolidation and Close Cloud and Oracle Tax Reporting Cloud

Generates either a single predefined report for Oracle Financial Consolidation and Close Cloud, Oracle Tax Reporting Cloud, or a custom report.

This API is version v1.

REST Resource

POST       /HyperionPlanning/rest/fcmapi/{api_version}/report

Request

Example of request body

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 9-5 REPORT

Name Description Path Required
api_version Version of the API you are working with. This release is v1 Yes Yes
groupName The name of the group the report is associated with. Yes Yes
reportName The name of the report to be generated. For example, for predefined reports, see the list of Task Manager Reports Yes Yes
generatedReportFileName The name specified by the user of the report to be generated. If this parameter is not provided, then the report will get generated with the data for reportName parameter in this table. No No
parameters In this example, the parameter is periodName, which is the name of the period, such as June 2018.

Each report may have different parameters. Check the parameters in the table provided in the Parameters table below.

No No
format The format of the report (HTML, PDF, XLS, XLSX, or CSV). Yes No (Default is PDF)
module The module within custom SDM (Supplemental Data Management) or FCCS. FCCS refers to the Task Manager module. Yes YES (Enter FCCS or SDM)
emails Comma separated list of email addresses that will receive the report. No No
{
"groupName":"Task Manager",
"reportName":"Late Tasks",
"generatedReportFileName":"myReport.pdf",
 "parameters":""{'Schedule' : 'Qtr 2 Close', 'Period':'Jun' }",
"format":"PDF",
"module":"FCCS",
"emails":"https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com"
}

Response

Examples of Response Body

Supported Media Types: application/json

Parameters:

Table 9-6 Parameters

Name Description
details In case of errors, details are published with the error string
status See Migration Status Codes
links Detailed information about the link
href Links to the API call
action The HTTP call type
rel Relationship type (self, Job Status). If set to Job Status, you can use the href to get the status of the operation.
data Parameters as key value pairs passed in the request

The following is an example of the response body in JSON format for a for a Financial Consolidation and Close report called My Report in pdf format:

{
     "links": [
         {
             "rel": "self",
             "href": 
"https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/fcmapi/v1/myReport.pdf",
             "action": "POST"
         },
         {
             "rel": "report-content",
             "href": 
"https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/fcmapi/v1/myReport.pdf",
             "action": "POST"
 "GET"
         }
     ],
     "details": "MyReport.pdf",
     "type": "FCCS",
     "status": 0,
     "link": null,
     "error": null,
     "items": null
}

List of Predefined Reports and Parameters

The following table describes each predefined report for Oracle Financial Consolidation and Close Cloud and Oracle Tax Reporting Cloud, and the required parameters.

Additional Predefined Reports Provided in Sample Application

Report Description Required Parameters

At Risk Tasks

Displays a list of At Risk tasks

  • Name of the report

  • Name of the schedule

  • Period––Data is displayed only for the selected period.

Task Compliance Analysis

Displays a selected list of tasks within a specified percentage of tasks that were completed late.

  • Name of the report

  • Name of the schedule

  • Period––Data is displayed only for the selected period. Optional: Minimum % Late––Enable the users to provide a threshold that filters the records to be displayed. For example, if the user enters 10, only users with 10% or more of their tasks completed late are displayed in the report.

Early Tasks

Displays a list of tasks that have been completed earlier than anticipated

  • Name of the report – Early Tasks

  • Name of the schedule

  • Period––Data is displayed only for the selected period.

Late Tasks

Displays tasks that are currently late for the selected period

  • Name of the report

  • Name of the schedule

  • Period––Data is displayed only for the selected period.

Task Performance Analysis by Organizational Unit

Displays key metrics by Organizational unit.

  • Name of the report

  • Name of the schedule

  • Period––Data is displayed only for the selected period.

Rejected Tasks

Displays a list of tasks that have been rejected for the selected period.

  • Name of the report

  • Name of the schedule

  • Period––Data is displayed only for the selected period

Task Audit Trial

Displays the changes made to tasks during a user-selected date range.

  • Name of the report

  • From Date––The selected starting date.

  • To Date––The selected ending date.

  • Optional: Changed By––Enables the user to select records changed by a selected user.

  • Optional: Field Changed––Enables the user to select changes made to a field.

  • Optional: Task ID––Enables the user to select changes made to a task.

  • Optional: Task ID – Enter a specific Task ID

Users with Late Tasks

Displays the count of tasks that are late by user

  • Name of the report

  • Name of the schedule

  • Period––Data is displayed only for the selected period

Custom Report Parameters

Use this table of parameters if you want to generate a custom report.

Name Description Path Required
groupName The name of the group the report is associated with. Yes Yes
reportName The name of the report to be generated. Yes Yes
generatedReportFileName The name specified by the user of the report to be generated. If this parameter is not provided, then the report will get generated with the data for reportName parameter in this table. No No
parameters Types of parameters:
  • Numerical - should be in BigDecimal format.
  • Text - standard string
  • Date - should be in format YYYY-MM-dd
  • Boolean
  • Users - user login ID
  • List of choices - case insensitive values
No No
format The format of the report (HTML, PDF, XLS, XLSX, or CSV). Yes No (Default is PDF)
module The module within Account Reconciliation: RC (Reconciliation Compliance) or TM (Transaction Matching. Yes No (Default is RC)
emails Comma separated list of email addresses that will receive the report. No No