Ready to get started?

Connect to live data from Clio with the API Driver

Connect to Clio

Query Clio Data in ColdFusion

Write standard ColdFusion data access code to connect to Clio data.

The CData JDBC Driver for Clio seamlessly integrates connectivity to Clio data with the rapid development tools in ColdFusion. This article shows how to connect to Clio data in ColdFusion and query Clio tables.

Create a JDBC Data Source for Clio in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

  1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

    The JAR and license for the driver are located in the lib subfolder of the installation directory.

    Restart the server after this step.

  2. Add the driver as a data source:

    From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

  3. Populate the driver properties:

    • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:api: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

      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

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Clio JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.api.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      A typical JDBC URL is below:

    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.api.APIDriver.
    • Driver Name: Enter a user-defined name for the driver.
    • Username: Enter the username used to authenticate.
    • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Clio data source in the Actions column. After reporting a status of OK, the Clio data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Clio. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

<cfquery name="APIQuery" dataSource="CDataAPI"> SELECT * FROM Bills WHERE State = <cfqueryparam value="#State#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#APIQuery#">

Below is the equivalent in CFScript:

result = queryExecute(
  "SELECT * FROM Bills WHERE State = ?", 
    { value="awaiting_payment", cfsqltype="cf_sql_varchar" }
  { datasource="CDataAPI" }

writeDump( var= result );

You can then make requests to your .cfm like the following: