Ready to get started?

Connect to live data from Clio with the API Driver

Connect to Clio

Use the CData ODBC Driver for Clio in MicroStrategy



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

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy 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 creating a database instance for Clio in MicroStrategy Developer and creating a Warehouse Catalog based on 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 (the ODBC Driver for Clio must be installed on the machine hosting the connected MicroStrategy Intelligence Server).

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).

Create a Clio Database Instance in MicroStrategy Developer

You can connect to Clio in MicroStrategy Developer by adding a database instance based on the CData ODBC Driver for Clio.*

  1. Open MicroStrategy Developer and select a Project Source.
  2. Navigate to Administration -> Configuration Managers -> Database Instances and right-click to add a new instance.
  3. Name the instance, select Generic DBMS as the database connection type, and create a new database connection.
  4. In the database connection wizard, name the connection and create a new Database Login name, using filler values for the user and password.
  5. Select the DSN that you configured earlier as the ODBC data source (i.e., CData API Sys).
  6. Select the newly created database connection.
  7. In the Project Source, right-click the project and open the Project configuration.
  8. Navigate to Database Instances and select the newly created database instance.
  9. Close MicroStrategy Developer and restart the connected MicroStrategy Intelligence Server to complete the database instance creation.

With the database instance configured, you will now be able to connect to Clio data from the Warehouse Catalog and Data Import.

Connect to Clio Data from the Warehouse Catalog

Once you have created a database instance based on the ODBC Driver for Clio, you can connect to data from the Warehouse Catalog.

  1. Select your project and click Schema -> Warehouse Catalog.
  2. In the Read Settings for the Catalog, click Settings and set the queries to retrieve the schema:
    • To retrieve the list of tables, use the following query:
      SELECT 
        CatalogName NAME_SPACE,
        TableName TAB_NAME 
      FROM 
        SYS_TABLES
              
    • To retrieve the list of columns for selected tables, use the following query:
      SELECT DISTINCT 
        CatalogName NAME_SPACE, 
        TableName TAB_NAME, 
        ColumnName COL_NAME, 
        DataTypeName DATA_TYPE, 
        Length DATA_LEN, 
        NumericPrecision DATA_PREC, 
        NumericScale DATA_SCALE 
      FROM 
        SYS_TABLECOLUMNS 
      WHERE 
        TableName IN (#TABLE_LIST#) 
      ORDER BY
        1,2,3
              
  3. Select tables to be used in the project.

If you are interested in connecting to Clio from other MicroStrategy products, you can read about connecting from MicroStrategy Web and connecting from MicroStrategy Desktop.


Note: connecting using a ODBC driver requires a 3- or 4-tier architecture.