ETL X-Cart in Oracle Data Integrator

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with X-Cart.



This article shows how to transfer X-Cart data into a data warehouse using Oracle Data Integrator.

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

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

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

      An API Key must be created for your XCart Installation. In order to obtain the API Key, you need to install and configure the REST API Module for your X-Cart installation.

      • Login to your X-Cart Installation. Click on My addons on the bottom of the left side-bar navigation panel.
      • Search for REST API Module. Install the Module.
      • After the module has been installed, you need to set it up.
        • Go to the Settings section for the REST API Module.
        • On the settings page specify the API Key (only read)
      • Set the ApiKey and Url to the connection property to connect to data.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.xcart.jar

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

      Below is a typical connection string:

      jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey;
  4. On the Physical Schema screen, enter the following information:
    • Schema (Schema): Enter XCart.
    • Schema (Work Schema): Enter XCart.
  5. In the opened model click Reverse Engineer to retrieve the metadata for X-Cart tables.

Edit and Save X-Cart Data

After reverse engineering you can now work with X-Cart data in ODI. To view X-Cart 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 X-Cart. You will load PROFILES 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 PROFILES table in X-Cart: CREATE TABLE ODI_DEMO.TRG_PROFILES (FIRSTNAME NUMBER(20,0),ProfileId 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_PROFILES 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_PROFILES table from the Sales Administration model onto the mapping.
  7. Drag the PROFILES table from the X-Cart 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 PROFILES_AP in TARGET_GROUP.
  10. In the PROFILES_AP properties, select LKM SQL to SQL (Built-In) on the Loading Knowledge Module tab.

You can then run the mapping to load X-Cart data into Oracle.