Setting up the UKG Pro and UKG Pro WFM App tiles

Overview

As part of Simpplr's app tiles feature, we offer several out-of-the-box app tiles your org can set up on home and site dashboards. The article linked below gives an overview of how app tiles work, permissions around setting them up, and various requirements. 

Setting Up Out-of-the-Box App Tiles on Dashboards

UKG Pro and UKG Pro WFM tiles

• Enables users to view time off balances retrieved from UKG and display recent paystubs, apply for time off, and view their shift schedules.

• The time-off balance tile displays:

  • Leave type

  • Used leave

  • Remaining leave
    

The Apply for time off pre-built app tile for UKG Pro WFM includes an enhancement in 25.06 that allows users to request long-term leaves of absence, in addition to the existing time-off request option.

Prerequisites:

• The user's email in Simpplr must correspond to their email in UKG Pro
  OR

• The sync source must be selected as "UKG Pro", and the sync identifier is set to the users' UKG Pro Employee ID. The admin user should create a custom field named "ukgProCompanyId", which syncs the users' UKG Pro Company ID

If neither are set up, (i.e. the user does not have an email/user's email does not match/UKG Pro syncing setup is not done) then this UKG app tile will not work.

Display recent paystubs from UKG Pro

This tile allows users to view their recent paystubs on the home dashboard of the intranet.

• Displays:

  • Pay date-range

  • Paystub link

  • Pay date
    

Prerequisites

• The user's email in Simpplr must correspond to their email in UKG Pro
  OR

• The sync source is selected as UKG Pro, and the sync identifier is set to the users' UKG Pro Employee ID. The admin user should create a custom field named "ukgProCompanyId", which syncs the users' UKG Pro Company ID

If neither are set up, (i.e. the user does not have an email/user's email does not match/UKG Pro syncing setup is not done) then this UKG app tile will not work.

Apply for time off from UKG Pro WFM tile

This tile allows users to submit time-off requests directly from Simpplr to UKG Pro WFM.

• Displays:

  • Time-off category selection

  • Start & end date pickers

  • Comment type field

  • Comment note field

• Required inputs:

  • Start and End dates

  • Time-off category

  • Time-off duration

• Prerequisites & additional setup:

  • API access must be enabled for time-off submission

  • Users must have permission to apply for leave in UKG Pro WFM
    

Display shift schedule from UKG Pro WFM

• Displays users’ shift schedules from UKG Pro WFM.

• Displays:

  • Shift start and end time

  • Shift date

  • Location
    

• Required Inputs:

  • My Schedule URL

• Prerequisites & Additional Setup:

  • The user’s email in Simpplr must match their email in UKG Pro WFM

  • API access must be enabled

Setting up the UKG Pro tile

The following 2 inputs are required while adding this app tile to a dashboard:

• UKG Pro Instance URL (mandatory):

  • This URL generates Paystub links.

  • Default Format: https://<name>.ultipro.com

  • Example: https://et19.ultipro.com

• Pay Identifier Key (optional):

  • Default: gennumber

Steps to Identify UKG Pro Instance URL:

1. Navigate to Myself > Pay > Current pay statement on the UKG dashboard.
   

2. Right-click on the Pay statement and select Inspect element.

3. Search for "Link to old Web Pay statement."

4. Copy the URL next to href=.
   

5. Use this URL as the UKG Pro Instance URL.

Steps to Identify Pay Identifier Key:

1. Follow steps 1-4 from the above "Instance URL" section.

2. The Pay Identifier Key typically follows an equal sign (=) and precedes an alphanumeric string.

3. Example: If the URL is https://<name>.ultipro.com/pages/VIEW/EEPayrollPayCheckDetailOriginal.aspx?...&gennumber=BM54VZ0090K0, the Pay Identifier Key is gennumber.

Configure login identifiers as unique identifiers

To configure a login identifier for the UKG Pro WFM integration:

1. Navigate to Settings → Integrations → People data.

2. Scroll down to the UKG Pro WFM section.

Configuration

Identifier

The Identifier is the login identifier configured in Simpplr. The dropdown displays all available login identifiers.

If you want to use a specific field to identify users in UKG Pro WFM, first configure that field as a login identifier in Simpplr, then select it from the Identifier dropdown.

Mapping field

The Mapping Field is the corresponding field in UKG Pro WFM that stores the same identifier.

Select the appropriate Identifier and Mapping Field, then click Save.

Once saved, App Tiles will use the selected Simpplr login identifier and map it to the specified UKG Pro WFM field when fetching user data.

Supported mapping fsields

The following UKG Pro WFM fields are currently supported: