Integrate with live UKG Pro HCM Data in Jitterbit

Jitterbit is an enterprise iPaaS (integration platform as a service) that lets you streamline your data workflows. When paired with CData Connect AI, Jitterbit gets access to live UKG Pro HCM data. This article demonstrates how to connect to UKG Pro HCM using Connect AI and integrate with live UKG Pro HCM data in Jitterbit.

CData Connect AI provides a pure OData 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 Jitterbit

To work with UKG Pro HCM data from Jitterbit, we need to connect to UKG Pro HCM from Connect AI, provide user access to the connection, and create a Workspace for the UKG Pro HCM data.

Connect to UKG Pro HCM from Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

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.

Configure UKG Pro HCM Endpoints for Jitterbit

After connecting to UKG Pro HCM, create a workspace for your desired table(s).

1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
2. Click Add to add new assets to the Workspace.
3. Select the UKG Pro HCM connection (e.g. API1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to UKG Pro HCM data from Jitterbit.

Connect to UKG Pro HCM from Jitterbit using Connect AI

To establish a connection from Jitterbit to CData Connect AI using the OData protocol, follow these steps.

1. Log into Jitterbit.
2. Create a project in Cloud Studio and provide a workspace environment for it.
3. click Sources and enter OData in the search bar.
4. Select the OData connector.
5. Enter the OData connection properties.
• Connection Name: enter a connection name.
• OData Metadata URL: enter https://cloud.cdata.com/api/odata/{workspace_name}.
• Authentication: select Basic Auth.
• User Name: 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 on the Settings page.

6. Click Test to test the connection, and then click Save Changes.
7. Choose the operation you want to perform and drag it to the workflow in your project.
8. Double-click the query operation to see all the tables and derived views available in your OData endpoint.
9. Select a table and configure the query.

You can now transform and integrate live UKG Pro HCM data in Jitterbit.

Get CData Connect AI

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