Access UKG Pro HCM Data as a Remote Oracle Database

The Oracle Database Gateway for ODBC and Heterogeneous Services technology enable you to connect to ODBC data sources as remote Oracle databases. This article shows how to use the CData ODBC Driver for UKG Pro HCM to create a database link from UKG Pro HCM to Oracle and to query UKG Pro HCM data through the SQL*Plus tool. You can also create the database link and execute queries from SQL Developer.

Connect to UKG Pro HCM as an ODBC Data Source

Information for connecting to UKG Pro HCM follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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.

Windows

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.

Note: If you need to modify the DSN or create other UKG Pro HCM DSNs, you must use a system DSN and the bitness of the DSN must match your Oracle system. You can access and create 32-bit DSNs on a 64-bit system by opening the 32-bit ODBC Data Source Administrator from C:\Windows\SysWOW64\odbcad32.exe.

Linux

If you are installing the CData ODBC Driver for UKG Pro HCM in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

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

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Set Connection Properties for Compatibility with Oracle

The driver provides several connection properties that streamline accessing UKG Pro HCM data just as you would an Oracle database. Set the following properties when working with UKG Pro HCM data in SQL*Plus and SQL Developer. For compatibility with Oracle, you will need to set the following connection properties, in addition to authentication and other required connection properties.

• MapToWVarchar=False

  Set this property to map string data types to SQL_VARCHAR instead of SQL_WVARCHAR. By default, the driver uses SQL_WVARCHAR to accommodate various international character sets. You can use this property to avoid the ORA-28528 Heterogeneous Services data type conversion error when the Unicode type is returned.

• MaximumColumnSize=4000

  Set this property to restrict the maximum column size to 4000 characters.

• IncludeDualTable=True

  Set this property to mock the Oracle DUAL table. SQL Developer uses this table to test the connection.

Linux Configuration

In Linux environments, Oracle uses UTF-8 to communicate with the unixODBC Driver manager, whereas the default driver encoding is UTF-16. To resolve this, open the file /opt/cdata/cdata-driver-for-api/lib/cdata.odbc.api.ini in a text editor and set the encoding.

cdata.odbc.api.ini

[Driver]
DriverManagerEncoding = UTF-8

Configure the ODBC Gateway, Oracle Net, and Oracle Database

Follow the procedure below to set up an ODBC gateway to UKG Pro HCM data that enables you to query live UKG Pro HCM data as an Oracle database.

1. Create the file initmyukgprohcmdb.ora in the folder oracle-home-directory/hs/admin and add the following setting:

   initmyukgprohcmdb.ora

   HS_FDS_CONNECT_INFO = "CData API Sys"

2. Add an entry to the listener.ora file. This file is located in oracle-home-directory/NETWORK/admin.

   If you are using the Database Gateway for ODBC, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

   listener.ora

   
   SID_LIST_LISTENER =
     (SID_LIST =
       (SID_DESC =
         (SID_NAME = myukgprohcmdb)
         (ORACLE_HOME = your-oracle-home)
         (PROGRAM = dg4odbc)
       )
     )
   

   If you are using Heterogeneous Services, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

   listener.ora

   
   SID_LIST_LISTENER =
     (SID_LIST =
       (SID_DESC =
         (SID_NAME = myukgprohcmdb)
         (ORACLE_HOME = your-oracle-home)
         (PROGRAM = hsodbc)
       )
     )
   

3. Add the connect descriptor below in tnsnames.ora, located in oracle-home-directory/NETWORK/admin:

   tnsnames.ora

   
   myukgprohcmdb  =
     (DESCRIPTION=
       (ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521))
       (CONNECT_DATA=(SID=myukgprohcmdb))
       (HS=OK)
     ) 
   

4. Restart the listener.

5. Test the configuration with the following command:

   tnsping myukgprohcmdb

6. Open SQL*Plus and create the database link with the command below:

   CREATE DATABASE LINK myukgprohcmdb CONNECT TO "user" IDENTIFIED BY "password" USING 'myukgprohcmdb';

You can now execute queries in SQL*Plus like the one below (note the double quotation marks around the table name):

SELECT * from "UserDetails"@myukgprohcmdb WHERE UserStatus = 'A';