How to Build an ETL App for UKG Pro HCM Data in Python with CData

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData API Driver for Python and the petl framework, you can build UKG Pro HCM-connected applications and pipelines for extracting, transforming, and loading UKG Pro HCM data. This article shows how to connect to UKG Pro HCM with the CData Python Connector and use petl and pandas to extract, transform, and load UKG Pro HCM data.

With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live UKG Pro HCM data in Python. When you issue complex SQL queries from 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).

Connecting to UKG Pro HCM Data

Connecting to UKG Pro HCM data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

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.

After installing the CData UKG Pro HCM Connector, follow the procedure below to install the other required modules and start accessing UKG Pro HCM through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install petl
pip install pandas

Build an ETL App for UKG Pro HCM Data in Python

Once the required modules and frameworks are installed, we are ready to build our ETL app. Code snippets follow, but the full source code is available at the end of the article.

First, be sure to import the modules (including the CData Connector) with the following:

import petl as etl
import pandas as pd
import cdata.api as mod

You can now connect with a connection string. Use the connect function for the CData UKG Pro HCM Connector to create a connection for working with UKG Pro HCM data.

cnxn = mod.connect("Profile=C:\profiles\UKGProHCM.apip;AuthScheme=Basic;User=your_username;Password=your_password;ProfileSettings='Host=yourcompany.ultipro.com;CustomerAPIKey=your_customer_api_key';")

Create a SQL Statement to Query UKG Pro HCM

Use SQL to create a statement for querying UKG Pro HCM. In this article, we read data from the UserDetails entity.

sql = "SELECT UserId, UserName FROM UserDetails WHERE UserStatus = 'A'"

Extract, Transform, and Load the UKG Pro HCM Data

With the query results stored in a DataFrame, we can use petl to extract, transform, and load the UKG Pro HCM data. In this example, we extract UKG Pro HCM data, sort the data by the UserName column, and load the data into a CSV file.

Loading UKG Pro HCM Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'UserName')

etl.tocsv(table2,'userdetails_data.csv')

With the CData API Driver for Python, you can work with UKG Pro HCM data just like you would with any database, including direct access to data in ETL packages like petl.

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to UKG Pro HCM data. Reach out to our Support Team if you have any questions.

Full Source Code

import petl as etl
import pandas as pd
import cdata.api as mod

cnxn = mod.connect("Profile=C:\profiles\UKGProHCM.apip;AuthScheme=Basic;User=your_username;Password=your_password;ProfileSettings='Host=yourcompany.ultipro.com;CustomerAPIKey=your_customer_api_key';")

sql = "SELECT UserId, UserName FROM UserDetails WHERE UserStatus = 'A'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'UserName')

etl.tocsv(table2,'userdetails_data.csv')