Using the CData ODBC Driver for UKG Pro HCM in PyCharm

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for UKG Pro HCM from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for UKG Pro HCM as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

1. Click File -> Settings to open the project settings window.
2. Click Project Interpreter from the Project: YourProjectName menu.
3. To add pyodbc, click the + button and enter pyodbc.
4. Click Install Package to install pyodbc.

Connect to UKG Pro HCM

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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.

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for UKG Pro HCM
Description = My Description
Profile = C:\profiles\UKGProHCM.apip
AuthScheme = Basic
User = your_username
Password = your_password
ProfileSettings = 'Host = yourcompany.ultipro.com
CustomerAPIKey = your_customer_api_key'

Execute SQL to UKG Pro HCM

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for API};Profile = C:\profiles\UKGProHCM.apip;AuthScheme = Basic;User = your_username;Password = your_password;ProfileSettings = 'Host = yourcompany.ultipro.com;CustomerAPIKey = your_customer_api_key';')
cursor = cnxn.cursor()
cursor.execute("SELECT UserId, UserName FROM UserDetails WHERE UserStatus = 'A'")
rows = cursor.fetchall()
for row in rows:
  print(row.UserId, row.UserName)

After connecting to UKG Pro HCM in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to UKG Pro HCM data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].