Add PingOne Data to Informatica Enterprise Data Catalog



Use the CData JDBC Driver for PingOne with the Informatica Enterprise Data Catalog to classify and organize data.

Informatica provides a powerful, elegant means of transporting and transforming your data. By utilizing the CData JDBC driver for PingOne, you are gaining access to a driver based on industry-proven standards that integrates seamlessly with Informatica's Enterprise Data Catalog. This tutorial shows how to classify and organize PingOne data across any environment.

Load the JDBC Driver

To load the JDBC Driver:

  1. Install the JDBC Driver on the host running Informatica. For this article, it is assumed that the driver was installed into cdata.jdbc.pingone.PingOneDriver.
  2. $ java -jar setup.jar
  3. Navigate to the JDBC install directory and create a zip file called genericJDBC.zip containing the driver and its license file.
  4. $ cd ~/cdata-jdbc-driver-for-pingone/lib $ zip genericJDBC.zip cdata.jdbc.pingone.jar cdata.jdbc.pingone.lic
  5. Move the genericJDBC.zip file into the Catalog Service directory within Informatica. For this article, it is assumed that Informatica is installed into /opt/informatica. Working in this folder will probably require root permissions, so make sure to su or sudo to root before continuing.
  6. # mv genericJDBC.zip /opt/informatica/services/CatalogService/ScannerBinaries
  7. Edit the custom deployment configuration to unpack the zip file.
  8. # cd /opt/informatica/services/CatalogService/ScannerBinaries/CustomDeployer/ # nano scannerDeployer.xml

    After unpacking the existing ExecutionContextProperty nodes, add a new ExecutionContextProperty node with this content.

    <ExecutionContextProperty isLocationProperty="true" dependencyToUnpack="genericJDBC.zip"> <PropertyName>JDBCScanner_DriverLocation</PropertyName> <PropertyValue>scanner_miti/genericJDBC/Drivers</PropertyValue> </ExecutionContextProperty>
  9. Refresh the Catalog Service from the Admin console.

Configure the JDBC Resource

To configure the JDBC resource:

  1. Open the Catalog administrator and add a new JDBC resource with the following properties:
    • Driver Class: cdata.jdbc.pingone.PingOneDriver
    • URL: jdbc.pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH;
    • 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.

      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.

    Typical additional connection string properties follow:

    JDBC;MSTR_JDBC_JAR_FOLDER=PATH\TO\JAR\;DRIVER=cdata.jdbc.pingone.PingOneDriver;URL={jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;};
  2. Username: user
  3. Password: password
  4. Note that the Username and Password properties are required, even if the driver you are using does not require them. In those cases, you can enter a placeholder value instead.

  5. Configure the metadata options to perform at least one source metadata scan. This scan uses the driver to determine what tables, views, and stored procedures are available through the service.
    • Source Metadata: Enable this option.
    • Catalog: Set this to the appropriate catalog for multi-catalog data sources. Otherwise, set this to CData.
    • Schema: Set this to the appropriate schema for multi-schema data sources. Otherwise, set this to the name of the service (for example, Couchbase).
    • Case-sensitivity: Generally this option should be disabled. Enable it only for data sources which are case-sensitive.
    • Import stored procedures: Enable this if you want to import stored procedure definitions in addition to tables and views.

    Other metadata scanners may be enabled as desired.

  6. Complete the driver configuration, optionally configuring custom attributes and a scanner schedule.
  7. Perform the metadata scan by navigating to the Monitoring tab and clicking Run. Depending upon the data source, this may takes a few minutes.

When the scan is complete, a summary of all of the metadata objects is displayed along with the status of the Metadata Load job. If any errors occur, you can open the Log Location link for the job to see the errors reported by Informatica or the driver.

Validate the Discovered Metadata

Open the Catalog Service browser to view the metadata extracted from the data source. Depending upon the options you selected when configuring the metadata scanner, you may see any combination of tables, views, and stored procedures for the resource you defined.

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.