Use the CData ODBC Driver for PingOne in MicroStrategy

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

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

Connect to PingOne as an ODBC Data Source

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

To connect to PingOne, configure these properties:

• Region: The region where the data for your PingOne organization is being hosted.
• AuthScheme: The type of authentication to use when connecting to PingOne.
• Either WorkerAppEnvironmentId (required when using the default PingOne domain) or AuthorizationServerURL, configured as described below.

Configuring WorkerAppEnvironmentId

WorkerAppEnvironmentId is the ID of the PingOne environment in which your Worker application resides. This parameter is used only when the environment is using the default PingOne domain (auth.pingone). It is configured after you have created the custom OAuth application you will use to authenticate to PingOne, as described in Creating a Custom OAuth Application in the Help documentation.

First, find the value for this property:

1. From the home page of your PingOne organization, move to the navigation sidebar and click Environments.
2. Find the environment in which you have created your custom OAuth/Worker application (usually Administrators), and click Manage Environment. The environment's home page displays.
3. In the environment's home page navigation sidebar, click Applications.
4. Find your OAuth or Worker application details in the list.
5. Copy the value in the Environment ID field. It should look similar to:
   

   WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'

Now set WorkerAppEnvironmentId to the value of the Environment ID field.

Configuring AuthorizationServerURL

AuthorizationServerURL is the base URL of the PingOne authorization server for the environment where your application is located. This property is only used when you have set up a custom domain for the environment, as described in the PingOne platform API documentation. See Custom Domains.

Authenticating to PingOne with OAuth

PingOne supports both OAuth and OAuthClient authentication. In addition to performing the configuration steps described above, there are two more steps to complete to support OAuth or OAuthCliet authentication:

• Create and configure a custom OAuth application, as described in Creating a Custom OAuth Application in the Help documentation.
• To ensure that the driver can access the entities in Data Model, confirm that you have configured the correct roles for the admin user/worker application you will be using, as described in Administrator Roles in the Help documentation.
• Set the appropriate properties for the authscheme and authflow of your choice, as described in the following subsections.

OAuth (Authorization Code grant)

Set AuthScheme to OAuth.

Desktop Applications

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• InitiateOAuth: GETANDREFRESH. To avoid the need to repeat the OAuth exchange and manually setting the OAuthAccessToken each time you connect, use InitiateOAuth.
• OAuthClientId: The Client ID you obtained when you created your custom OAuth application.
• OAuthClientSecret: The Client Secret you obtained when you created your custom OAuth application.
• CallbackURL: The redirect URI you defined when you registered your custom OAuth application. For example: https://localhost:3333

When you connect, the driver opens PingOne's OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:

1. The driver obtains an access token from PingOne and uses it to request data.
2. The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The driver refreshes the access token automatically when it expires.

For other OAuth methods, including Web Applications, Headless Machines, or Client Credentials Grant, refer to the Help documentation.

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 PingOne 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 PingOne Sys]
Driver = CData ODBC Driver for PingOne
Description = My Description
AuthScheme = OAuth
WorkerAppEnvironmentId = eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e
Region = NA
OAuthClientId = client_id
OAuthClientSecret = client_secret

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

Create a PingOne Database Instance in MicroStrategy Developer

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

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

Connect to PingOne Data from the Warehouse Catalog

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