Connect to Superchat Data from PowerBuilder via ODBC

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

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

Superchat uses API Key authentication. The API key is passed via the X-API-KEY request header on every call.

Authentication

To authenticate to Superchat, you need to obtain your API key from the Superchat workspace settings.

Using API Key Authentication

You can obtain your API key from Settings > Integrations > API Key in your Superchat workspace.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Superchat API key.

Example connection string:

Profile=C:\profiles\Superchat.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Create a Profile for the ODBC Driver for Superchat

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

Using Superchat 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 Superchat 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_channels.SetTransObject(SQLCA);
dw_channels.Retrieve();