Use the CData ODBC Driver for Typeform in MicroStrategy

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

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

Connect to Typeform as an ODBC Data Source

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

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

TypeForm API Profile Settings

Authentication to TypeForm uses the OAuth standard.

To authenticate to TypeForm, you must first register and configure an OAuth application with TypeForm here: https://admin.typeform.com/account#/section/tokens. Your app will be assigned a client ID and a client secret which can be set in the connection string. More information on setting up an OAuth application can be found at https://developer.typeform.com/get-started/.

Note that there are several different use scenarios which all require different redirect URIs:

• CData Desktop Applications: CData desktop applications (Sync, API Server, ArcESB) accept OAuth tokens at /src/oauthCallback.rst. The host and port is the same as the default port used by the application. For example, if you use http://localhost:8019/ to access CData Sync then the redirect URI will be http://localhost:8019/src/oauthCallback.rst.
• CData Cloud Applications: CData cloud applications are similar to their desktop counterparts. If you access Connect AI at https://1.2.3.4/ then you should use the redirect https://1.2.3.4/src/oauthCallback.rst.
• Desktop Application: When using a desktop application, the URI https://localhost:33333 is recommended.
• Web Application: When developing a web application using the driver, use your own URI here such as https://my-website.com/oauth.

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 your app settings.
• OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
• CallbackURL: Set this to the Redirect URI you specified in your app settings.

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 Typeform 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 Typeform
Description = My Description
Profile = C:\profiles\TypeForm.apip
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 Typeform Database Instance in MicroStrategy Developer

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

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 Typeform data from the Warehouse Catalog and Data Import.

Connect to Typeform Data from the Warehouse Catalog

Once you have created a database instance based on the ODBC Driver for Typeform, 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 Typeform 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.