UKG Pro Integration

Introduction

If you are a UKG Pro customer on a PerformYard Enterprise account, you can set up the PerformYard-UKG Pro integration to automatically pull data from UKG Pro into PerformYard. To set up this integration, you must be an Admin in PerformYard and UKG Pro. 

If you are not a UKG customer or want more info about the PerformYard-UKG Pro integration, you can learn more here. If you are a UKG Pro customer, please confirm that the integration is available in your PerformYard account with your Customer Success Manager.

Getting Started

To get started, you can just navigate to the HRIS Integrations link in the Administration section of PerformYard and go over the instructions.

Prerequisite: Create a Service Account in UKG Pro

You must first establish PerformYard in the Service Account Administration section of UKG. This page will provide you with your Customer API Key and the ability to add a new Service Account. You will need to provide a User Name and Email address in UKG, and you will also need to allow UKG to generate a password for you. You will need your API Key, User Name, and Password to initiate the integration in PerformYard. 

When setting up the Service Account for use with PerformYard, please provide View access to the following UKG Pro Web Services:

  • Employee Compensation
  • Company Configuration Integration
  • Personnel Integration
  • Employee Person Details
  • Employee Compensation Details

Enter your UKG Pro Service Account Credentials in PerformYard

Click Enter UKG Pro Credentials to enter your Customer API Key, User Name, Password, and Web Service Base URL. Click to Submit Credentials for validation.

UKG Pro Web Service Credentials Entry

Note: The Web Service Base URL for your UKG Pro account can vary, so please refer to UKG Pro documentation and to your UKG Pro service account details to find your Web Service Base URL.  Contact your UKG Pro system administrator if you are unsure where to find this information.

Once your credentials have been validated, click Next.

Connect Fields

The next step for connecting PerformYard and UKG is to confirm the data fields you want to sync. First Name and Last Name are required; other fields are not. If you choose to sync any other fields, please remember that those fields will be overwritten by data in UKG Pro for existing PerformYard accounts and newly created PerformYard accounts. You will no longer be able to edit these data fields within PerformYard, and UKG Pro will be the "source of record" for this data. Mapping certain fields from UKG Pro to PerformYard requires the data field types to correspond (e.g., date field to date field or numeric field to numeric field). 

Please note that while the email address will be used to match users between UKG Pro and PerformYard and create new users, updates to email addresses in UKG Pro will not update the address in PerformYard. The address in PerformYard is also the user's login and must be changed individually.

Fields Available to Sync

Standard Fields
  • Additional Name 1
  • Additional Name 2
  • Address City
  • Address Country
  • Address Line 1
  • Address Line 2
  • Address State
  • Address Zip Code
  • Annual Salary
  • Auto Allocate
  • Clock Code
  • Company Code
  • Company GLSegment
  • Company ID
  • Company Name
  • Currency Code
  • Date In Job
  • Date Last Pay Date Paid
  • Date Last Worked
  • Date Of Benefit Seniority
  • Date of Birth
  • Date Of Early Retirement
  • Date Of Local Union
  • Date Of National Union
  • Date Of Retirement
  • Date Of Seniority
  • Date Of Suspension
  • Date Of Termination
  • Date Paid Thru
  • Date Time Changed
  • Date Time Created
  • Deduction Group Code
  • Earning Group Code
  • Email Address
  • Email Address Alternate
  • Employee ID
  • Employee Number
  • Employee Status Code
  • Employee Type Code
  • Ethnic ID Code
  • First Name
  • Full Time Or Part Time Code
  • Gender
  • Hire Source
  • Home Phone
  • Hourly Pay Rate
  • Is Auto Allocated
  • Is Autopaid
  • Is Multiple Job
  • Job Change Reason Code
  • Job Description
  • Job Group Code
  • Job Salary Grade
  • Job Title
  • Language Code
  • Last Hire Date
  • LastName
  • Leave Reason Code
  • Location GLSegment
  • Mailstop
  • Marital Status Code
  • Middle Name
  • Name Prefix Code
  • Name Suffix Code
  • Ok To Rehire
  • Org Level 1 Code
  • Org Level 2 Code
  • Org Level 3 Code
  • Org Level 4 Code
  • Original Hire Date
  • Pay Group
  • Pay Group Description
  • Pay Period
  • Pay Period Pay Rate
  • Person ID
  • Planned Leave Reason
  • Position Code
  • Preferred Name
  • Primary Job Code
  • Primary Project Code
  • Primary Work Location Code
  • Salary Or Hourly
  • Scheduled Annual Hrs
  • Scheduled FTE
  • Scheduled Work Hrs
  • Shift
  • Shift Group
  • Status Start Date
  • Supervisor COID
  • Supervisor Company Code
  • Supervisor Employee Number
  • Supervisor First Name
  • Supervisor ID
  • Supervisor Last Name
  • Term Reason
  • Term Type
  • Termination Reason Description
  • Timeclock ID
  • Union Local
  • Union National
  • User Name
  • Weekly Hours
  • Weekly Pay Rate
  • Work Phone Country
  • Work Phone Extension
  • Work Phone Number
