Connect to PingOne Data from PowerBuilder via JDBC

The CData JDBC driver for PingOne is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for PingOne in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for PingOne to retrieve data.

Connect to PingOne Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for PingOne. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

   Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

2. Click Tools -> Database Painter.
3. Right-click the JDBC node and click New Profile.
4. In the Database Profile Setup dialog, enter the following:
   • Profile Name: Enter a user-friendly name for the profile.
   • Driver Name: Enter the class name of the driver, cdata.jdbc.pingone.PingOneDriver
   • URL: Enter the JDBC URL.

     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.

     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. A typical JDBC URL is below:

     jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH
   
5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using PingOne Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve PingOne data into a DataWindow. You can add the following code to the open method: