VOOZH about

URL: https://www.cdata.com/kb/tech/pingone-odbc-excel-query.rst

⇱ How to Connect to & Open PingOne Data in Microsoft Excel


How to Connect to & Open PingOne Data in Microsoft Excel

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
This article uses the CData ODBC driver for PingOne to import data in Excel with Microsoft Query. This article also demonstrates how to use parameters with Microsoft Query.

The CData ODBC driver for PingOne uses the standard ODBC interface to link PingOne data with applications like Microsoft Access and Excel. Follow the steps below to use Microsoft Query to import PingOne data into a spreadsheet and provide values to a parameterized query from cells in a spreadsheet.

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.

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.

You can then work with live PingOne data in Excel.

NOTE: In recent versions of Excel, Microsoft Query is not visible by default. To enable visibility, Navigate to Options > Data and check From Microsoft Query (Legacy) under the Show legacy data import wizards section.

πŸ‘ Enabling Microsoft Query (Legacy).
  1. In Excel, open the Data tab and choose Get Data -> Legacy Wizards -> From Microsoft Query (Legacy). πŸ‘ Open Microsoft Query from the Data tab.
  2. Choose the PingOne DSN. Select the option to use Query Wizard to create/edit queries. πŸ‘ The list of available ODBC DSNs in the Choose Data Source dialog.
  3. In the Query Wizard, expand the node for the table you would like to import into your spreadsheet. Select the columns you want to import and click the arrow to add them to your query. Alternatively, select the table name to add all columns for that table. πŸ‘ Available tables and columns in the Choose Columns step of the Query Wizard. (Salesforce is shown.)
  4. The Filter Data page allows you to specify criteria. For example, you can limit results by setting a date range. πŸ‘ The Filter Data step of the Query Wizard. (Salesforce is shown.)
  5. If you want to use parameters in your query, select the option to edit the query in Microsoft Query.
  6. To set a parameter in the query, you will need to modify the SQL statement directly. To do this, click the SQL button in the Query Editor. If you set filter criteria earlier, you should have a WHERE clause already in the query.

    To use a parameter, use a "?" character as the wildcard character for a field's value in the WHERE clause. For example, if you are importing the [CData].[Administrators].Users, you can set "EmployeeType=?".

  7. Close the SQL dialog when you are finished editing the SQL statement. You will be prompted to enter a parameter value. In the next step, you will select a cell to provide this value. So, leave the box in the dialog blank. πŸ‘ The generated SQL statement. (Salesforce is shown.)
  8. Click File -> Return Data to Microsoft Excel. The Import Data dialog is displayed. Enter a cell where results should be imported. πŸ‘ The Import Data dialog.

  9. Close the Import Data dialog. You will be prompted to enter a parameter value. Click the button next to the parameter box to select a cell. Select the option to automatically refresh the spreadsheet when the value changes.
The data is now imported into Excel. When you change the value in cell B1, the data will be filtered by the specified search criteria. πŸ‘ The results of the query, with the search criteria applied. (Salesforce is shown.)

Ready to get started?

Download a free trial of the PingOne ODBC Driver to get started:

 Download Now

Learn more:

πŸ‘ PingOne Icon
PingOne ODBC Driver

The PingOne ODBC Driver is a powerful tool that allows you to connect with live data from PingOne, directly from any applications that support ODBC connectivity.

Access PingOne data like you would a database - read, write, and update PingOne 0, etc. through a standard ODBC Driver interface.