and custom fields supported that fall into the following classes:
  •   Address
  •   Person
  •   Person Name
  •   Employee
  •   Phone Number
  •   Employment
  •   International Employee

Import Employees

After finalizing your data fields, you will begin reviewing existing employees in UKG Pro and determining what to do with those people in PerformYard. By default, this step will only include active employees in UKG Pro.

If you have already created accounts for staff in PerformYard, we will attempt to match those users to their UKG Pro account based on their email address (Deb Greene example below). If no email address is found, the initial prompt is to create a PerformYard account for that person or enter an email address to create an account (Sam White example below).

Click Remove if you do not want to match Deb Greene in UKG Pro with Deb Greene in PerformYard. Likewise, if you do not want to create a new account for a user in PerformYard, click the X in the Create New column (as was done for Nancy Shawsburg in the example above). You can also search for an existing PerformYard user by typing that user's name into the text box in the Selected column. After matching all users or creating new ones, click Next to move to another list of users. Any user not matched or created will be automatically set to Ignore. After reviewing all employees, you'll return to the Integrations page.

This page will show any UKG Pro employee that has not been matched with a PerformYard account. From this point forward, newly added people to UKG Pro will appear in this list for action.

You will have three options for these employees:

  1. In the selected column, search for an existing PerformYard user to whom you want to match this UKG Pro employee (if they have a PerformYard account but didn't auto-match).
  2. Create new, which will prompt to create a new, linked PerformYard account with that email address.
  3. Ignore where you can park UKG Pro employees for whom you do not want a PerformYard account.

For any selected/matched user, you can also click the blue View button to open that employee's profile in a new window. There are also options to choose "Create New" and "Ignore" for all users listed. Note that any employee listed terminated/deactivated in either system will have that status shown.

Above the employee list, you'll have options to search for employees and filter the list. The filter options appear below. If no employees match the filters, you will receive a message describing that fact.

  • The default filter set is for UKG Pro employees to connect/add to PerformYard. These are newly added folks to UKG Pro or those that were not matched/added, so you can easily create PerformYard accounts for these employees by selecting the Create New box. You can also choose to ignore any of these employees.
  • The Currently connected UKG Pro employees filter will show all UKG Pro employees that have been matched. You can delink any users on this page if necessary. Typically no action will be required here.
  • Connected UKG Pro employees terminated in UKG Pro and active in PerformYard. These will be those employees that have been terminated in UKG Pro, where you'll need to deactivate them in PerformYard. Click the View button to open their PerformYard profile, where you can edit/deactivate.
  • Connected UKG Pro employees terminated in UKG Pro and deactivated in PerformYard. This list will show you those folks terminated in UKG Pro and deactivated in PerformYard. This list is typically for reference as no action is usually required.
  • UKG Pro employees previously set to Ignore will identify anyone you Ignored as one of the options above should you want to provide a PerformYard account in the future (or link to a PerformYard account).

Editing Employee Data from UKG Pro

As mentioned, when a user is connected with UKG Pro, their information will not be editable in PerformYard.  UKG Pro is the "source of truth" for these data fields, and they should be updated in UKG Pro. The below screenshot demonstrates how those data fields will appear when attempting to edit that user.

Related Articles