Use the CData ODBC Driver for Vercel in MicroStrategy Web

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

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

Connect to Vercel as an ODBC Data Source

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

Using API Key Authentication

Vercel uses Bearer token authentication. You can use either a personal access token or an OAuth access token as the API key.

To obtain a personal access token:

1. Log into your Vercel account at https://vercel.com/
2. Navigate to Account Settings > Tokens.
3. Click Create Token, enter a name and expiration, and click Create.
4. Copy the generated token (it will only be shown once).

After obtaining your token, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Vercel personal access token or OAuth access token.

Example Connection String

Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;

Working with Teams

Many Vercel resources are scoped to a team. To scope all requests to a specific team, set the TeamId connection property to your team's ID. You can find your team ID by querying the Teams table or from the Vercel dashboard. Alternatively, you can specify TeamId in your SQL queries using the WHERE clause where supported.

Connecting to Vercel

Once the authentication is configured, you can connect to Vercel and query data from any of the available tables such as Projects, Deployments, Teams, and Domains.

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 Vercel 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 Vercel
Description = My Description
Profile = C:\profiles\Vercel.apip
AuthScheme = APIKey
APIKey = your_access_token

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

Connect to and Visualize Vercel Data using MicroStrategy Web

Once you have created a database instance in MicroStrategy Developer and connected it to a project, you can perform a data import of Vercel data from MicroStrategy Web. Alternatively, you can create a new data source based on the ODBC Driver.^*

1. Open MicroStrategy Web and select your project.
2. Click Add External Data, select Databases, and choose Select a Table as the Import Option.
3. In the Import from Tables wizard, click to add a new data source.
   • Select DSN Data Sources
   • Set the DSN property to the previously configured DSN (CData API Sys)
   • Set the Version property to Generic DBMS
   • Set the User and Password properties (or use filler values)
   • Set the Data Source Name
   
4. After creating the data source, click to edit the catalog options and set the following queries and click OK.
   • SQL statement to retrieve tables available in the data source

     SELECT
       CatalogName NAME_SPACE,
       TableName TAB_NAME
     FROM
       SYS_TABLES
         

   • SQL statement to retrieve columns for the selected tables

     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
         

5. Drag a table into the pane. Note: Since we create a live connection, we can import whole tables and utilize the filtering and aggregation features native to the MicroStrategy products.
6. Click Finish, choose to the option to connect live, save the query, and choose the option to create a new dossier.
7. Choose a visualization, choose fields to display, and apply any filters to create a new visualization of Vercel data. Data types are discovered automatically through dynamic metadata discovery. Where possible, the complex queries generated by the filters and aggregations will be pushed down to Vercel, 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.
8. Once you have finished configuring the dossier, click File -> Save.

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

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