Connect to ShipEngine Data from PowerBuilder via ODBC

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
This article demonstrates how to use the CData ODBC Driver for ShipEngine to connect to ShipEngine data and execute queries in PowerBuilder.

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

Connect to ShipEngine 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.

Start by setting the Profile connection property to the location of the ShipEngine Profile on disk (e.g. C:\profiles\ShipEngine.apip). Next, set the ProfileSettings connection property to the connection string for ShipEngine (see below).

ShipEngine API Profile Settings

Retrieve your ShipEngine API Key from the Dashboard at app.shipengine.com under API Management.

Create a Profile for the ODBC Driver for ShipEngine

Follow the steps below to use the Database Painter tool to create a database profile based on an ODBC DSN (data source name) for ShipEngine. In the Database Painter, you can use wizards and the UI to work with ShipEngine 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 ShipEngine DSN in the Data Source menu.
  4. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using ShipEngine 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 ShipEngine data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "ODBC"
SQLCA.DBParm = "ConnectString='DSN=CData API Source'"
CONNECT USING SQLCA;
dw_batcherrors.SetTransObject(SQLCA);
dw_batcherrors.Retrieve();

Ready to get started?

Connect to live data from ShipEngine with the API Driver

Connect to ShipEngine