Installation
Update CXO to version 21.1.3 (or higher)
Install Identity Provider
Install Oracle EPM Cloud Adapter
Install pre-requisites .NET 5.0 Hosting Bundle:
https://dotnet.microsoft.com/download/dotnet/5.0Run installer
Important: Restart server after installing .NET core hosting bundle for Identity Provider and Oracle EPM Adapter.
Create IIS website for Oracle Epm (Application Pool should have "No Managed Code")
Create Client in CXO Identity Provider
Identity Provider configuration
Create new Generic Client
Check “Allow Offline Access” checkbox
Add Following Scopes:
User profile
User groups
Add Redirect url(-s) in following format {OraclEPMAdapterUrl}/signin-oidc
Add Post Logout Redirect URI’s in following format {OraclEPMAdapterUrl}/signin-oidc-auth
Warning: RedirectUri’s are case sensitive so it’s good practice to use lowercase in all URLs.
CXO configuration and source creation
Note: To be able to use OracleEPMAdapter you need a license key with: Oracle EPM Planning or Oracle EPM Financial Consolidation and Close.
Create a new source system in the SSM for the correct source type: Oracle EPM Planning / Oracle EPM Financial Consolidation and Close. This should create:
Fact database
SSAS cube
Run configuration database creation command: e.g.
.\CXO.Adapter.OracleCloudEpm.Cli.exe create-configuration-db server-name:cxo-dev-sql02 database-name:oracleEpmConfigTest authentication-type:Proprietary username:cxo password:somePassword
Parameters:server-name: name of the server on which the database should be created
database-name: name of the database to be created
authentication-type: windows / proprietary
username: SQL user name (if authentication-type == proprietary)
password: SQL user password (if authentication-type == proprietary)
See CXO.Adapter.OracleCloudEpm.Cli.exe help for detailed description of the command
Run set-authentication-settings command:
e.g. .\CXO.Adapter.OracleCloudEpm.Cli.exe set-authentication-settings idp-authority: https://cxoUrl/idp idp-client-id:clientId idp-client-secret:secret idp-client-allowed-user-group:ADM
See CXO.Adapter.OracleCloudEpm.Cli.exe help for detailed description of the command
Run create-source-in-adapter command
e.g. .\CXO.Adapter.OracleCloudEpm.Cli.exe create-source-in-adapter source-type:pbcs source-name:source factdb-name:factdb-name factdb-server:factdb-server factdb-authentication-type:1 ssas-server-name:ssas-server-name ssas-database-name:ssas-database-name ssas-cube-name:ssas-cube-name
Important: The name of the source should be the same as name of the source in CXO
See CXO.Adapter.OracleCloudEpm.Cli.exe help for detailed description of the command
Restart IIS Application Pool for Oracle EPM Adapter
Oracle EPM system configuration
Make sure we have an account that we can use to connect from the adapter to the Oracle system ( A user with rights to create export job is required - admin user )
Configure metadata export job
Configure data export job
See sections below for more details
Configure metadata export job
Steps to perform:
Go to Overview screen
2. Go to Dimensions tab, click Export button on the right.
3. On the export metadata screen you will see the existing CXO job, might be others as well.
a. create new job. See two screenshots below
b. select all dimensions which should be extracted
The export job name created in Oracle Cloud and export job file delimiter has to be later on used in Oracle EPM Adapter in Metadata General Settings
Configure data export job
Go to the Overview screen
Choose Export Data in the dropdown on the right side of the screen
Create a new data job
Specify the following values:
Location: Outbox
Pick right cube
Choose a delimiter, preferably set it to “Other” and use “|”
Smart Lists are not used currently
Dynamic Members: Exclude
Decimals: none (or discuss with the customer)
Slice definition: take Account on rows, Period on columns, set default slice values for all dimensions incl. POV. Note: this configuration will not be used in the actual data extraction, as it will be input to the job API call.
The export job name created in Oracle Cloud and export job file delimiter has to be later on used in Oracle EPM Adapter in Metadata General Settings
Oracle EPM adapter configuration
Configure connection.
Cube
For Api Url use host url without any path
Application name is the same you see in oracle
For credentials use username combining domain + “.” + username
Example: for picture below username would be a619055.xxxxxxxxxxxxx
Configure dimension mappings. Most standard dimensions would be mapped already – you need to map custom ones. Number of custom Oracle Dimension doesn’t matter and only used on our side. You only need to fill in allias corresponding to custom dimension name.
Example:
3. Configure metadata.
Go to Overview → Dimensions → Extract
4. Configure Data
This one should be filled in consultation with customer.
Multiple members are supported and should be separated by comma
Don’t use quotes around members (even if they contain spaces)
Don’t use “@” before selector methods (like
@Children(YearTotal))
Fill in Account dimension on Row and Period on Column
Select all other dimensions in any order and fill in desired selectors.
Order of POV dimensions is important – we parse data extraction file using it. To figure it out fill in at first in a random order, finish configuration and return to the next step after you have successfully run an extraction. (you will see in logs that data extraction is finished successfully but there would be warning stating that 0 records were mapped)
Download the export data file for your last extraction (it should have at least one record)
Add “.zip” extension to file if necessary.
Open a file. Identify for any record “Porint-of-View” member (it would be few members enclosed in quotes). Identify to which dimension each members belongs. Reorder your pov dimensions in adapter in the same order.
5. Configure schedule.
Create new schedule, name and schedule is up to customer (or you) and not connected to oracle configuration.
Initially you want “Extract Metadata” to be enabled.
Create a data slice.
Multiple members separated by commas are supported.
Don’t use quotes.
Selector functions are not supported yet (e.g. Children(YearTotal)) there is no warning for this so make sure there are not included in Data Slices. Use multiple members to replace such functions.
Example:
Use Run now button to extract data and metadata
You can see the progress of the extraction in the logs tab
After successful extraction Process cube from SQL Server Management Studio (this is temporary solution. This process will be automated in the future)
Logging
The log level can be set in appsettings.json in "LogLevel" property (Both Web project and CLI project have own appsettings.json file)
Location of the log files:
CLI command {CXO-Installation-Dir}\Oracle Cloud EPM Adapter\Extraction\logs
Web application {CXO-Installation-Dir}\Oracle Cloud EPM Adapter\Web API\logs
Log files are split into two file types
nlog-all -contains cxo defined logs and logs generated by other Microsoft libraries. Usually it is more verbose
nlog-own-detailed -contains logs defined by cxo with more detailed information then info in “nlog-all“ and additionally filters logs created by Microsoft libraries.
Logging to the console in CLI tool
Changing log level influence not only logs level saved in the files but also information written to the console.