Build a Simple VCL Application for Clio Data

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for Clio, you gain access to live Clio data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to retrieve Clio data. This article will walk through connecting to Clio and creating a simple VCL application with the Form Designer.

Create a Connection to Clio Data

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 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.

You can then follow the steps below to use the Data Explorer to create a FireDAC connection to Clio data.

1. In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
2. Right-click the ODBC Data Source node in the Data Explorer.
3. Click Add New Connection.
4. Enter a name for the connection.
5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Clio.

Create VCL Applications with Connectivity to Clio Data

Follow the procedure below to start executing queries to Clio data from a simple VCL application that displays the results of a query in a grid.

1. Drop a TFDConnection component onto the form and set the following properties:

   • ConnectionDefName: Select the FireDAC connection to Clio data.
   • Connected: Select True from the menu and, in the dialog that appears, enter your credentials.

2. Drop a TFDQuery component onto the form and set the properties below:

   • Connection: Set this property to the TFDConnection component, if this component is not already specified.

   • SQL: Click the button in the SQL property and enter a query. For example:

     SELECT Id, Total FROM Bills WHERE State = 'awaiting_payment'
     

   • Active: Set this property to true.

3. Drop a TDataSource component onto the form and set the following property:

   • DataSet: In the menu for this property, select the name of the TFDQuery component.

4. Drop a TDBGrid control onto the form and set the following property:

   • DataSource: Select the name of the TDataSource.
5. Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.

You now have an executable application that displays the results of the SQL Query set in the TFDQuery object.

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

• DataBind Controls to Clio Data in C++Builder
• DataBind Controls to Clio Data in Delphi
• Viewing Clio Data in RAD Studio Data Explorer