Learn more
 

Ready to get started?

Connect to live data from Clio with the API Driver

Connect to Clio

In this article

Related articles

Connect to Clio Data from PowerBuilder


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

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

Connect to Clio 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 Clio Profile on disk (e.g. C:\profiles\Clio.apip). Next, set the ProfileSettings connection property to the connection string for Clio (see below).

Clio API Profile Settings

Clio uses OAuth-based authentication.

First, register an OAuth application with Clio. You can do so by logging to your Developer Account and clicking the Add button. Enter details and select the scope of your application here - these details will be shown to Clio users when they're asked to authorize your application. Your Oauth application will be assigned a client id (key) and a client secret (secret). Additionally you will need to set the Region in ProfileSettings connection property.

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

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientId: Set this to the client_id that is specified in you app settings.
  • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
  • CallbackURL: Set this to the Redirect URI that is specified in your app settings.
  • Region: Set this in ProfileSettings to your Clio geographic region. Defaults to app.clio.com.

Create a Profile for the ODBC Driver for Clio

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

Using Clio 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 Clio 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_bills.SetTransObject(SQLCA); dw_bills.Retrieve();