Import Real-Time PingOne Data in ColdFusion to Build Applications



Use CData JDBC drivers to import and use PingOne data in ColdFusion.

Adobe ColdFusion is a web and mobile application development platform. It uses its own scripting language, ColdFusion Markup Language (CFML), to create data-driven websites as well as generate remote services, such as REST.

When ColdFusion is paired with the CData JDBC Driver for PingOne, you can link your ColdFusion web and mobile applications to operational PingOne data. This allows for your applications to be more robust and complete. This article details how to use the JDBC driver to create a table populated with PingOne data from within a ColdFusion markup file.

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.

Configuring the Connection to PingOne

You will need a JDBC connection string to establish a connection between Coldfusion and PingOne.

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

Adding a Data Source and Creating a Table

After configuring the connection, follow the steps below to add the CData JDBC Driver to ColdFusion's lib directory, add a new data source, test the connection, create a ColdFusion markup file, and, finally, make a real-time connection with PingOne data and display it in a table written in the ColdFusion Markup Language, or CFML:

  1. Copy the JDBC Driver for PingOne and lic file from "C:\Program Files\CData[product_name]\lib" to "C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib". cdata.jdbc.pingone.jar cdata.jdbc.pingone.lic

    Note: If you do not copy the .lic file with the jar, you will see a licensing error that indicates you do not have a valid license installed. This is true for both the trial and full versions.

  2. From the ColdFusion administrator interface, choose Data & Services.
  3. Here, we can "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion variable naming conventions. For our JDBC driver, choose "other", then click the "Add" button.
  4. Next, populate the driver properties.
    • JDBC URL will need to be in the format: jdbc:pingone:|connectionString|.
    • A typical connection string looks like this:

      jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH

    • The Driver Class is: cdata.jdbc.pingone.PingOneDriver
    • The Driver Name is arbitrary and simply used to recognize the data source in the ColdFusion administration console.
  5. Now, test the connection by clicking the check mark to the left of the CDataPingOneJDBC data source you just created. When the data source reports an "OK" status, it is ready for use.
  6. Next, create a new ColdFusion Markup file (.cfm) and place it in the wwwroot directory ("C:\ColdFusion2021\cfusion\wwwroot") for ColdFusion.

    The following code queries the data source:

                
            <cfquery name="PingOneQuery" dataSource="CDataPingOneJDBC"> 
              SELECT * FROM [CData].[Administrators].Users 
            </cfquery> 
        
    And a CFTable can be used to quickly output the table in HTML:
                
              <cftable  
              query = "PingOneQuery" 
              border = "1" 
              colHeaders 
              colSpacing = "2" 
              headerLines = "2" 
              HTMLTable 
              maxRows = "500" 
              startRow = "1"> 
    
              <cfcol header="<b>Id</b>" align="Left" width=2 text="Id"/> 
    
              <cfcol header="<b>Username</b>" align="Left" width=15 text="Username"/> 
    
              ...
    
            </cftable> 
        
    Full code, including the HTML portion is available below:
                
            <html> 
            <head><title>CData Software | PingOne [CData].[Administrators].Users Table Demo </title></head> 
            <body> 
            <cfoutput>#ucase("PingOne [CData].[Administrators].Users Table Demo")#</cfoutput> 
            <cfquery name="PingOneQuery" dataSource="CDataPingOneJDBC"> 
    
              SELECT * FROM [CData].[Administrators].Users 
    
            </cfquery> 
            <cftable  
              query = "PingOneQuery" 
              border = "1" 
              colHeaders 
              colSpacing = "2" 
              headerLines = "2" 
              HTMLTable 
              maxRows = "500" 
              startRow = "1"> 
              <cfcol header="<b>Id</b>" align="Left" width=2 text="Id"/> 
    
              <cfcol header="<b>Username</b>" align="Left" width=15 text="Username"/> 
    
              ...
    
            </cftable> 
            </body> 
    
            </html>  
        
  7. Finally, run the code locally in a browser at the default port of 8500. It produces a table populated with PingOne data!

As a note, the CData JDBC Drivers also support parameterized queries using the cfqueryparam element. For example: SELECT * FROM Account WHERE name =

Get Started Today

Download a free, 30-day trial of the CData JDBC Driver for PingOne and start building PingOne-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.

Ready to get started?

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

 Download Now

Learn more:

PingOne Icon PingOne JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with PingOne.