Connect to Clio Data in RazorSQL



Connect to Clio from wizards and query Clio data from the GUI in the RazorSQL database management tool.

The CData JDBC Driver for Clio enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Clio using wizards in RazorSQL.

Create a JDBC Data Source for Clio Data

  1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
  2. In the Connection Wizard that appears, set the following properties:
    • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
    • Driver Class: Set the driver class to cdata.jdbc.api.APIDriver.
    • Username: Enter the username. (This property can also be set in the JDBC URL.)
    • Password: Enter the password. (This property can also be set in the JDBC URL.)
    • JDBC URL: Enter connection parameters. The JDBC URL begins with jdbc:api: and is followed by a semicolon-separated list of connection properties.

      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.

      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 the following:

      jdbc:api:Profile=C:\profiles\Clio.apip;ProfileSettings='Region=your_region';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Query Clio Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.

Ready to get started?

Connect to live data from Clio with the API Driver

Connect to Clio