Manage X-Cart Data in DBArtisan as a JDBC Source

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.



Use wizards in DBArtisan to create a JDBC data source for X-Cart.

The CData JDBC Driver for X-Cart seamlessly integrates X-Cart data into database management tools like DBArtisan by enabling you to access X-Cart data as a database. This article shows how to create a JDBC source for X-Cart in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate X-Cart Data into DBArtisan Projects

Follow the steps below to register X-Cart data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic JDBC.
  3. Click Manage.
  4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
  5. In the Connection URL box, enter credentials and other required connection properties in 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.

    Below is a typical connection string:

    jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey;
  6. Finish the wizard to connect to X-Cart data. X-Cart entities are displayed in the Datasource Explorer.

You can now work with X-Cart data as you work with any other database. See the driver help documentation for more information on the queries supported by the X-Cart API.