We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Validate PingOne Data with QuerySurge
Access and validate PingOne data in QuerySurge using the CData JDBC Driver.
QuerySurge is a smart data testing solution that automates data validation and testing. When paired with the CData JDBC Driver for PingOne, QuerySurge can work with live PingOne data. This article walks through connecting to PingOne data from QuerySurge.
With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live PingOne data. When you issue complex SQL queries 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 client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze PingOne data using native data types.
Connecting to PingOne Data in QuerySurge
To connect to live PingOne data from QuerySurge, you need to deploy the JDBC Driver JAR file to your QuerySurge Agent(s) and add a new connection from the QuerySurge Admin view.
Deploy the JDBC Driver
- Download the CData JDBC Driver for PingOne installer, unzip the package, and run the JAR file to install the driver.
- Once the driver is installed, stop the Agent Service.
- Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for PingOne\lib\) to your Agent(s) (QuerySurge_install_dir\agent\jdbc).
- Restart the Agent Service.
For more information on deploying JDBC drivers for QuerySurge, refer to the QuerySurge Knowledge Base.
Configure a New Connection to PingOne
- Log into QuerySurge and navigate to the Admin view.
- Click Configuration -> Connections in the Administration Tree.
- Click Add to create a new connection.
- In the QuerySurge Connection Wizard, click Next.
- Name the connection (e.g. CData JDBC Connection to PingOne).
- Set the Data Source to "All Other JDBC Connections (Connection Extensibility)" and click Next.
- Set the Driver Class to cdata.jdbc.pingone.PingOneDriver and click Next.
Set the Connection URL using the necessary connection properties to authenticate with PingOne. Your Connection URL will look something like the following:
jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the PingOne JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.pingone.jar
Fill in the connection properties and copy the connection string to the clipboard.
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:
- From the home page of your PingOne organization, move to the navigation sidebar and click Environments.
- 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.
- In the environment's home page navigation sidebar, click Applications.
- Find your OAuth or Worker application details in the list.
-
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:
- The driver obtains an access token from PingOne and uses it to request data.
- 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.
- Set the Test Query to enable the Test Connection button for the Connection (e.g. SELECT * FROM [CData].[Administrators].Users LIMIT 1) and click Next.
- Click Test Connection to ensure the connection is configured properly and click Save to add the connection.
Once the connection is added, you can write SQL queries against your PingOne data in QuerySurge.
Compare PingOne Data Queries with a QueryPair
With the connection configured, you can follow the steps below to compare querying PingOne data with a QueryPair.
- Select "Design Library" from the Design Menu
- Click QueryPairs under QuerySurge Design
- Click "Create New QueryPair"
- Name the QueryPair and click Save
- In either the Source or Target panes, select the connection created above (select the same connection to query PingOne twice or another connection to perform a comparison)
- Write queries in the Editor for each pane, e.g. SELECT * FROM [CData].[Administrators].Users
- Click the "Design-Time Run" tab to execute the queries
- When the query execution is finished, click "View Query Results" to see the PingOne data returned by the query
Download a free, 30-day trial of the CData JDBC Driver for PingOne and start working with your live PingOne data in QuerySurge. Reach out to our Support Team if you have any questions.