DataBind Controls to Clio Data in C++Builder



DataBind to Clio data in C++Builder with standard components and controls.

The CData ODBC driver for Clio makes it easy to integrate connectivity to live Clio data with standard data access components in C++Builder. This article shows how to create a simple visual component library (VCL) application in C++Builder that connects to Clio data, executes queries, and displays the results in a grid. An additional section shows how to use FireDAC components to execute commands from code.

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

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

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

Execute Commands to Clio with FireDAC Components

You can use the TFDConnection and TFQuery components to execute queries to Clio data. This section provides Clio-specific examples of executing queries with the TFQuery component.

Connect to Clio Data

To connect to the data source, set the Connected property of the TFDConnection component to true. You can set the same properties from code:

FDConnection1->ConnectionDefName = "CData Clio ODBC Source"; FDConnection1->Connected = true;

To connect the TFDQuery component to Clio data, set the Connection property of the component. When a TFDQuery component is added at design time, its Connection property is automatically set to point to a TFDConnection on the form, as in the application above.

Create Parameterized Queries

To create a parameterized query, use the following syntax below:

FDQuery1->SQL->Text = "select * from Bills where state = :State"; FDQuery1->ParamByName("state")->AsString = "awaiting_payment"; FDQuery1->Open();

The example above binds a string-type input parameter by name and then opens the dataset that results.

Prepare the Statement

Preparing statements is costly in system resources and time. The connection must be active and open while a statement is prepared. By default, FireDAC prepares the query to avoid recompiling the same query over and over. To disable statement preparation, set ResourceOptions.DirectExecute to True; for example, when you need to execute a query only once.

Execute a Query

To execute a query that returns a result set, such as a select query, use the Open method. The Open method executes the query, returns the result set, and opens it. The Open method will return an error if the query does not produce a result set.

FDQuery1->SQL->Text = "select * from Bills where state = :State"; FDQuery1->ParamByName("state")->AsString = "awaiting_payment"; FDQuery1->Open();

Related Articles

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

Ready to get started?

Connect to live data from Clio with the API Driver

Connect to Clio