Connect to UKG Pro HCM Data in Airbyte ELT Pipelines

Airbyte empowers users to load your data into any data warehouse, data lake, or database. When combined with CData Connect AI, Airbyte users can create Extract, Load, Transform (ELT) pipelines directly from live UKG Pro HCM data. This article illustrates the process of connecting to UKG Pro HCM through Connect AI and constructing ELT pipelines for UKG Pro HCM data within Airbyte.

CData Connect AI offers a dedicated SQL Server interface for UKG Pro HCM, facilitating data querying without the need for data replication to a native database. With built-in optimized data processing capabilities, CData Connect AI efficiently directs all supported SQL operations, including filters and JOINs, straight to UKG Pro HCM. This harnesses server-side processing to swiftly retrieve the desired UKG Pro HCM data.

Configure UKG Pro HCM Connectivity for Airbyte

Connectivity to UKG Pro HCM from Airbyte is made possible through CData Connect AI. To work with UKG Pro HCM data from Airbyte, 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 Airbyte.

Connect to UKG Pro HCM from Airbyte

To establish a connection from Airbyte to CData Connect AI, follow these steps.

1. Log in to your Airbyte account
2. On the left panel, click Sources, then Add New Source
   • Set Source Type to MSSQL Server to connect the TDS endpoint
   • Set Source Name
   • Set Host URL to tds.cdata.com
   • Set Port to 14333
   • Set Database to the name of the connection you previously configured, e.g. API1.
   • Set Username to your Connect AI username
   • Set SSL Method to Encrypted (trust server certificate), leave the Replication Method as standard, and set SSH Tunnel Method to No Tunnel
   • (Optional) Set Schema to anything you want to apply to the source
   • Set Password to your Connect AI PAT
   • (Optional) Enter any needed JBDC URL Params
3. Click Test and Save to create the data source.

Create ELT Pipelines for UKG Pro HCM Data

To connect UKG Pro HCM data with a new destination, click Sources and then Set Up Connection to connect to your destination. Select the source created above and your desired destination, then allow Airbyte to process. When it is done, your connection is ready for use.

Get CData Connect AI

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