Oracle EPM Cloud Adapter - User Guide
Configuring the adapter
CXO admin with right permissions can configure the Oracle EPM Cloud adapter from its web-based Configuration UI page.
All available Oracle EPM Cloud sources are seen on the left panel. Select the source to configure the adapter.
Connection
Under this tab, set up the connection to the Oracle system for the adapter to extract the data:
- Cube: Name of the Oracle cube from which the data is extracted, details are found in Oracle Cloud under Tools>Overview>Cubes.
- API Url: Access point from the Oracle Cloud, the URL used to log into Oracle Cloud (see Oracle EPM Cloud Adapter - FAQ for more details)
- Application Name: Application that contains the given cube, details are found in Oracle Cloud under Tools>Overview
- User: Credentials used by the adapter to retrieve information from the Oracle Cloud.
Dimension Mappings
Define how CXO dimensions should be mapped to the Oracle dimensions from this tab. Some points to remember:
- Some CXO standard dimensions (such as Account) are by default mapped to certain Oracle EPM standard dimensions.
- Some CXO dimensions (such as FLO, GAP, ICP, MEA) can be mapped to an Oracle EPM custom dimension or left unmapped.
- Custom CXO dimensions (such as A01) can be mapped to an Oracle EPM custom dimension or left unmapped.
- If an Oracle EPM dimension has an alias defined in the Oracle EPM Cloud system, then the alias also needs to be added in the Dimension Mappings.
-
Refer here for PBCS dimensions, and refer here for FCCS dimensions.
AggregationIn some of the Oracle systems while using the Entity dimension, the default aggregation of data from children does not work. In such a situation we should extract data for all levels of the Entity dimension. This can be done by disabling the default aggregation for the Entity dimension which has been set as its default setting.
- CXO dimension Value can be mapped to Oracle EPM dimension Currency or left unmapped.
Metadata
Define the general properties for the metadata extraction job and filters that should be applied while extracting metadata from Oracle EPM cloud from this tab.
General Settings
Export job name: Name of the job that extracts metadata from the Oracle EPM Cloud.
Note: The name of the export job in Oracle EPM Cloud and in Metadata tab should be the same. See Oracle EPM Cloud Adapter - Installation Guide for more details.Export job file delimiter: Delimiter used in the downloaded metadata file (CSV), will be typically either a comma (,) or a semicolon (;).
Dimension Alias: Column name in the extracted CSV that corresponds to a dimension alias
o CXO allows 3 dimension aliases to support multiple languages. When metadata is extracted from Oracle EPM, aliases in CSV are typically stored in a column named Alias: Default or Alias: English.
To illustrate the file structure, a snippet of the extracted metadata CSV file is shown below:
Account, Parent, Alias: Default, ... <rest of the header row>FCCS_System Account, Account,, ... <rest of the data row>Exchange Rates, Account,, ... ... FCCS_Inventories, FCCS_Current Assets, ... A410, FCCS_Inventories, Raw materials, ... A420, FCCS_Inventories, Work in progress, ...
Filters
By default, the complete dimension hierarchy gets loaded. As this might be too much data, you have an option to exclude unwanted members of the hierarchy by adding filters. For example, if filter for Entity Europe is added, then the member Europe and all its descendants will be excluded from the metadata extraction.
Another supported filter allows removing all children of provided entry. For example, if we want to make “Europe” entry a leaf member and filter out all its descendants. The syntax is Children(Europe).
Data
Define general properties and filter that are applied when extracting the data from Oracle EPM Cloud.
You can specify data extraction for all members (instead of leaf members only) for Entity dimension using “IDescendants” method.
General Settings
Export Job Name: Name of the job that extracts metadata from the Oracle EPM Cloud.
Note: The name of the export job in Oracle EPM Cloud and in Metadata tab should be the same. See Oracle EPM Cloud Adapter - Installation Guide for more details.Export File Delimiter: Delimiter used in the downloaded metadata file (CSV), will be typically either a comma (,) or a semicolon (;).
File structure and filters
To load the data in CXO, CSV file structure for the extracted data from Oracle EPM must be defined. The structure is explained by the following example:
Account|Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec|Point-of-View|Data Load Cube Name DSO|#missing|#missing|#missing|#missing|#missing|#missing|45|45|45|45|45|45|"FY15|Forecast|Working|000|P_000"|Plan1 1290|27010144.3|27010144.3|27010144.3|27010144.3|27010144.3|27010144.3|#missing|#missing|#missing|#missing|#missing|#missing|"FY15|Forecast|Working|000|P_000"|Plan1 1310|5751347.75|5702141.46|5709563.28|5716113.26|5705995.47|5701355.24|2929495.285|3069860.55|29861952.18|26789869.71|29056293.78|36672041.505|"FY15|Forecast|Working|000|P_000"|Plan1 1360|-1150269.42|-1160110.42|-1161594.96|-1162904.94|-1164928.94|-1165856.94|-1312331.731425|-1465824.7743|-1615134.5352|-1749083.883675|-1894365.352575|-2077725.5601|"FY15|Forecast|Working|000|P_000"|Plan1 1710|2314782.58|2314782.58|2314782.58|2314782.58|2314782.58|2314782.58|#missing|#missing|#missing|#missing|#missing|#missing|"FY15|Forecast|Working|000|P_000"|Plan1
From the first row we see that in each line of the CSV:
- First value corresponds to the Account, which means that each row of data corresponds to the same account.
- Next 12 values correspond to the Period, which means that each column of data corresponds to the same period.
- Next value corresponds to “Year | Scenario | Version | Entity | Product”, which means that it defines the rest of the dimensions for this row of data.
To extract the data from Oracle EPM Cloud, the file structure is defined for rows, columns, and the rest of the point of view by choosing from the Mapped Dimensions.
Selections
For each dimension, a relevant subset data can be specified by using Oracle EPM’s Member Selection string. Typical values would be:
Getting data for all base members: for example, ILvl0Descendants(Account) for Account dimension.
Getting data only for one specific member: for example, Working for Version dimension.
Getting data for a few specific members: for example, Europe, US, Asia for Version dimension.
Refer member API docs, export data API docs for more information on member selection.
Scheduling
Schedule the time when metadata and data should be extracted from this tab. A schedule can be on a daily or a weekly basis, and the extracted data set is defined with a combination of Period, Year, and Scenario (for example Q1 2020 Actual).
Logs
All the log files for the running adapter are captured under this tab, and thus helps in troubleshooting if need be. A few things to note:
- Only the recent log entries are loaded, as the user scrolls down, more entries get automatically loaded.
- Filtering the log entries is possible.
- Log entries are not updated live, but only on when the page is loaded, or any filtering is applied.
For troubleshooting applications errors you can also use application logs on the server: Refer Oracle EPM Cloud Adapter - Logging for more details.