Use the CData ODBC Driver for Klipfolio in MicroStrategy

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy with the CData ODBC Driver for Klipfolio, you gain database-like access to live Klipfolio data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through creating a database instance for Klipfolio in MicroStrategy Developer and creating a Warehouse Catalog based on Klipfolio data.

The CData ODBC driver offers unmatched performance for interacting with live Klipfolio data in MicroStrategy due to optimized data processing built into the driver. When you issue complex SQL queries from MicroStrategy to Klipfolio, the driver pushes supported SQL operations, like filters and aggregations, directly to Klipfolio 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 Klipfolio data using native MicroStrategy data types.

Connect to Klipfolio as an ODBC Data Source

Information for connecting to Klipfolio follows, along with different instructions for configuring a DSN in Windows and Linux environments (the ODBC Driver for Klipfolio must be installed on the machine hosting the connected MicroStrategy Intelligence Server).

Start by setting the Profile connection property to the location of the Klipfolio Profile on disk (e.g. C:\profiles\Klipfolio.apip). Next, set the ProfileSettings connection property to the connection string for Klipfolio (see below).

Klipfolio API Profile Settings

In order to authenticate to Klipfolio, you'll need to provide your API Key. You can generate an API key from the Klipfolio Dashboard app through either the My Profile page or from Users if you are an administrator (you must have the user.manage permission). Set the API Key in the ProfileSettings property to connect.

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 Klipfolio 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 Klipfolio
Description = My Description
Profile = C:\profiles\Klipfolio.apip
ProfileSettings = 'APIKey = your_api_key'

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

Create a Klipfolio Database Instance in MicroStrategy Developer

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

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. 👁 Create a new database login.
   
5. Select the DSN that you configured earlier as the ODBC data source (i.e., CData API Sys). 👁 Choosing the DSN for the database connection.
   
6. Select the newly created database connection.
👁 The configured database instance.

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. 👁 Adding the new database instance to the project.
   
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 Klipfolio data from the Warehouse Catalog and Data Import.

Connect to Klipfolio Data from the Warehouse Catalog

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

1. Select your project and click Schema -> Warehouse Catalog. 👁 Creating the 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
      

   👁 Custom metadata queries.
   
3. Select tables to be used in the project. 👁 Selecting tables to be used in the project.
   

If you are interested in connecting to Klipfolio 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.