Pre-Built EPM Cloud Integrations

These pre-built integrations are available for EPM Cloud services:

  • Account Reconciliation
  • Planning
  • Planning Modules
  • Financial Consolidation and Close
  • Tax Reporting
  • Profitability and Cost Management

To use the pre-built EPM Cloud Integrations, you must specify parameters for the integration. Many parameters for automated integrations are selectable from drop-down lists, which eliminates the need to manually enter values. For example, to run a rule or ruleset, you can select from a list of business rules, such as ForceConsolidate or ForceTranslate.

Pre-Built Integrations for Account Reconciliation

Integration Name / Module Module Description Parameters/ Description
Change Period Status Reconciliation Compliance Changes the status of a period (Open, Closed, Pending, Locked)

Period: The name of the period, such as April 2016

Status: Pending, Open, Closed, Locked

Create Period End Reconciliations Reconciliation Compliance

Copies all selected profiles to a period and returns success or failure status.

Period:(String):The name of the period, such as April 2016

Filter (String): The name of the filter that matches the reconciliation

Import Balances Reconciliation Compliance

Imports balance data using Data Management from a previously created Data Load definition.

Period: The name of the period, such as April 2016

dl_Definition: The name of a previously saved data load using the format DL_name such as DL_test

Import Pre-Mapped Balances Reconciliation Compliance

Imports pre-mapped balances.

Period (String): The name of the period, such as April 2016

balanceType (LOV): SUB|SRC for sub system or source system

currencyBucket:(String): Currency bucket, such as Functional

file (String): The name of the file relative to the inbox, for example, balances.csv. The file has to be uploaded to ARCS using EPM Automate or REST API.

Import Pre-Mapped Transactions Reconciliation Compliance

Imports pre-mapped transactions for a particular period.

transactionType: Allowed Transaction Types are BEX (Explained Balance), SRC (Adjustment to Source System), and SUB (Adjustment to Subsystem)

file (String): The name of the file relative to the inbox, for example, transactions.csv. The file has to be uploaded to ARCS using EPM Automate or REST API.

dateFormat: Date Format, such as MM/dd/yyyy, dd/MM/yyyy, dd-MMM-yy, MMM d.yyyy, or All

Import Pre-Mapped Transactions Transaction Matching

Imports a file of pre-mapped transactions into Transaction Matching.

dataSource: Text ID of the data source where the transaction will be imported to

file (String): The name of the file relative to the inbox, for example, transactions.csv. The file has to be uploaded to ARCS using EPM Automate or REST API.

reconciliationType: Text ID of the reconciliation type where the transaction file will be imported to, such as Bank to GL

Import Profiles Reconciliation Compliance

Imports profiles for a particular period.

importType: The import type. Supported values are Replace and ReplaceAll

period: The period for which to import, such as April 2016

profileType: The profile type. Supported values are Profiles and Children

file (String): The name of the file relative to the inbox, for example, profiles.csv. The file has to be uploaded to ARCS using EPM Automate or REST API.

dateFormat: Date Format, such as MM/dd/yyyy, dd/MM/yyyy, dd-MMM-yy, MMM d.yyyy, or All

Import Rates Reconciliation Compliance

Imports rates for a particular period and rate type.

Period: The name of the period, such as April 2016

rateType: The rate type, such as Accounting

Import Rates (Reconciliation Compliance)

file (String): The name of the file relative to the inbox, for example, rates.csv. The file has to be uploaded to ARCS using EPM Automate or REST API.

importType: Supported import types are Replace and ReplaceAll

Monitor Reconciliations Reconciliation Compliance

Monitors list of reconciliations in ARCS.

periodName (String): name of the period

filter (String): filter string used to query list of reconciliations

Run Auto Match Transaction Matching

Runs the auto match process in Transaction Matching.

ReconTypeId: The Text ID of the Reconciliation type to be auto matched

Pre-Built Integrations for Planning and Planning Modules

Integration Name Description Parameters/ Description

Clear Cube

Clears specific data within input and reporting cubes

jobName: Name of the clear cube job.

Cube Refresh

Refreshes the OLAP cube.

