Build Semantic Layer Views for PingOne Data in APOS Live Data Gateway

APOS Live Data Gateway (LDG) is a data connection and data transformation solution that enables live data connectivity and expanded data source options for SAP Analytics Cloud and other SAP solutions. When paired with CData Connectors, users can build semantic layer views for live PingOne data, enabling real-time analytics on PingOne just like working with a relational database.

With built-in optimized data processing, the CData Connector 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.

Download and Install the Connector Files

In order to access PingOne data through the APOS Live Data Gateway, you will need to download the connector files from APOS and install them on the machine hosting the Live Data Gateway. An APOS representative can deliver the necessary files.

• Install the CData DLL file (System.Data.CData.PingOne.dll) to the APOS Live Data Gateway installation directory (C:\Program Files\Live Data Gateway\Admin\ by default).
• Install the CData JAR file (cdata.jdbc.pingone.jar) to the ConnectionTest_lib folder in the installation directory (C:\Program Files\Live Data Gateway\Admin\ConnectionTest_lib\ by default).
• Install the CData JAR file (cdata.jdbc.pingone.jar) to the lib folder in the Web UI installation directory (e.g.: C:\LDG_WebUI\lib\)

Configuring the PingOne Connection String

Before establishing the connection to PingOne from the APOS Live Data Gateway, you need to configure the PingOne JDBC Connection String.

Built-in Connection String Designer

For assistance in constructing the JDBC Connection String, 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.

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.

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

Your connection string will look similar to the following:

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

Connecting to PingOne & Creating a Semantic Layer View

After installing the connector files and configuring the connection string, you are ready to connect to PingOne in the Live Data Gateway Admin tool and build a semantic layer view in the Live Data Gateway Web UI.

Configuring the Connection to PingOne

1. Log into your APOS Live Data Gateway Manager 👁 Logging into the APOS LDG Manager
   
2. If you haven't already, update your APOS LDG license file
   1. Click File -> Configurations
   2. Click on the "..." Menu for the License
   3. Select the license file from the APOS team that includes your CData Connector license
3. In the APOS Live Data Gateway Manager, click "Add"
4. In the APOS Live Data Gateway On the Connection tab, configure the connection:
   • Set Data Source to "Database"
   • Set Database to "CData Drivers"
   • Set Database CData Drivers to "PingOne"
   • Set Connection String to the connection string configured earlier (e.g.:

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

   • Set Driver Class to "cdata.jdbc.pingone.PingOneDriver" (this should be set by default)
   👁 Configuring the Connection (Salesforce is shown).
   
5. Click Test Connection
6. Click Save
7. Give your connection a unique prefix (e.g. "pingone")
8. Highlight the newly created connection and click File -> "Approve Users For Web UI" 👁 Approving Users For Web UI.
   
9. Approve the appropriate DB users to create views and click "Save" 👁 Configuring which DB users can create views.
   

At this point, we are ready to build our semantic layer view in the Live Data Gateway Web UI.

Creating a Semantic Layer View

1. In your browser, navigate to the APOS Live Data Gateway Portal
2. Select a Connection (e.g. "pingone")
3. Since PingOne does not require a User or Password to authenticate, you may use whatever values you wish for User Name and Password
4. Click "Login" 👁 Connecting from the Web UI (Salesforce is shown).
   
5. Once connected, click "Semantic Layer" to create a new semantic layer view
6. Click "New Semantic Layer View" 👁 Adding a new semantic layer view.
   
7. Set the Semantic Layer View Prefix and Semantic Layer View Name 👁 Setting the semantic layer view prefix and name.
   
8. Click "Step 2"
9. Select the table(s) and column(s) you wish to include in your view 👁 Selecting table(s) and column(s).
   
10. Click "Step 3"
11. Select the Measures from the available table columns 👁 Selecting the measure(s).
    
12. Click "Step 5" (we skipped the "Extra Dimensions" step)
13. Add any Variable Prompts
14. Click "Step 6"
15. Define any Table Joins
16. Click "Review"
17. Review you semantic layer view and click "Save" 👁 Saving the semantic layer view.
    

With the Semantic Layer View created, you are ready to access your PingOne data through the APOS Live Data Gateway, enabling real-time data connectivity to PingOne data from SAP Analytics Cloud and other SAP solutions.

More Information & Free Evaluation

Please visit APOS Systems - APOS Solutions - Request Evaluation Software to request evaluation software or email [email protected] for more information on working with your live PingOne data in APOS Live Data Gateway.