Learn more
 

Ready to get started?

Connect to live data from Clio with the API Driver

Connect to Clio

In this article

Related articles

Use the CData ODBC Driver for Clio in MicroStrategy Desktop


Connect to Clio data in MicroStrategy Desktop using the CData ODBC Driver for Clio.

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When paired with the CData ODBC Driver for Clio, you gain database-like access to live Clio data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through adding Clio as a data source in MicroStrategy Desktop and creating a simple visualization of Clio data.

The CData ODBC Driver offers unmatched performance for interacting with live Clio data in MicroStrategy due to optimized data processing built into the driver. When you issue complex SQL queries from MicroStrategy to Clio, the driver pushes supported SQL operations, like filters and aggregations, directly to Clio and utilizes the embedded SQL Engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can visualize and analyze Clio data using native MicroStrategy data types.

Connect to Clio as an ODBC Data Source

Information for connecting to Clio follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Windows

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.

Linux

If you are installing the CData ODBC Driver for Clio in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData API Sys] Driver = CData ODBC Driver for Clio Description = My Description Profile = C:\profiles\Clio.apip ProfileSettings = 'Region = your_region' Authscheme = OAuth OAuthClientId = your_client_id OAuthClientSecret = your_client_secret CallbackUrl = your_callback_url

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Connect to and Visualize Clio Data using MicroStrategy Desktop

In addition to connecting Clio in MicroStrategy enterprise products, you can connect to Clio in MicroStrategy Desktop. Follow the steps below to add Clio data as a dataset and create visualizations and reports of Clio data.

  1. Open MicroStrategy Desktop and create a new dossier.
  2. In the datasets panel, click New Data, select Databases, and select Type a Query as the Import Option.
  3. Add a new data source and choose DSN data sources.
  4. Choose the DSN you previously configured (likely CData API Sys) and select Generic DBMS in the Version menu.
  5. Set the User and Password properties for the DSN (or use placeholder values) and name the data source.
  6. Select the new database instance to view the tables. You may need to manually click the search icon in the Available Tables section to see the tables.
  7. Create a SQL query for the Clio data (see below) and click Execute SQL to test the query. SELECT * FROM Bills NOTE: Since we create a live connection, we can execute a SELECT * query and utilize the filtering and aggregation features native to the MicroStrategy products.
  8. Click Finish and choose to connect live.
  9. Choose a visualization, choose fields to display (data types are discovered automatically through dynamic metadata discovery) and apply any filters to create a new visualization of Clio data. Where possible, the complex queries generated by the filters and aggregations will be pushed down to Clio, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed client-side by the CData SQL Engine embedded in the driver.
  10. Once you are finished configuring the dossier, click File -> Save.

Using the CData ODBC Driver for Clio in MicroStrategy Desktop, you can easily create robust visualizations and reports on Clio data. Read our other articles on connecting to Clio in MicroStrategy and connecting to Clio in MicroStrategy Web for more examples.