Use JayDeBeApi to access UKG Pro HCM Data in Python

Access UKG Pro HCM data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData API Driver for JDBC and the JayDeBeApi module to work with remote UKG Pro HCM data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to UKG Pro HCM and visualize UKG Pro HCM data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with UKG Pro HCM data in Python using SQL.

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.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "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';"

Access UKG Pro HCM data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData\CData API Driver for JDBC 20XX\lib\cdata.jdbc.api.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from UKG Pro HCM:

import jaydebeapi

#The JDBC connection string
jdbc_url = "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';"

username = "****"
password = "****"

#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData\CData API Driver for JDBC 20XX\lib\cdata.jdbc.api.jar"

conn = jaydebeapi.connect(
   "cdata.jdbc.api.APIDriver",
   jdbc_url,
   [username, password],
   jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM UserDetails;")


results = cursor.fetchall()
for row in results:
    print(row)

cursor.close()
conn.close()

Free trial & more information

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live UKG Pro HCM data in Python. Reach out to our Support Team if you have any questions.