ETL PayPal in Oracle Data Integrator

Ready to get started?

Download for a free trial:

Download Now

Learn more:

PayPal JDBC Driver

Easy-to-use PayPal client enables Java-based applications to easily consume PayPal Transactions, Orders, Sales, Invoices, etc.



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

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

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

This article walks through a JDBC-based ETL -- PayPal to Oracle. After reverse engineering a data model of PayPal 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 userlib directory:

On Unix: ~/.odi/oracledi/userlib On Windows: %APPDATA%\Roaming\odi\oracledi\userlib

Restart ODI to complete the installation.

Reverse Engineer a Model

Reverse engineering the model retrieves metadata about the driver's relational view of PayPal data. After reverse engineering, you can query real-time PayPal data and create mappings based on PayPal 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 PayPal.
    • Technology: Select Generic SQL (for ODI Version 12.2+, select Microsoft SQL Server).
    • Logical Schema: Enter PayPal.
    • Context: Select Global.
  3. On the Data Server screen of the resulting dialog, enter the following information:
    • Name: Enter PayPal.
    • Driver List: Select Oracle JDBC Driver.
    • Driver: Enter cdata.jdbc.paypal.PayPalDriver
    • URL: Enter the JDBC URL containing the connection string.

      The provider surfaces tables from two PayPal APIs. The APIs use different authentication methods.

      • The REST API uses the OAuth standard. To authenticate to the REST API, you will need to set the OAuthClientId, OAuthClientSecret, and CallbackURL properties.
      • The Classic API requires Signature API credentials. To authenticate to the Classic API, you will need to obtain an API username, password, and signature.

      See the "Getting Started" chapter of the help documentation for a guide to obtaining the necessary API credentials.

      To select the API you want to work with, you can set the Schema property to REST or SOAP. By default the SOAP schema will be used.

      For testing purposes you can set UseSandbox to true and use sandbox credentials.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.paypal.jar

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

      Below is a typical connection string:

      jdbc:paypal:Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;InitiateOAuth=GETANDREFRESH
  4. On the Physical Schema screen, enter the following information:
    • Schema (Schema): Enter PayPal.
    • Schema (Work Schema): Enter PayPal.
  5. In the opened model click Reverse Engineer to retrieve the metadata for PayPal tables.

Edit and Save PayPal Data

After reverse engineering you can now work with PayPal data in ODI. To view PayPal 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 PayPal. You will load Transactions 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 Transactions table in PayPal: CREATE TABLE ODI_DEMO.TRG_TRANSACTIONS (GROSSAMOUNT NUMBER(20,0),Date 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_TRANSACTIONS 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_TRANSACTIONS table from the Sales Administration model onto the mapping.
  7. Drag the Transactions table from the PayPal 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 TRANSACTIONS_AP in TARGET_GROUP.
  10. In the TRANSACTIONS_AP properties, select LKM SQL to SQL (Built-In) on the Loading Knowledge Module tab.

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