Connect to UKG Pro WFM Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for UKG Pro WFM into your processes in RapidMiner. This article uses the CData JDBC Driver for UKG Pro WFM to transfer UKG Pro WFM data to a process in RapidMiner.

Connect to UKG Pro WFM in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to UKG Pro WFM:

1. Add a new database driver for UKG Pro WFM: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL:

   
   jdbc:api:
   

4. Enter the path to the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class:

   
   cdata.jdbc.api.APIDriver
   

   
6. Create a new UKG Pro WFM connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the UKG Pro WFM driver you configured previously.
9. Enter your connection string in the Host box.

   Start by setting the Profile connection property to the location of the UKGProWFM Profile on disk (e.g. C:\profiles\UKGProWFM.apip). Next, set the ProfileSettings connection property to the connection string for UKGProWFM (see below).

   UKGProWFM API Profile Settings

   UKG Pro Workforce Management uses OAuth 2.0 with the Resource Owner Password Credentials grant (grant_type=password) to authorize access to the API. Unlike most OAuth-based profiles, this does not use a browser redirect/authorization-code step: the driver exchanges your UKG Pro WFM username, password, client ID, and client secret directly for an access token.

   Set the following connection properties to authenticate:

   • AuthScheme: Set this to OAuthPassword.
   • Host: Set this to the hostname of your UKG Pro Workforce Management datacenter/tenant (for example, yourcompany.mykronos.com). Do not include the protocol (https://) or a trailing slash.
   • OAuthClientId: Set this to the client ID issued for your UKG Pro Workforce Management OAuth application.
   • OAuthClientSecret: Set this to the client secret issued for your UKG Pro Workforce Management OAuth application.
   • User: Set this to your UKG Pro Workforce Management username.
   • Password: Set this to your UKG Pro Workforce Management password.

   Access tokens are obtained from https://{Host}/api/authentication/access_token. Refresh tokens issued by UKG Pro Workforce Management expire after 7 days; if a refresh attempt fails because the refresh token itself has expired, the driver must re-authenticate with your User/Password credentials to obtain a new access token.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the UKG Pro WFM JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   
   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   

   A typical connection string is below:

   
   Profile=C:\profiles\UKGProWFM.apip;AuthScheme=OAuthPassword;ProfileSettings='Host=yourcompany.mykronos.com;User=your_username;Password=your_password;';OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
   

10. Enter your username and password if necessary.

You can now use your UKG Pro WFM connection with the various RapidMiner operators in your process. To retrieve UKG Pro WFM data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the UKG Pro WFM data.