Build PingOne-Connected Web Apps in Servoy

Servoy is a rapid application development and deployment platform. When paired with the CData JDBC Driver for PingOne, users can build PingOne-connected apps that work with live PingOne data. This article describes how to connect to PingOne from Servoy and build a simple web app to display and search PingOne data.

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 lets you work with PingOne data using native data types.

Connect to PingOne in Servoy Developer

To build PingOne-connected apps, you need to first create a data provider in Servoy Developer using the CData JDBC Driver for PingOne.

1. Install the JDBC Driver.
2. Copy the JDBC Driver JAR file. (cdata.jdbc.pingone.jar) to the /application_server/drivers/ directory in the installation directory for Servoy.
3. Open Servoy Developer.
4. In the Solution Explorer, right-click Database Server (under Resources) and choose "Connect to existing database" -> "empty."
   1. Name the server.
   2. Click to show the advanced server settings.

      • Set the URL, for example: jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH;

        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.

        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 (Salesforce is shown.)
        
      • Select the Driver class you just copied, for example, cdata.jdbc.pingone.PingOneDriver
   👁 Connecting to data through the JDBC Driver (Salesforce is shown).
   

Build a PingOne-Connected Web App

Once you have configured the connection to PingOne in the Servoy Developer resources, you are ready to build apps with access to live PingOne data.

Create a New Solution

1. In the Server Explorer, right-click "All solutions" and select "Create new solution."
2. Name the solution.
3. Select the checkbox to include the "search" module.
4. Click "Finish."

Create a New Form

Right-click "Forms" and select "Create new form."

1. Name the form.
2. Select a Datasource.
3. Set the type (e.g., Simple) and click "Finish."

Add a Data Grid to the Form

1. Drag a Data Grid component (from Servoy NG-Grids) onto the form.

2. Drag a column component onto the Data Grid and set the "dataprovider" property for each column component to a column from the PingOne "table" (e.g., Id from the [CData].[Administrators].Users table).

   Continue adding columns as desired.

Add Searching to the App

Note that the "svySearch" extension is required to add search functionality (included by default when you create a new solution). If you did not add the extension when you created the solution or you are modifying an existing solution, you can add the search module by right-clicking Modules (in the solution) and selecting "Add Module." Select "svySearch" and click "OK."

1. Drag a Text Field component onto the Form.
2. Right-click the Form and select "Open in Script Editor."
3. Create a new variable (JavaScript) to hold the search value:

   var searchText = '';
   

4. Back on the Form, in the Text Field properties:
   1. Set the "dataprovider" property to the Form variable you just created.
   2. Double-click to add a method for the onAction event.
   3. Click to create the method in "Form," name the method (e.g., onEnter), and click "Create private."
   4. Click "OK & Show."
5. Add the following JavaScript to the JavaScript file to use the Servoy framework to implement searching bound data based on the text in the Text Field:

   var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
   search.setSearchAllColumns();
   search.loadRecords(foundset);
   

Save and Launch the App

Save the form and JavaScript file, then click Run -> Launch NGClient to start the web app.

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