Ready to get started?

Download a free trial of the Oracle HCM Cloud Driver to get started:

 Download Now

Learn more:

Oracle HCM Cloud Icon Oracle HCM Cloud JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Oracle HCM Cloud.

ETL Oracle HCM Cloud in Oracle Data Integrator



This article shows how to transfer Oracle HCM Cloud data into a data warehouse using Oracle Data Integrator.

Leverage existing skills by using the JDBC standard to connect to Oracle HCM Cloud: Through drop-in integration into ETL tools like Oracle Data Integrator (ODI), the CData JDBC Driver for Oracle HCM Cloud connects real-time Oracle HCM Cloud data to your data warehouse, business intelligence, and Big Data technologies.

JDBC connectivity enables you to work with Oracle HCM Cloud just as you would any other database in ODI. As with an RDBMS, you can use the driver to connect directly to the Oracle HCM Cloud APIs in real time instead of working with flat files.

This article walks through a JDBC-based ETL -- Oracle HCM Cloud to Oracle. After reverse engineering a data model of Oracle HCM Cloud entities, you will create a mapping and select a data loading strategy -- since the driver supports SQL-92, this last step can easily be accomplished by selecting the built-in SQL to SQL Loading Knowledge Module.

Install the Driver

To install the driver, copy the driver JAR and .lic file, located in the installation folder, into the ODI appropriate directory:

  • UNIX/Linux without Agent: ~/.odi/oracledi/userlib
  • UNIX/Linux with Agent: $ODI_HOME/odi/agent/lib
  • Windows without Agent: %APPDATA%\Roaming\odi\oracledi\userlib
  • Windows with Agent: %APPDATA%\Roaming\odi\agent\lib

Restart ODI to complete the installation.

Reverse Engineer a Model

Reverse engineering the model retrieves metadata about the driver's relational view of Oracle HCM Cloud data. After reverse engineering, you can query real-time Oracle HCM Cloud data and create mappings based on Oracle HCM Cloud tables.

  1. In ODI, connect to your repository and click New -> Model and Topology Objects.
  2. On the Model screen of the resulting dialog, enter the following information:
    • Name: Enter OracleHCM.
    • Technology: Select Generic SQL (for ODI Version 12.2+, select Microsoft SQL Server).
    • Logical Schema: Enter OracleHCM.
    • Context: Select Global.
  3. On the Data Server screen of the resulting dialog, enter the following information:
    • Name: Enter OracleHCM.
    • Driver List: Select Oracle JDBC Driver.
    • Driver: Enter cdata.jdbc.oraclehcm.OracleHCMDriver
    • URL: Enter the JDBC URL containing the connection string.

      Using Basic Authentication

      You must set the following to authenticate to Oracle HCM Cloud:

      • Url: The Url of your account.
      • User: The user of your account.
      • Password: The password of your account.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Oracle HCM Cloud JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.oraclehcm.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      Below is a typical connection string:

      jdbc:oraclehcm:Url=https://abc.oraclecloud.com;User=user;Password=password;
  4. On the Physical Schema screen, enter the following information:
    • Name: Select from the Drop Down menu.
    • Database (Catalog): Enter CData.
    • Owner (Schema): If you select a Schema for Oracle HCM Cloud, enter the Schema selected, otherwise enter OracleHCM.
    • Database (Work Catalog): Enter CData.
    • Owner (Work Schema): If you select a Schema for Oracle HCM Cloud, enter the Schema selected, otherwise enter OracleHCM.
  5. In the opened model click Reverse Engineer to retrieve the metadata for Oracle HCM Cloud tables.

Edit and Save Oracle HCM Cloud Data

After reverse engineering you can now work with Oracle HCM Cloud data in ODI. To view Oracle HCM Cloud data, expand the Models accordion in the Designer navigator, right-click a table, and click View data.

Create an ETL Project

Follow the steps below to create an ETL from Oracle HCM Cloud. You will load RecruitingCESites entities into the sample data warehouse included in the ODI Getting Started VM.

  1. Open SQL Developer and connect to your Oracle database. Right-click the node for your database in the Connections pane and click new SQL Worksheet.

    Alternatively you can use SQLPlus. From a command prompt enter the following:

    sqlplus / as sysdba
  2. Enter the following query to create a new target table in the sample data warehouse, which is in the ODI_DEMO schema. The following query defines a few columns that match the RecruitingCESites table in Oracle HCM Cloud: CREATE TABLE ODI_DEMO.TRG_RECRUITINGCESITES (SITENAME NUMBER(20,0),SiteId VARCHAR2(255));
  3. In ODI expand the Models accordion in the Designer navigator and double-click the Sales Administration node in the ODI_DEMO folder. The model is opened in the Model Editor.
  4. Click Reverse Engineer. The TRG_RECRUITINGCESITES table is added to the model.
  5. Right-click the Mappings node in your project and click New Mapping. Enter a name for the mapping and clear the Create Empty Dataset option. The Mapping Editor is displayed.
  6. Drag the TRG_RECRUITINGCESITES table from the Sales Administration model onto the mapping.
  7. Drag the RecruitingCESites table from the Oracle HCM Cloud model onto the mapping.
  8. Click the source connector point and drag to the target connector point. The Attribute Matching dialog is displayed. For this example, use the default options. The target expressions are then displayed in the properties for the target columns.
  9. Open the Physical tab of the Mapping Editor and click RECRUITINGCESITES_AP in TARGET_GROUP.
  10. In the RECRUITINGCESITES_AP properties, select LKM SQL to SQL (Built-In) on the Loading Knowledge Module tab.

You can then run the mapping to load Oracle HCM Cloud data into Oracle.