jobName: Name of the refresh cube job.

Export Data

Exports application data into a file using the export data settings, including file name, specified in a job of type export data. The file containing the exported data is stored in the repository.

jobName: Name of the export data job.

exportFileName: Optional. File name to which data is to be exported.

Import Data

Imports data from a file in the repository into the application using the import data settings specified in a job of type import data.

jobName: Name of the import data job.

importFileName: Optional. File name from which data is to be imported.

Import Metadata

Imports metadata from a file in the repository into the application using the import metadata settings specified in a job of type import metadata.

jobName: The name of a batch defined in import metadata.

Run Batch Rule

Executes a batch of jobs that have been defined in Data Management

jobName: The name of the report to be executed, such as Dimension Map For POV (Dimension, Cat, Per) Path

reportFormatType: The file format of the report, PDF, XLSX, or HTML

parameters: Can vary in count and values based on the report

Location: The location of the report, such as Comma_Vision

Run Business Rule

Launches a business rule.

jobName: The name of a business rule exactly as it is defined

parameters: run time prompts in JSON syntax.

Run Business Rule Set

Launches a business rule set. Rule sets with no runtime prompts or runtime prompts with default values are supported.

jobName: The name of a business rule set exactly as it is defined.

parameters: Run time prompts in JSON syntax

Run Data Management Report

The Data Management reporting framework represents a unified solution that incorporates source and target data, templates, and user-defined SQL queries. Templates, created in Oracle Business Intelligence Publisher, consume data in XML format and generate reports dynamically. You can add SQL queries to extract data from tables, or couple them with the report parameters to extend the definition of a standard report. Data Management reports can be generated as PDF, Excel, Word, or HTML output.

jobName: The name of the report to be executed, such as Dimension Map For POV (Dimension, Cat, Per) Path

reportFormatType: The file format of the report, - PDF, XLSX, or HTML

parameters: Can vary in count and values based on the report

Location: The location of the report, such as Comma_Vision

Run Data Rule

Executes a Data Management data load rule based on the start period and end period, and import or export options that you specify.

jobName: The name of a data load rule defined in Data Management.

startPeriod: The first period for which data is to be loaded. This period name must be defined in Data Management period mapping.

endPeriod: The last period for which data is to be loaded. This period name must be defined in Data Management period mapping.

importMode: Determines how the data is imported into Data Management.

APPEND to add to the existing rule

POV data in Data Management

REPLACE to delete the POV data and replace it with the data from the file

RECALCULATE to skip importing the data, but re-process the data with updated Mappings and Logic Accounts.

NONE to skip data import into Data Management staging table

exportMode: Determines how the data is exported into Data Management.

STORE_DATA to merge the data in the Data Management staging table with the existing Oracle Hyperion Planning data

ADD_DATA to add the data in the Data Management staging table to Planning

SUBTRACT_DATA to subtract the data in the Data Management staging table from existing Planning data

REPLACE_DATA to clear the POV data and replace it with data in the Data Management staging table. The data is cleared for Scenario, Version, Year, Period, and Entity

NONE to skip data export from Data Management to Planning

fileName: An optional file name. If you do not specify a file name, this API imports the data contained in the file name specified in the load data rule. The data file must already reside in the INBOX prior to data rule execution.

Pre-Built Integrations for Financial Consolidation and Close and Tax Reporting

Integration Name Description Parameters/ Description

Clear Cube

Clears specific data within input and reporting cubes

jobName: Name of the clear cube job.

Cube Refresh

Refreshes the OLAP cube.

jobName: Name of the refresh cube job.

Export Data

Exports application data into a file using the export data settings, including file name, specified in a job of type export data. The file containing the exported data is stored in the repository.

jobName: Name of the export data job.

exportFileName: Optional. File name to which data is to be exported.

Import Data

Imports data from a file in the repository into the application using the import data settings specified in a job of type import data.

jobName: Name of the import data job.

importFileName: Optional. File name from which data is to be imported.

Import Metadata

Imports metadata from a file in the repository into the application using the import metadata settings specified in a job of type import metadata.

jobName:The name of a batch defined in import metadata.

Run Batch Rule

