Connect to X-Cart Data from PowerBuilder

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 demonstrates how to access X-Cart data from PowerBuilder using the X-Cart JDBC Driver.

The CData JDBC Driver for X-Cart is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for X-Cart in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for X-Cart to retrieve data.

Connect to X-Cart Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for X-Cart. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

  1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

    Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

  2. Click Tools -> Database Painter.
  3. Right-click the JDBC node and click New Profile.
  4. In the Database Profile Setup dialog, enter the following:
    • Profile Name: Enter a user-friendly name for the profile.
    • Driver Name: Enter the class name of the driver, cdata.jdbc.xcart.XCartDriver
    • URL: 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;
  5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using X-Cart Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve X-Cart data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "JDBC" SQLCA.AutoCommit = False SQLCA.DBParm = "Driver='cdata.jdbc.xcart.XCartDriver',URL='jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey;"; CONNECT USING SQLCA; dw_profiles.SetTransObject(SQLCA); dw_profiles.Retrieve();