Query Clio Data in MySQL Workbench

MySQL Workbench allows users to administer MySQL environments and gain better visibility into databases. When paired with CData Connect (on-premise or Connect Server), you get live access to Clio data as if it were a MySQL database. This article shows how to create a virtual database for Clio in Connect and work with live Clio data in MySQL Workbench.

Create a Virtual MySQL Database for Clio Data

CData Connect uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Login to Connect and click Connections.
2. Select "Clio" from Available Data Sources.
3. Enter the necessary authentication properties to connect to Clio.

   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.
4. Click Save Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Clio from MySQL Workbench.

Query Clio from MySQL Workbench

The steps below outline connecting to the virtual Clio database in Connect from MySQL Workbench and issuing basic queries to work with live Clio data.

Connect to Clio through Connect

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData Connect).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

Query Clio Data

1. Open the connection you just created (CData Connect).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Clio data, like SELECT * FROM cliodb.Bills;

With access to live Clio data from MySQL Workbench, you can easily query and update Clio, just like you would a MySQL database. Request a demo of the CData Connect and start working with Clio just like a MySQL database today.