Integrate UKG Pro HCM Data in Your Informatica Cloud Instance

Informatica Cloud allows you to perform extract, transform, and load (ETL) tasks in the cloud. With the Cloud Secure Agent and the CData API Driver for JDBC, you get live access to UKG Pro HCM data, directly within Informatica Cloud. In this article, we will walk through downloading and registering the Cloud Secure Agent, connecting to UKG Pro HCM through the JDBC Driver and generating a mapping that can be used in any Informatica Cloud process.

Informatica Cloud Secure Agent

To work with the UKG Pro HCM data through the JDBC Driver, install the Cloud Secure Agent.

1. Navigate to the Administrator page in Informatica Cloud
2. Select the Runtime Environments tab
3. Click "Download Secure Agent"
4. Make note of the Install Token
5. Run the installer on the client machine and register the Cloud Secure Agent with your username and install token

NOTE: It may take some time for all of the Cloud Secure Agent services to get up and running.

Connecting to the UKG Pro HCM JDBC Driver

With the Cloud Secure Agent installed and running, you are ready to connect to UKG Pro HCM through the JDBC Driver.

Adding the JDBC Driver to the Secure Agent Machine

1. Navigate to the following directory on the Secure Agent machine:

   %Secure Agent installation directory%/ext/connectors/thirdparty/

2. Create a folder and add the driver JAR file (cdata.jdbc.api.jar) based on the type of mapping that you want to configure.

   For mappings, create the following folder and add the driver JAR file:

   informatica.jdbc_v2/common

   For mappings in advanced mode, also create the following folder and add the driver JAR file:

   informatica.jdbc_v2/spark

3. Restart the Secure Agent.

Connecting to UKG Pro HCM in Informatica Cloud

After installing the driver JAR file, you are ready to configure your connection to UKG Pro HCM in Informatica Cloud. Start by clicking the Connections tab and clicking New Connection. Fill in the following properties for the connection:

• Connection Name: Name your connection (i.e.: CData UKG Pro HCM Connection)
• Type: Select "JDBC_V2"
• Runtime Environment: Select the runtime environment where you installed the Secure Agent
• JDBC Driver Class Name: The name of the JDBC driver class: cdata.jdbc.api.APIDriver
• JDBC Connection URL: Set this to the JDBC URL for UKG Pro HCM. Your URL will look similar to the following:
  
  

  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';

  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.

  
• Username: Set this to the username for UKG Pro HCM
• Password: Set this to the password for UKG Pro HCM

Create a Mapping for UKG Pro HCM Data

With the connection to UKG Pro HCM configured, we can now access UKG Pro HCM data in any Informatica process. The steps below walk through creating a mapping for UKG Pro HCM to another data target.

1. Navigate to the Data Integration page
2. Click New.. and select Mapping from the Mappings tab
3. Click the Source Object and in the Source tab, select the Connection and set the Source Type
4. Click "Select" to choose the table to map
5. In the Fields tab, select the fields from the UKG Pro HCM table to map
6. Click the Target object and configure the Target source, table and fields. In the Field Mapping tab, map the source fields to the target fields.

With the mapping configured, you are ready to start integrating live UKG Pro HCM data with any of the supported connections in Informatica Cloud. Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live UKG Pro HCM data in Informatica Cloud today.