Build Dashboards with PingOne Data in DBxtra

The CData ODBC driver for PingOne enables access to live data from PingOne under the ODBC standard, allowing you work with PingOne data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to connect to PingOne data as a generic ODBC Data Provider and create charts, reports, and dashboards based on PingOne data in DBxtra.

Connect to PingOne Data

1. If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.
   
   

   To connect to PingOne, configure these properties:

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

   Configuring 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 to the value of the Environment ID field.

   Configuring 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 to OAuth.

   Desktop Applications

   Get and Refresh the OAuth Access Token

   After setting the following, you are ready to connect:

   • : GETANDREFRESH. To avoid the need to repeat the OAuth exchange and manually setting the each time you connect, use .
   • : The Client ID you obtained when you created your custom OAuth application.
   • : The Client Secret you obtained when you created your custom OAuth application.
   • : 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 , 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.

2. Open the DBxtra application and in the New menu click Project and name the Project. 👁 Creating a New Project.
   
3. Select ODBC Connection as the Data Connection Type. 👁 Creating an ODBC Connection.
   
4. Click the browse option () for the Data Source.
5. In the Data Link Properties window, select Microsoft OLE DB Provider for ODBC Drivers on the Provider tab. 👁 Select the Provider
   
6. On the Connection tab, select the Data Source Name and the initial catalog to use (CData). 👁 Select the Provider
   
7. Name the Connection and select the appropriate User Groups. 👁 Connection name and User Groups
   
8. Double-click the Connection from within the Project to connect to the data. 👁 Connecting to the data.
   

Create a Dashboard with PingOne Data

You are now ready to create a dashboard with PingOne data.

1. Right-click Report Objects under the Project and select New Report Object. 👁 Creating a Report Object for the Project
   
2. In the new Report Object, click the link to create the Query.
3. In the Select Data Connection window, select the newly created data connection. 👁 Select Data Connection
   
4. On the Query tab, expand the connection objects and select the Tables, Views, and specific columns you wish to include in your dashboard. You can specify search requirements and even create complex queries which include JOINs and aggregations. 👁 Selecting the data/building the query.
   
5. On the Dashboard tab, select the visualizations and features for your dashboard. Assign the data values from the query to the appropriate fields for the Dashboards items (Values, Series, etc.) 👁 Building the Dashboard.
   

With a new Dashboard created, you are ready to begin analysis of PingOne data. Thanks to the ODBC Driver for PingOne, you can refresh the Dashboard and immediately see any changes made at the source. In the same way, you can create and view Reports with live, up-to-date PingOne data.