Lucidum has been acquired by Cyderes → [Read the announcement]

Lucidum has been acquired by Cyderes → [Read the announcement]

View Categories

UKG Pro

Estimated Reading Time: 3 min read

What is UKG Pro? #

UKG Pro (formerly Ultimate Software UltiPro) is a human capital management suite that manages personnel data, payroll tasks, scheduling, and helps attract, nurture, and grow your talent.

Why Should You Use the UKG Pro Connector? #

The UKG Pro connector provides visibility into the assets in your environment. You can use this visibility to:

  • ensure assets are managed per your security policies
  • derive relationships between assets, users, applications, and data

How Does This Connector Work? #

Lucidum executes read-only requests to the UKG Pro REST API and ingests only meta-data about UKG Pro devices. Lucidum does not retrieve any data stored on your assets.

Configuring the Connector in Lucidum #

Field

Description

 

Example

 

Profile Name

 Name of this profile for the connector production servers

URL

The URL for the UKG APIs.

http://service.ultipro.com
Client ID

To access the UKG Pro HCM and UKG Ready APIs for recruiting, supply the Client ID.

For UKG Pro HCM, UKG support provides Client IDs.

For UKG Ready, you can generate the Client ID and Client Secret yourself.

p7g444S3IZ5wmFvmzWmx14qACXdzQ25b
Client Secret To access the UKG Pro HCM and UKG Ready APIs for recruiting, supply the Client ID.

p7g444S3IZ5wmFvmzWmx14qACXdzQ25b
Tenant ID To access the UKG Pro HCM and UKG Ready APIs for recruiting, supply the Client ID.

 
Username

To access UKG Pro HCM core APIs, supply a username associated with a web service account.

For details on creating a web service account, see: https://developer.ukg.com/hcm/docs/web-service-account

LucidumConnector
Password

To access UKG Pro HCM core APIs, supply a username associated with a web service account.

For details on creating a web service account, see: https://developer.ukg.com/hcm/docs/web-service-account

 *************
API Key

To access UKG Pro HCM core APIs, supply an API key for a username associated with a web service account.

For details on creating a web service account, see: https://developer.ukg.com/hcm/docs/web-service-account

DGYCGS000010
Proxy If you are using a proxy server to allow this connector to communicate with on-premises devices, enter the IP address: port for the proxy server, usually 192.168.255.6:3128.

192.168.255.6:3128.

 

Source Documentation #

Client ID, Client Secret, and Tenant ID #

In UKG Pro HCM:

You must request the Client ID, Client Secret, and Tenant ID from UKG support.

In UKG Ready:

To generate Client ID and Client Secret in UKG Ready:

  1. Go to Settings > Global Setup > Company Setup.
  2. Find the OAuth Applications widget.
  3. Choose the Machine to Machine type, and generate a Client ID and Client Secret.

To generate Tenant ID (called Company ID in UKG) in UKG Ready:

  1. Click the hamburger ☰ button.
  2. Navigate to My team > My employees > Employee info.
  3. Click Select columns.
  4. Select Add/Remove columns.
  5. Add Company ID.
  6. Click Apply.
  7. Your Company ID will be displayed for you.

User Name, Password, and API Key #

The user name, password, and API Key associated with a web service account.

To generate a web service account and its API key, see:

https://developer.ukg.com/hcm/docs/web-service-account

Required Permissions #

In UKG Pro HCM, assign the following permissions to the web service account:

  • “View” for “Employee person”

  • “View” for “Employee Export”

  • “View” for “Personal Integration”

  • “View” for “Employee Person Details”

API Documentation #

Overview:

https://developer.ukg.com/general/docs/api-and-developer-tools-overview#ukg-pro-hcm-api

Details:

https://developer.ukg.com/hcm/reference/welcome-to-the-ukg-pro-api

What are your Feelings