Connect to UKG Pro HCM Data in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData API Driver for JDBC, HULFT Integrate can work with live UKG Pro HCM data. This article explains how to connect to UKG Pro HCM and move the data into a CSV file.

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

Enable Access to UKG Pro HCM

To enable access to UKG Pro HCM data from HULFT Integrate projects:

1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.api.jar (and cdata.jdbc.api.lic), to the jdbc_adapter subfolder for the Integrate Server
2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to UKG Pro HCM Data

Once you copy the JAR files, you can create a project with access to UKG Pro HCM data. Start by opening Integrate Studio and creating a new project.

1. Name the project
2. Ensure the "Create script" checkbox is checked
3. Click Next
4. Name the script (e.g.: APItoCSV)

Once you create the project, add components to the script to copy UKG Pro HCM data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for UKG Pro HCM. Set the following properties:
   • Name: UKG Pro HCM Connection Settings
   • Driver class name: cdata.jdbc.api.APIDriver
   • URL: jdbc:api:Profile=C:\profiles\UKGProHCM.apip;AuthScheme=Basic;User=your_username;Password=your_password;ProfileSettings='Host=yourcompany.ultipro.com;CustomerAPIKey=your_customer_api_key';
     
     

     Built-in Connection String Designer

     For assistance 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.

     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.

     
2. Write your SQL statement. For example:

   SELECT UserId, UserName FROM UserDetails

3. Click "Extraction test" to ensure the connection and query are configured properly
4. Click "Execute SQL statement and set output schema"
5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

1. Set a file to write the query results to (e.g. UserDetails.csv)
2. Set "Input data" to the "Select SQL" component
3. Add columns for each field selected in the SQL query
4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
5. Click "Finish"

Map UKG Pro HCM Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move UKG Pro HCM data into a CSV file.

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live UKG Pro HCM data in HULFT Integrate. Reach out to our Support Team if you have any questions.