Ready to get started?

Connect to live data from Clio with the API Driver

Connect to Clio

Connect to Clio Data in CloverDX (formerly CloverETL)



Transfer Clio data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Clio enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Clio as sources. In this article, you will use the JDBC Driver for Clio to set up a simple transfer into a flat file. The CData JDBC Driver for Clio enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Clio as sources. In this article, you will use the JDBC Driver for Clio to set up a simple transfer into a flat file.

Connect to Clio as a JDBC Data Source

  1. Create the connection to Clio data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.api.jar file.
  3. Enter the JDBC URL.

    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 below:

    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 with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Clio JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Id, Total FROM Bills WHERE State = 'awaiting_payment'

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Bills table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.