Build UKG Pro HCM-Connected ETL Processes in Google Data Fusion

Google Data Fusion allows users to perform self-service data integration to consolidate disparate data. Uploading the CData API Driver for JDBC enables users to access live UKG Pro HCM data from within their Google Data Fusion pipelines. While the CData JDBC Driver enables piping UKG Pro HCM data to any data source natively supported in Google Data Fusion, this article explains how to pipe data from UKG Pro HCM to Google BigQuery,

Upload the CData API Driver for JDBC to Google Data Fusion

Upload the CData API Driver for JDBC to your Google Data Fusion instance to work with live UKG Pro HCM data. Due to the naming restrictions for JDBC drivers in Google Data Fusion, create a copy or rename the JAR file to match the following format driver-version.jar. For example: cdataapi-2020.jar

1. Open your Google Data Fusion instance
2. Click the to add an entity and upload a driver
3. On the "Upload driver" tab, drag or browse to the renamed JAR file.
4. On the "Driver configuration" tab:
   • Name: Create a name for the driver (cdata.jdbc.api) and make note of the name
   • Class name: Set the JDBC class name: (cdata.jdbc.api.APIDriver)
   
5. Click "Finish"

Connect to UKG Pro HCM Data in Google Data Fusion

With the JDBC Driver uploaded, you are ready to work with live UKG Pro HCM data in Google Data Fusion Pipelines.

1. Navigate to the Pipeline Studio to create a new Pipeline
2. From the "Source" options, click "Database" to add a source for the JDBC Driver
3. Click "Properties" on the Database source to edit the properties

   NOTE: To use the JDBC Driver in Google Data Fusion, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

   • Set the Label
   • Set Reference Name to a value for any future references (i.e.: cdata-api)
   • Set Plugin Type to "jdbc"
   • Set Connection String to the JDBC URL for UKG Pro HCM. For example:
     
     jdbc:api:RTK=5246...;Profile=C:\profiles\UKGProHCM.apip;AuthScheme=Basic;User=your_username;Password=your_password;ProfileSettings='Host=yourcompany.ultipro.com;CustomerAPIKey=your_customer_api_key';

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

     UKGProHCM API Profile Settings

     UKG Pro HCM uses Basic authentication combined with a customer API key to authorize access to the API. To connect, you will need your UKG Pro HCM credentials and a customer API key issued by UKG.

     Set the following connection properties to authenticate:

     • AuthScheme: Set this to Basic.
     • User: Set this to your UKG Pro HCM username.
     • Password: Set this to your UKG Pro HCM password.
     • ProfileSettings: Set this to a semicolon-separated list containing:
       • Host: Your UKG Pro HCM tenant hostname (e.g., yourcompany.ultipro.com).
       • CustomerAPIKey: Your UKG customer API key. This is passed as the US-CUSTOMER-API-KEY request header on each API call.

     To obtain your customer API key, contact your UKG Pro HCM administrator or refer to the UKG Developer Portal at https://developer.ukg.com.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the UKG Pro HCM 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.

     
   • Set Import Query to a SQL query that will extract the data you want from UKG Pro HCM, i.e.:
     SELECT * FROM UserDetails
   
4. From the "Sink" tab, click to add a destination sink (we use Google BigQuery in this example)
5. Click "Properties" on the BigQuery sink to edit the properties
   • Set the Label
   • Set Reference Name to a value like api-bigquery
   • Set Project ID to a specific Google BigQuery Project ID (or leave as the default, "auto-detect")
   • Set Dataset to a specific Google BigQuery dataset
   • Set Table to the name of the table you wish to insert UKG Pro HCM data into
   

With the Source and Sink configured, you are ready to pipe UKG Pro HCM data into Google BigQuery. Save and deploy the pipeline. When you run the pipeline, Google Data Fusion will request live data from UKG Pro HCM and import it into Google BigQuery.

While this is a simple pipeline, you can create more complex UKG Pro HCM pipelines with transforms, analytics, conditions, and more. Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live UKG Pro HCM data in Google Data Fusion today.