Executes a batch of jobs that have been defined in Data Management

jobName: The name of the report to be executed, such as Dimension Map For POV (Dimension, Cat, Per) Path

reportFormatType: The file format of the report - PDF, XLSX, or HTML

parameters: Can vary in count and values based on the report

Location: The location of the report, such as Comma_Vision

Run As: You must specify this parameter in the Workflow tab.

Run Business Rule

Launches a business rule.

jobName: The name of a business rule exactly as it is defined.

parameters: run time prompts in JSON syntax.

Run Business Rule Set

Launches a business rule set. Rule sets with no runtime prompts or runtime prompts with default values will be supported.

jobName: The name of a business rule set exactly as it is defined.

parameters: Run time prompts in JSON syntax

Run Consolidation

This task is a utility task to run consolidation. Task will prompt user to enter parameters for running the tasks such as Scenario, Year, Period and Entity.

Scenario

Year

Period

Entity: Multiple entities can be added with comma separator.

Run Data Management Report

The Data Management reporting framework represents a unified solution that incorporates source and target data, templates, and user-defined SQL queries. Templates, created in Oracle Business Intelligence Publisher, consume data in XML format and generate reports dynamically. You can add SQL queries to extract data from tables, or couple them with the report parameters to extend the definition of a standard report. Data Management reports can be generated as PDF, Excel, Word, or HTML output.

jobName: The name of the report to be executed, such as Dimension Map For POV (Dimension, Cat, Per) Path

reportFormatType: The file format of the report - PDF, XLSX, or HTML

parameters: Can vary in count and values based on the report

Location: The location of the report, such as Comma_Vision

Run Data Rule

Executes a Data Management data load rule based on the start period and end period, and import or export options that you specify.

jobName: The name of a data load rule defined in Data Management.

startPeriod: The first period for which data is to be loaded. This period name must be defined in Data Management period mapping.

endPeriod: The last period for which data is to be loaded. This period name must be defined in Data Management period mapping.

importMode: Determines how the data is imported into Data Management.

APPEND to add to the existing rule

POV data in Data Management

REPLACE to delete the POV data and replace it with the data from the file

RECALCULATE to skip importing the data, but re-process the data with updated Mappings and Logic Accounts.

NONE to skip data import into Data Management staging table

exportMode: Determines how the data is exported into Data Management.

STORE_DATA to merge the data in the Data Management staging table with the existing Oracle Hyperion Planning data

ADD_DATA to add the data in the Data Management staging table to Planning

SUBTRACT_DATA to subtract the data in the Data Management staging table from existing Planning data

REPLACE_DATA to clear the POV data and replace it with data in the Data Management staging table. The data is cleared for Scenario, Version, Year, Period, and Entity

NONE to skip data export from Data Management to Planning

fileName: An optional file name. If you do not specify a file name, this API imports the data contained in the file name specified in the load data rule. The data file must already reside in the INBOX prior to data rule execution.

Run As: You must specify this parameter in the Workflow tab.

Run Force Consolidation

This task is a utility task to run force consolidation. The task will prompt the user to enter parameters for running the tasks such as Scenario, Year, Period and Entity.

Scenario

Year

Period

Entity: Multiple entities can be added using a comma separator.

Run Force Translation

This task is a utility task to run force translation. The task will prompt user to enter parameters for running the tasks such as Scenario, Year, Period and Entity.

Scenario

Year

Period

Entity: Multiple entities can be added with comma separator.

Run Translation

This task is a utility task to run translation. The task will prompt user to enter parameters for running the tasks such as Scenario, Year, Period and Entity.

Scenario

Year

Period

Entity: Multiple entities can be added with comma separator.

Pre-Built Integrations for Profitability and Cost Management

Integration Name Description Parameters/ Description

Apply Data Grants

Applies data grants for a given Oracle Profitability and Cost Management Cloud application. This API submits a job to create and apply the data grants in Essbase. This API removes all existing data grants in Essbase and recreates them with the latest information from the application. It can also be used to repair data grants if there are any issues.

None

Deploy ML Cube

Deploy or redeploy the calculation cube for a selected Oracle Profitability and Cost Management Cloud application.

