Integrate with UKG Pro HCM Data in SnapLogic

SnapLogic's iPaaS platform helps organizations automate application, data and cloud integrations. When paired with CData Connect AI, SnapLogic gets access to live UKG Pro HCM data. This article demonstrates how to connect to UKG Pro HCM using Connect AI and integrate with UKG Pro HCM data in SnapLogic.

CData Connect AI provides a pure SQL Server interface for UKG Pro HCM, allowing you to query data from UKG Pro HCM without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to UKG Pro HCM, leveraging server-side processing to return the requested UKG Pro HCM data quickly.

Configure UKG Pro HCM Connectivity for SnapLogic

Connectivity to UKG Pro HCM from SnapLogic is made possible through CData Connect AI. To work with UKG Pro HCM data from SnapLogic, we start by creating and configuring a UKG Pro HCM connection.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "UKG Pro HCM" from the Add Connection panel

3. Enter the necessary authentication properties to connect to UKG Pro HCM.

   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.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add UKG Pro HCM Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to UKG Pro HCM data from SnapLogic.

Connect to UKG Pro HCM from SnapLogic using Connect AI

To establish a connection from SnapLogic to CData Connect AI, you will need to download the CData Connect AI JDBC Driver.

1. Open the Integrations page of CData Connect AI.
2. Search for and select JDBC.
3. Download and run the setup file.
4. When the installation is complete, the JAR file can be found in the installation directory (inside the lib folder).

After copying the JDBC CData Connect AI JAR file, you will need to paste it into the SnapLogic installation location and configure the connection to Connect AI.

1. Log into SnapLogic.
2. Click the Managers tab.
3. Select a folder from the Project Spaces to add the JDBC JAR file to.
4. Click the Files tab.
5. Click the button in the top right to upload the CData Connect AI JDBC JAR file. It appears as a file once uploaded.
6. Click the Designer tab.
7. Click JDBC to expand the options for "snaps."
8. Click and drag a Generic JDBC - Select "snap" onto the designer.
9. Click Add Account > Continue.
10. Enter the JDBC connection properties.
    • JDBC driver: add the CData Connect AI JAR file
    • JDBC driver Class: enter cdata.jdbc.connect.ConnectDriver
    • JDBC Url: enter a JDBC connection string for the JDBC driver. For example: jdbc:connect:AuthScheme=Basic;User={username};Password={PAT};
    • Username: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
    • Password: enter the PAT you generated previously.
    
11. Click Validate. If the connection succeeds, the "snap" is ready to use.
12. Click Apply.

You can now create reports with the connected data.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from SnapLogic, try CData Connect AI today!