Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →ETL Zenefits in Oracle Data Integrator
This article shows how to transfer Zenefits data into a data warehouse using Oracle Data Integrator.
Leverage existing skills by using the JDBC standard to connect to Zenefits: Through drop-in integration into ETL tools like Oracle Data Integrator (ODI), the CData JDBC Driver for Zenefits connects real-time Zenefits data to your data warehouse, business intelligence, and Big Data technologies.
JDBC connectivity enables you to work with Zenefits just as you would any other database in ODI. As with an RDBMS, you can use the driver to connect directly to the Zenefits APIs in real time instead of working with flat files.
This article walks through a JDBC-based ETL -- Zenefits to Oracle. After reverse engineering a data model of Zenefits 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 (cdata.jdbc.api.jar) and .lic file (cdata.jdbc.api.lic), located in the installation folder, into the ODI appropriate directory:
- UNIX/Linux without Agent: ~/.odi/oracledi/userlib
- UNIX/Linux with Agent: ~/.odi/oracledi/userlib and $ODI_HOME/odi/agent/lib
- Windows without Agent: %APPDATA%\Roaming\odi\oracledi\userlib
- Windows with Agent: %APPDATA%\odi\oracledi\userlib and %APPDATA%\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 Zenefits data. After reverse engineering, you can query real-time Zenefits data and create mappings based on Zenefits tables.
- In ODI, connect to your repository and click New -> Model and Topology Objects.
- On the Model screen of the resulting dialog, enter the following information:
- Name: Enter API.
- Technology: Select Generic SQL (for ODI Version 12.2+, select Microsoft SQL Server).
- Logical Schema: Enter API.
- Context: Select Global.
- On the Data Server screen of the resulting dialog, enter the following information:
- Name: Enter API.
- Driver List: Select Oracle JDBC Driver.
- Driver: Enter cdata.jdbc.api.APIDriver
- URL: Enter the JDBC URL containing the connection string.
Start by setting the Profile connection property to the location of the Zenefits Profile on disk (e.g. C:\profiles\Zenefits.apip). Next, set the ProfileSettings connection property to the connection string for Zenefits (see below).
Zenefits API Profile Settings
In order to authenticate to Zenefits, you'll need to provide your API Key. To create an API Key, from your account head over to Company Overview > Custom Integrations, then besides Rest API Access select Add Token. Set the API Key in the ProfileSettings property to connect.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Zenefits JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.api.jar
Fill in the connection properties and copy the connection string to the clipboard.
Below is a typical connection string:
jdbc:api:Profile=C:\profiles\Zenefits.apip;ProfileSettings='APIKey=my_api_token';
- 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 Zenefits, enter the Schema selected, otherwise enter API.
- Database (Work Catalog): Enter CData.
- Owner (Work Schema): If you select a Schema for Zenefits, enter the Schema selected, otherwise enter API.
- In the opened model click Reverse Engineer to retrieve the metadata for Zenefits tables.
Edit and Save Zenefits Data
After reverse engineering you can now work with Zenefits data in ODI. To view Zenefits 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 Zenefits. You will load People entities into the sample data warehouse included in the ODI Getting Started VM.
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
- 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 People table in Zenefits:
CREATE TABLE ODI_DEMO.TRG_PEOPLE (TITLE NUMBER(20,0),Id VARCHAR2(255));
- 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.
- Click Reverse Engineer. The TRG_PEOPLE table is added to the model.
- 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.
- Drag the TRG_PEOPLE table from the Sales Administration model onto the mapping.
- Drag the People table from the Zenefits model onto the mapping.
- 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.
- Open the Physical tab of the Mapping Editor and click PEOPLE_AP in TARGET_GROUP.
- In the PEOPLE_AP properties, select LKM SQL to SQL (Built-In) on the Loading Knowledge Module tab.
You can then run the mapping to load Zenefits data into Oracle.