Connect to PingOne in SpagoBI

The CData JDBC Driver for PingOne enables you to connect to live PingOne data from business intelligence and data mining tools that support the JDBC standard. This article shows how to integrate PingOne data into a report in SpagoBI Studio and host it on SpagoBI Server.

• Deploy the Driver in SpagoBI Server
• Create a Report in SpagoBI Studio
• Host PingOne Reports on SpagoBI Server

Deploy the JDBC Driver in SpagoBI Server

Follow the steps to create a JDBC data source for PingOne in SpagoBI Server.

1. Copy the driver JAR into %CATALINA_BASE%/lib. These files are located in the lib subfolder of the installation directory.

2. Add a PingOne driver resource to the context. The following resource definition can be added to the GlobalNamingResources element in server.xml:

   <Resource name="jdbc/pingone" auth="Container" type="javax.sql.DataSource" driverclassname="cdata.jdbc.pingone.PingOneDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" maxactive="20" maxidle="10" maxwait="-1"/>

3. Add the following resource link to give access to Web applications. For this article, add the following line to META-INF\context.xml for SpagoBI.

   <ResourceLink global="jdbc/pingone" name="jdbc/pingone" type="javax.sql.DataSource"/>
   

4. Restart the server.

After adding the driver to the resources for the SpagoBI server, add the data source: In SpagoBI, click Resources -> Data Source -> Add and enter the following information:

• Label: Enter a unique identifier for the driver.
• Description: Enter a description for the driver.
• Dialect: Select Default Dialect.
• Read Only: Select the read-only option. This option determines whether the data source is the default database to save datasets created by the end user.
• Type: Select JDBC.
• URL: Enter the JDBC URL using the required connection string properties:

  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.

  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.

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

  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;
  

• Driver: Enter the class name for the driver: cdata.jdbc.pingone.PingOneDriver

👁 The configuration for the PingOne JDBC data source. (Salesforce is shown.)

Create Reports in SpagoBI Studio

Follow the steps below to populate reports based on PingOne data in SpagoBI Studio. You will create a dataset that populates a chart with the results of an SQL query. In the next section, you will host this report on SpagoBI Server.

First, you will need to connect to PingOne data from a report in SpagoBI Studio:

1. In SpagoBI Studio, click File -> New -> Project and select Report Project in the Business Intelligence and Reporting Tools folder.
2. Click File -> New -> Report and select Blank Report.
3. In the Data Explorer view, right-click Data Sources and click New Data Source.
4. Select JDBC Data Source and enter a name for the data source.
5. Click Manage Drivers and click Add to add the driver JAR, cdata.jdbc.pingone.jar. The driver JAR is located in the lib subfolder of the installation directory.
6. In the Driver Class menu, select the driver class, cdata.jdbc.pingone.PingOneDriver.
7. In the Database URL box, enter the JDBC URL. 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;
   

   See the "Getting Started" chapter of the driver help for a guide to obtaining the required connection properties. 👁 The JDBC data source. (Salesforce is shown.)
   

After you have connected to PingOne data, create a dataset that contains the results of an SQL query:

1. Right-click the DataSet folder and click New Data Set. Select the JDBC data source for PingOne and enter a name for the dataset.
2. Build the SQL query. In this example, this query will be used to add a chart to the dashboard. For example:

   SELECT Id, Username FROM [CData].[Administrators].Users WHERE EmployeeType = 'Contractor'
   

   👁 The query to be used to populate a chart. (Salesforce is shown.)
   

You can use the dataset to populate report objects. Follow the steps below to create a chart.

1. In the Palette view, drag a chart onto the canvas.
2. In the Select Chart Type tab, select a bar chart.
3. In the Select Data tab, click the Use Data From option and select the PingOne data set from the menu.
4. Drag Id from the table to the series for the x-axis.
5. Drag Username from the table to the series for the y-axis. 👁 Columns in the dataset defined as the x- and y-axes for the chart. (Salesforce is shown.)
   

Host PingOne Reports on SpagoBI Server

Follow the steps below to host documents based on live PingOne data on SpagoBI Server. You will use the report you created in the previous section as a template. To enable report users to access the live data, create placeholder parameters to be replaced by the PingOne JDBC data source on the server:

1. If you have not already done so, open the Report Design perspective in SpagoBI Studio.
2. In the Data Explorer view, right-click the Report Parameters folder and click New Parameter. Add the url parameter and assign an empty value to it. This parameter is a placeholder for the JDBC data source on the SpagoBI Server.
3. Right-click the PingOne data source and click Edit.

4. In the Property Binding node, set the JDBC Driver URL binding property to the url parameter: Click the box for the property. In the Category section, select Report Parameters. Select All in the Subcategory section and double-click the parameter.

   You can also enter the following in the JavaScript syntax:

   params["url"].value
   

   👁 Placeholder values in the report for the JDBC data source on the server.
   

Next, create a new document for the report on SpagoBI Server.

1. In SpagoBI Server, click Documents Development -> Create Document -> Generic Document. The Document Details page is displayed.
2. To create the document, enter the following:
   • Label: Enter a unique identifier for the document.
   • Name: Enter a user-friendly name for the document.
   • Type: Select Report from the menu.
   • Engine: Select BIRT Report Engine.
   • Data Source: Select the PingOne Data Source you created in Create a JDBC Data Source for PingOne in SpagoBI Server.
3. In the Show Document Templates section, select the folder where you want the document to be stored.

4. In the Template section, click Choose File. Navigate to the folder containing your report project. Select the .rptdesign file.

   Note: You can find the path to the project in the project properties.

5. Click the Save button.

👁 The document using the report as a template. (Salesforce is shown.)

When you run the report on the server, the placeholder url parameter is replaced with the JDBC URL defined on the server.

👁 The chart running on the SpagoBI Server. (Salesforce is shown.)