isKeepData: Specify whether to preserve existing data

isReplacecube: Specify whether to replace existing

comment: Any user comments

Run ML Calc

Run or clear calculations for a selected application. Use with Management Ledger.

povGroupMember:The POV group member for which to run calculations, such as 2015_January_Actual

isClearCalculated: Whether to clear the calculation data, true or false

subsetStart: Rule Set Starting Sequence Number

subsetEnd: Rule Set Ending Sequence Number

ruleName: Rule Name for a SINGLE_RULE

ruleSetName: Rule Set Name for a SINGLE_RULE option

exeType: The execution type specifies which rules to run; possible values are ALL_RULES, RULESET_SUBSET, SINGLE_RULE. Other parameters are required based on the exeType value.

exeType: ALL_RULES overrides all other options such as subsetStart, subsetEnd, ruleSetName, ruleName, and so on.

exeType: RULESET_SUBSET considers only subsetStart and subsetEnd.

exeType: SINGLE_RULE considers only ruleSetName and ruleName.

comment: Use comment text.

stringDelimiter: String delimiter for POV group members, such as an underscore (_).

Clear ML POV

Clear model artifacts and data from a POV combination for any application.

povGroupMember: The POV group member for which to run calculations, such as 2015_January_Actual

isManageRule: Whether to clear the program rule details

isInputData: Whether to clear input data

IsAllocatedValues: Whether to clear allocated values

stringDelimiter: String delimiter for POV group members

Copy ML POV

Copy model artifacts and data from a Source POV combination to a Destination POV combination for any application. Use with Management Ledger applications.

povs: Included in the path

srcPOVMemberGroup: Source POV member group, such as 2014_January_Actual

destPOVMemberGroup: Destination POV member group, such as 2014_March_Actual

isManageRule: Whether to copy the program rule details

isInputData: Whether to copy input data

modelViewName: To copy a slice of data from source POV to destination POV

createDestPOV: Whether to create the destination POV if it does not already exist

stringDelimiter: String delimiter for POV group members

Run Data Rule

Executes a Data Management data load rule based on the start period and end period, and import or export options that you specify.

jobName: The name of a data load rule defined in Data Management.

startPeriod: The first period for which data is to be loaded. This period name must be defined in Data Management period mapping.

endPeriod: The last period for which data is to be loaded. This period name must be defined in Data Management period mapping.

importMode: Determines how the data is imported into Data Management.

APPEND to add to the existing rule

POV data in Data Management

REPLACE to delete the POV data and replace it with the data from the file

RECALCULATE to skip importing the data, but re-process the data with updated Mappings and Logic Accounts.

NONE to skip data import into Data Management staging table

exportMode: Determines how the data is exported into Data Management.

STORE_DATA to merge the data in the Data Management staging table with the existing Oracle Hyperion Planning data

ADD_DATA to add the data in the Data Management staging table to Planning

SUBTRACT_DATA to subtract the data in the Data Management staging table from existing Planning data

REPLACE_DATA to clear the POV data and replace it with data in the Data Management staging table. The data is cleared for Scenario, Version, Year, Period, and Entity

NONE to skip data export from Data Management to Planning

fileName: An optional file name. If you do not specify a file name, this API imports the data contained in the file name specified in the load data rule. The data file must already reside in the INBOX prior to data rule execution.

Run Batch Rule

Executes a batch of jobs that have been defined in Data Management

jobName: The name of a batch defined in Data Management.

Run Data Management Report

The Data Management reporting framework represents a unified solution that incorporates source and target data, templates, and user-defined SQL queries. Templates, created in Oracle Business Intelligence Publisher, consume data in XML format and generate reports dynamically. You can add SQL queries to extract data from tables, or couple them with the report parameters to extend the definition of a standard report. Data Management reports can be generated as PDF, Excel, Word, or HTML output.

jobName: The name of the report to be executed, such as Dimension Map For POV (Dimension, Cat, Per) Path

reportFormatType: The file format of the report - PDF, XLSX, or HTML

parameters: Can vary in count and values based on the report

Location: The location of the report, such as Comma_Vision