Connect to X-Cart Data in HULFT Integrate

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.



Connect to X-Cart as a JDBC data source in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData JDBC Driver for X-Cart, HULFT Integrate can work with live X-Cart data. This article walks through connecting to X-Cart and moving the data into a CSV file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live X-Cart data. When you issue complex SQL queries to X-Cart, the driver pushes supported SQL operations, like filters and aggregations, directly to X-Cart and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze X-Cart data using native data types.

Enable Access to X-Cart

To enable access to X-Cart data from HULFT Integrate projects:

  1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.xcart.jar (and cdata.jdbc.xcart.lic), to the jdbc_adapter subfolder for the Integrate Server
  2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to X-Cart Data

Once you copy the JAR files, you can create a project with access to X-Cart data. Start by opening Integrate Studio and creating a new project.

  1. Name the project
  2. Ensure the "Create script" checkbox is checked
  3. Click Next
  4. Name the script (e.g.: XCarttoCSV)

Once you create the project, add components to the script to copy X-Cart data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

  1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for X-Cart. Set the following properties:
    • Name: X-Cart Connection Settings
    • Driver class name: cdata.jdbc.xcart.XCartDriver
    • URL: jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey;

      Built-in Connection String Designer

      For assistance 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.

      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.
  2. Write your SQL statement. For example:
    SELECT ProfileId, FirstName FROM PROFILES
  3. Click "Extraction test" to ensure the connection and query are configured properly
  4. Click "Execute SQL statement and set output schema"
  5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

  1. Set a file to write the query results to (e.g. PROFILES.csv)
  2. Set "Input data" to the "Select SQL" component
  3. Add columns for each field selected in the SQL query
  4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
  5. Click "Finish"

Map X-Cart Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move X-Cart data into a CSV file.

Download a free, 30-day trial of the CData JDBC Driver for X-Cart and start working with your live X-Cart data in HULFT Integrate. Reach out to our Support Team if you have any questions.