Connect to Mocean Data from PowerBuilder via ODBC

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

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

Using API Key Authentication

Mocean uses API key authentication to control access to the API. To obtain an API Key:

1. Log in to your Mocean account at https://dashboard.moceanapi.com
2. Navigate to your account settings or API credentials section
3. Copy your API Key

After obtaining your API Key, set the following connection properties:

• AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

• APIKey: Set this to your Mocean API Key. This is transmitted as a Bearer token in the Authorization header.

Example Connection String

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

Connecting to Mocean

Once the authentication is configured, you can connect to Mocean and query data from any of the available tables such as AccountBalance, AccountPricing, MessageStatus, and NumberLookup.

Create a Profile for the ODBC Driver for Mocean

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

👁 Live data accessible from an editable grid. (Salesforce is shown.)

Using Mocean 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 Mocean 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_accountbalance.SetTransObject(SQLCA);
dw_accountbalance.Retrieve();