Connect to X-Cart Data from PowerBuilder

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart ODBC Driver

The X-Cart ODBC Driver is a powerful tool that allows you to connect with live data from X-Cart, directly from any applications that support ODBC connectivity.

Access X-Cart data like you would a database - read, write, and update X-Cart Orders, Products, Items, etc. through a standard ODBC Driver interface.



This article demonstrates how to use the CData ODBC Driver for X-Cart to connect to X-Cart data and execute queries in PowerBuilder.

The CData ODBC Driver for X-Cart can be used from any platform or development technology that supports ODBC, including PowerBuilder. This article shows how to connect to X-Cart data and execute queries from the Database Painter and controls such as the DataWindow.

Connect to X-Cart as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Create a Profile for the ODBC Driver for X-Cart

Follow the steps below to use the Database Painter tool to create a database profile based on an ODBC DSN (data source name) for X-Cart. In the Database Painter, you can use wizards and the UI to work with X-Cart data.

  1. In PowerBuilder, click Tools -> Database Painter.
  2. In the Objects window in the Database Painter, right-click the ODBC node and click New Profile.
  3. On the Connection tab, enter a name for the profile and select the X-Cart DSN in the Data Source menu.
  4. 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 ODBC 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 = "ODBC" SQLCA.DBParm = "ConnectString='DSN=CData XCart Source'" CONNECT USING SQLCA; dw_profiles.SetTransObject(SQLCA); dw_profiles.Retrieve();