Connect to X-Cart Data in CloverDX (formerly CloverETL)

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.



Transfer X-Cart data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for X-Cart enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with X-Cart as sources. In this article, you will use the JDBC Driver for X-Cart to set up a simple transfer into a flat file. The CData JDBC Driver for X-Cart enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with X-Cart as sources. In this article, you will use the JDBC Driver for X-Cart to set up a simple transfer into a flat file.

Connect to X-Cart as a JDBC Data Source

  1. Create the connection to X-Cart data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.xcart.jar file.
  3. Enter the JDBC URL.

    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.

    A typical JDBC URL is below:

    jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey;

Query X-Cart Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the X-Cart JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT ProfileId, FirstName FROM PROFILES WHERE Language = 'en'

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the PROFILES table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.