Integrate UKG Pro WFM with External Services using SnapLogic

SnapLogic is an integration platform-as-a-service (iPaaS) that allows users to create data integration flows with no code. When paired with the CData JDBC Drivers, users get access to live data from more than 250+ SaaS, Big Data and NoSQL sources, including UKG Pro WFM, in their SnapLogic workflows.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live UKG Pro WFM data. When platforms issue complex SQL queries to UKG Pro WFM, the driver pushes supported SQL operations, like filters and aggregations, directly to UKG Pro WFM 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 UKG Pro WFM data using native data types.

Connect to UKG Pro WFM in SnapLogic

To connect to UKG Pro WFM data in SnapLogic, download and install the CData UKG Pro WFM JDBC Driver. Follow the installation dialog. When the installation is complete, the JAR file can be found in the installation directory (C:/Program Files/CData/CData API Driver for JDBC/lib by default).

Upload the UKG Pro WFM JDBC Driver

After installation, upload the JDBC JAR file to a location in SnapLogic (for example, projects/Jerod Johnson) from the Manager tab.

Configure the Connection

Once the JDBC Driver is uploaded, we can create the connection to UKG Pro WFM.

1. Navigate to the Designer tab
2. Expand "JDBC" from Snaps and drag a "Generic JDBC - Select" snap onto the designer
3. Click Add Account (or select an existing one) and click "Continue"
4. In the next form, configure the JDBC connection properties:
   • Under JDBC JARs, add the JAR file we previously uploaded
   • Set JDBC Driver Class to cdata.jdbc.api.APIDriver

   • Set JDBC URL to a JDBC connection string for the UKG Pro WFM JDBC Driver, for example:

     jdbc:api: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;RTK=XXXXXX;

     NOTE: RTK is a trial or full key. Contact our Support team for more information.

     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.

     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.

     
5. After entering the connection properties, click "Validate" and "Apply"

Read UKG Pro WFM Data

In the form that opens after validating and applying the connection, configure your query.

• Set Schema name to "API"
• Set Table name to a table for UKG Pro WFM using the schema name, for example: "API"."Employees" (use the drop-down to see the full list of available tables)
• Add Output fields for each item you wish to work with from the table

Save the Generic JDBC - Select snap.

With connection and query configured, click the end of the snap to preview the data (highlighted below).

Once you confirm the results are what you expect, you can add additional snaps to funnel your UKG Pro WFM data to another endpoint.

Piping UKG Pro WFM Data to External Services

For this article, we will load data in a Google Spreadsheet. You can use any of the supported snaps, or even use a Generic JDBC snap with another CData JDBC Driver, to move data into an external service.

1. Start by dropping a "Worksheet Writer" snap onto the end of the "Generic JDBC - Select" snap.
2. Add an account to connect to Google Sheets
3. Configure the Worksheet Writer snap to write your UKG Pro WFM data to a Google Spreadsheet

You can now execute the fully configured pipeline to extract data from UKG Pro WFM and push it into a Google Spreadsheet.

More Information & Free Trial

Using the CData API Driver for JDBC you can create a pipeline in SnapLogic for integrating UKG Pro WFM data with external services. For more information about connecting to UKG Pro WFM, check at our CData API Driver for JDBC page. Download a free, 30 day trial of the CData API Driver for JDBC and get started today.