Process & Analyze PingOne Data in Databricks (AWS)

Databricks is a cloud-based service that provides data processing capabilities through Apache Spark. When paired with the CData JDBC Driver, customers can use Databricks to perform data engineering and data science on live PingOne data. This article explains how to host the CData JDBC Driver in AWS, as well as connect to and process live PingOne data in Databricks.

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.

Install the CData JDBC Driver in Databricks

To work with live PingOne data in Databricks, install the driver on your Databricks cluster.

1. Navigate to your Databricks administration screen and select the target cluster.
2. On the Libraries tab, click "Install New."
3. Select "Upload" as the Library Source and "Jar" as the Library Type.
4. Upload the JDBC JAR file (cdata.jdbc.pingone.jar) from the installation location (typically C:\Program Files\CData[product_name]\lib).

👁 Loading the JDBC JAR File into AWS

Access PingOne Data in your Notebook: Python

With the JAR file installed, we are ready to work with live PingOne data in Databricks. Start by creating a new notebook in your workspace. Name the notebook, select Python as the language (though Scala is available as well), and choose the cluster where you installed the JDBC driver. When the notebook launches, we can configure the connection, query PingOne, and create a basic report.

Configure the Connection to PingOne

Connect to PingOne by referencing the JDBC Driver class and constructing a connection string to use in the JDBC URL. Additionally, you will need to set the property in the JDBC URL (unless you are using a Beta driver). You can view the licensing file included in the installation for information on how to set this property.

Step 1: Connection Information

driver = "cdata.jdbc.pingone.PingOneDriver"
url = "jdbc:pingone:RTK=5246...;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:

• : 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.

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Load PingOne Data

Once you configure the connection, you can load PingOne data as a dataframe using the CData JDBC Driver and the connection information.

Step 2: Reading the data

remote_table = spark.read.format ( "jdbc" ) \
	.option ( "driver" , driver) \
	.option ( "url" , url) \
	.option ( "dbtable" , "[CData].[Administrators].Users") \
	.load ()

Display PingOne Data

Check the loaded PingOne data by calling the display function.

Step 3: Checking the result

display (remote_table.select ("Id"))

👁 Displaying PingOne Data

Analyze PingOne Data in Databricks

If you want to process data with Databricks SparkSQL, register the loaded data as a Temp View.

Step 4: Create a view or table

remote_table.createOrReplaceTempView ( "SAMPLE_VIEW" )

With the Temp View created, you can use SparkSQL to retrieve the PingOne data for reporting, visualization, and analysis.

% sql

SELECT Id, Username FROM SAMPLE_VIEW ORDER BY Username DESC LIMIT 5

👁 Displaying PingOne Data

The data from PingOne is only available in the target notebook. If you want to use it with other users, save it as a table.

remote_table.write.format ( "parquet" ) .saveAsTable ( "SAMPLE_TABLE" )

Download a free, 30-day trial of the CData JDBC Driver for PingOne and start working with your live PingOne data in Databricks. Reach out to our Support Team if you have any questions.