Use the CData ODBC Driver for Vercel in MicroStrategy

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Vercel data in MicroStrategy Developer using the CData ODBC Driver for Vercel.

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 creating a database instance for Vercel in MicroStrategy Developer and creating a Warehouse Catalog based on 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).

Create a Vercel Database Instance in MicroStrategy Developer

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

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

Connect to Vercel Data from the Warehouse Catalog

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

Ready to get started?

Connect to live data from Vercel with the API Driver

Connect to Vercel