Ready to get started?

Download a free trial of the Adobe Commerce Driver to get started:

 Download Now

Learn more:

Adobe Commerce Icon Adobe Commerce JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Adobe Commerce including Customers, Inventory, Products, Orders, and more!

ETL Adobe Commerce in Oracle Data Integrator



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

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

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

This article walks through a JDBC-based ETL -- Adobe Commerce to Oracle. After reverse engineering a data model of Adobe Commerce 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 Adobe Commerce data. After reverse engineering, you can query real-time Adobe Commerce data and create mappings based on Adobe Commerce 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 Adobe Commerce.
    • Technology: Select Generic SQL (for ODI Version 12.2+, select Microsoft SQL Server).
    • Logical Schema: Enter Adobe Commerce.
    • Context: Select Global.
  3. On the Data Server screen of the resulting dialog, enter the following information:
    • Name: Enter Adobe Commerce.
    • Driver List: Select Oracle JDBC Driver.
    • Driver: Enter cdata.jdbc.adobe commerce.Adobe CommerceDriver
    • URL: Enter the JDBC URL containing the connection string.

      Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

      You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

      • Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

      • Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

        If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.adobe commerce.jar

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

      Below is a typical connection string:

      jdbc:adobe commerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myAdobe Commercehost.com;InitiateOAuth=GETANDREFRESH
  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 Adobe Commerce, enter the Schema selected, otherwise enter Adobe Commerce.
    • Database (Work Catalog): Enter CData.
    • Owner (Work Schema): If you select a Schema for Adobe Commerce, enter the Schema selected, otherwise enter Adobe Commerce.
  5. In the opened model click Reverse Engineer to retrieve the metadata for Adobe Commerce tables.

Edit and Save Adobe Commerce Data

After reverse engineering you can now work with Adobe Commerce data in ODI. To edit and save Adobe Commerce data, expand the Models accordion in the Designer navigator, right-click a table, and click Data. Click Refresh to pick up any changes to the data. Click Save Changes when you are finished making changes.

Create an ETL Project

Follow the steps below to create an ETL from Adobe Commerce. You will load Products 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 Products table in Adobe Commerce: CREATE TABLE ODI_DEMO.TRG_PRODUCTS (PRICE NUMBER(20,0),Name 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_PRODUCTS 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_PRODUCTS table from the Sales Administration model onto the mapping.
  7. Drag the Products table from the Adobe Commerce 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 PRODUCTS_AP in TARGET_GROUP.
  10. In the PRODUCTS_AP properties, select LKM SQL to SQL (Built-In) on the Loading Knowledge Module tab.

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