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 →PingOne Reporting in OBIEE with the PingOne JDBC Driver
Deploy the PingOne JDBC driver on OBIEE to provide real-time reporting across the enterprise.
The CData JDBC Driver for PingOne is a standard database driver that can integrate real-time access to PingOne data into your Java-based reporting server. This article shows how to deploy the driver to Oracle Business Intelligence Enterprise Edition (OBIEE) and create reports on PingOne data that reflect any changes.
Deploy the JDBC Driver
Follow the steps below to add the JDBC driver to WebLogic's classpath.
For WebLogic 12.2.1, simply place the driver JAR and .lic file into DOMAIN_HOME\lib; for example, ORACLE_HOME\user_projects\domains\MY_DOMAIN\lib. These files will be added to the server classpath at startup.
You can also manually add the driver to the classpath: This is required for earlier versions. Prepend the following to PRE_CLASSPATH in setDomainEnv.cmd (Windows) or setDomainEnv.sh (Unix). This script is located in the bin subfolder of the folder for that domain. For example: ORACLE_HOME\user_projects\domains\MY_DOMAIN\bin.
set PRE_CLASSPATH=your-installation-directory\lib\cdata.jdbc.pingone.jar;%PRE_CLASSPATH%
Restart all servers; for example, run the stop and start commands in DOMAIN_HOME\bitools\bin.
Create a JDBC Data Source for PingOne
After deploying the JDBC driver, you can create a JDBC data source from BI Publisher.
- Log into BI Publisher, at the URL http://localhost:9502/analytics, for example, and click Administration -> Manage BI Publisher.
- Click JDBC Connection -> Add Data Source.
- Enter the following information:
- Data Source Name: Enter the name that users will create connections to in their reports.
- Driver Type: Select Other.
- Database DriverClass: Enter the driver class, cdata.jdbc.pingone.PingOneDriver.
- Connection String: 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:
- 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.
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.
When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.
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
- Username: Enter the username.
- Password: Enter the password.
- In the Security section, select the allowed user roles.
Create Real-Time PingOne Reports
You can now create reports and analyses based on real-time PingOne data. Follow the steps below to use the standard report wizard to create an interactive report that reflects any changes to PingOne data.
- On the global header, click New -> Data Model.
- On the Diagram tab, select SQL query in the menu.
- Enter a name for the query and in the Data Source menu select the PingOne JDBC data source you created.
- Select standard SQL and enter a query like the following:
SELECT Id, Username FROM [CData].[Administrators].Users WHERE EmployeeType = 'Contractor'
- Click View Data to generate the sample data to be used as you build your report.
- Select the number of rows to include in the sample data, click View, and then click Save As Sample Data.
- Click Create Report -> Use Data Model.
- Select Guide Me and on the Select Layout page select the report objects you want to include. In this example we select Chart and Table.
- Drop a numeric column like Username onto the Drop Value Here box on the y-axis. Drop a dimension column like Id onto the Drop Label Here box on the x-axis.
- Click Refresh to pick up any changes to the PingOne data.