Connect to UKG Pro HCM Data from PowerBuilder via ODBC

The CData ODBC Driver for UKG Pro HCM can be used from any platform or development technology that supports ODBC, including PowerBuilder. This article shows how to connect to UKG Pro HCM data and execute queries from the Database Painter and controls such as the DataWindow.

Connect to UKG Pro HCM as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Create a Profile for the ODBC Driver for UKG Pro HCM

Follow the steps below to use the Database Painter tool to create a database profile based on an ODBC DSN (data source name) for UKG Pro HCM. In the Database Painter, you can use wizards and the UI to work with UKG Pro HCM data.

1. In PowerBuilder, click Tools -> Database Painter.
2. In the Objects window in the Database Painter, right-click the ODBC node and click New Profile.
3. On the Connection tab, enter a name for the profile and select the UKG Pro HCM DSN in the Data Source menu.
4. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using UKG Pro HCM Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to ODBC data sources and execute queries. The following example shows how to retrieve UKG Pro HCM data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "ODBC"
SQLCA.DBParm = "ConnectString='DSN=CData API Source'"
CONNECT USING SQLCA;
dw_userdetails.SetTransObject(SQLCA);
dw_userdetails.Retrieve();