Natively Connect to UKG Pro HCM Data in PHP via ODBC (Linux)

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create PHP applications on Linux/UNIX machines with connectivity to UKG Pro HCM data. Leverage the native support for ODBC in PHP.

Drop the CData API Driver for ODBC into your LAMP or WAMP stack to build UKG Pro HCM-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to UKG Pro HCM data, execute queries, and output the results.

Using the CData ODBC Drivers on a UNIX/Linux Machine

The CData ODBC Drivers are supported in various Red Hat-based and Debian-based systems, including Ubuntu, Debian, RHEL, CentOS, and Fedora. There are also several libraries and packages that are required, many of which may be installed by default, depending on your system. For more information on the supported versions of Linux operating systems and the required libraries, please refer to the "Getting Started" section in the help documentation (installed and found online).

Installing the Driver Manager

Before installing the driver, check that your system has a driver manager. For this article, you will use unixODBC, a free and open source ODBC Driver manager that is widely supported.

For Debian-based systems like Ubuntu, you can install unixODBC with the APT package manager:


$ sudo apt-get install unixodbc unixodbc-dev

For systems based on Red Hat Linux, you can install unixODBC with yum or dnf:


$ sudo yum install unixODBC unixODBC-devel

The unixODBC driver manager reads information about drivers from an odbcinst.ini file and about data sources from an odbc.ini file. You can determine the location of the configuration files on your system by entering the following command into a terminal: 


$ odbcinst -j

The output of the command will display the locations of the configuration files for ODBC data sources and registered ODBC drivers. User data sources can only be accessed by the user account whose home folder the odbc.ini is located in. System data sources can be accessed by all users. Below is an example of the output of this command: 


DRIVERS............: /etc/odbcinst.ini
SYSTEM DATA SOURCES: /etc/odbc.ini
FILE DATA SOURCES..: /etc/ODBCDataSources
USER DATA SOURCES..: /home/myuser/.odbc.ini
SQLULEN Size.......: 8
SQLLEN Size........: 8
SQLSETPOSIROW Size.: 8

Installing the Driver

You can download the driver in standard package formats: the Debian .deb package format or the .rpm file format. Once you have downloaded the file, you can install the driver from the terminal.

The driver installer registers the driver with unixODBC and creates a system DSN, which can be used later in any tools or applications that support ODBC connectivity.

For Debian-based systems like Ubuntu, run the following command with sudo or as root: 


$ dpkg -i /path/to/package.deb

For Red Hat systems or other systems that support .rpms, run the following command with sudo or as root: 


$ rpm -i /path/to/package.rpm

Once the driver is installed, you can list the registered drivers and defined data sources using the unixODBC driver manager:

List the Registered Driver(s)


$ odbcinst -q -d
CData API Driver for ODBC
...

List the Defined Data Source(s)


$ odbcinst -q -s
CData API Source
...

To use the CData API Driver for ODBC with unixODBC, ensure that the driver is configured to use UTF-16. To do so, edit the INI file for the driver (cdata.odbc.api.ini), which can be found in the lib folder in the installation location (typically /opt/cdata/cdata-odbc-driver-for-api), as follows:

cdata.odbc.api.ini


...

[Driver]
DriverManagerEncoding = UTF-16

Modifying the DSN

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. Additionally, you can create user-specific DSNs that will not require root access to modify in $HOME/.odbc.ini.

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.

/etc/odbc.ini or $HOME/.odbc.ini


[CData API Source]
Driver = CData API Driver for ODBC
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).

Establish a Connection

Open the connection to UKG Pro HCM by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.


$conn = odbc_connect("CData ODBC API Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources and queries execute faster.


$conn = odbc_pconnect("CData ODBC API Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function. 


$query = odbc_prepare($conn, "SELECT * FROM UserDetails WHERE UserStatus = ?");

Execute Queries

Execute prepared statements with odbc_execute. 


$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM UserDetails WHERE UserStatus = ?");
$success = odbc_execute($query, array('A'));

Execute nonparameterized queries with odbc_exec. 


$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_exec($conn, "SELECT UserId, UserName FROM UserDetails WHERE UserStatus = 'A'");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.


$conn = odbc_connect("CData ODBC UKG Pro HCM data Source","user","password");
$query = odbc_exec($conn, "SELECT UserId, UserName FROM UserDetails WHERE UserStatus = 'A'");
while($row = odbc_fetch_array($query)){
 echo $row["UserId"] . "\n";
}

Display the result set in an HTML table with the odbc_result_all function.


$conn = odbc_connect("CData ODBC UKG Pro HCM data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM UserDetails WHERE UserStatus = ?");
$success = odbc_execute($query, array('A'));
if($success)
  odbc_result_all($query);

More Example Queries

You will find complete information on the SQL queries supported by the driver in the help documentation. The code examples above are UKG Pro HCM-specific adaptations of the PHP community documentation for all ODBC functions.

Ready to get started?

Connect to live data from UKG Pro HCM with the API Driver

Connect to UKG Pro HCM

In this article

Related articles