> ## Documentation Index
> Fetch the complete documentation index at: https://usepike.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# UKG Pro

> Sync UKG Pro employees, org levels, scheduled hours and approved time off into Pike, and send approved hours to UKG Pro Workforce Management timecards.

The UKG Pro integration syncs employees from UKG Pro HCM into Pike [members](https://usepike.com/docs/members/overview.md), with their org level, job, supervisor and scheduled hours, and syncs approved time off from UKG Pro Workforce Management into Pike [time off](https://usepike.com/docs/members/time-off.md). For hourly employees, Pike can send approved hours to their UKG Pro Workforce Management timecard as pay code edits. Capacity, utilization and payroll then use the same people and the same hours.

## At a glance

| | |
| - | - |
| **Direction** | UKG Pro to Pike for employees, org levels, jobs, scheduled hours, time off and compensation. Pike to UKG Pro Workforce Management for hours, when turned on |
| **Who sets it up** | Workspace admins, with a UKG Pro web service account and Customer API Key, and UKG Pro Workforce Management API credentials |
| **Plan** | All plans |
| **Sync** | Every 3 hours. On the Enterprise plan, changes sync in real time. |
| **Source of truth** | UKG Pro for person fields, scheduled hours and time off. Pike for capacity, allocations, projects, time and cost rates |

## Before you start

You need:

* The workspace admin role in Pike.
* A UKG Pro web service account. A UKG Pro admin creates it under **System Configuration → Security → Web Service Accounts** and gives it the View role for the Employee Person Details, Employee Employment Details, Compensation Details and Company Configuration Integration web services. The same page shows your **Customer API Key** and the service host for your data center.
* For time off and hours, UKG Pro Workforce Management API credentials: the tenant hostname, an application key, a client ID and client secret, and an API user whose function access profile can view time off requests and edit timecards. Your UKG Pro Workforce Management admin creates these.
* Pike time off types for the UKG Pro pay codes you use for time off. You map each one during setup. See [Time off](https://usepike.com/docs/members/time-off.md).

## Connect UKG Pro

**1. Open the integration**

Go to **Workspace settings → Integrations → UKG Pro** and click **Add
integration**.

**2. Connect UKG Pro HCM**

Enter the service host, the web service account user name and password, and
the Customer API Key, then click **Connect**. Pike checks the account and
shows your UKG Pro companies.

**3. Connect Workforce Management**

Under **Workforce Management**, enter the tenant hostname, application key,
client ID, client secret, and the API user name and password, then click
**Connect**.

**4. Choose teams and time off types**

Under **Teams from**, choose the org level that becomes Pike teams. Under
**Time off types**, choose a Pike time off type for each UKG Pro time off
pay code. Pike suggests a mapping from the pay code names.

**5. Choose what syncs**

In the **What syncs with UKG Pro** card, turn **Read** and **Send** on or
off for each entity, and choose whether to turn on **Invite new employees**.

**6. Import**

Click **Import data**. Org levels import first, then employees, then time
off.

The integration page shows **Connected**, the UKG Pro company name, **Last synced** and **Next sync**.

## What syncs

| UKG Pro | Pike | Direction |
| - | - | - |
| Employees (UKG Pro HCM) | Members | UKG Pro to Pike |
| Org levels | Teams | UKG Pro to Pike |
| Jobs | Positions | UKG Pro to Pike |
| Scheduled hours | Capacity per week | UKG Pro to Pike |
| Approved time off requests (Workforce Management) | Time off | UKG Pro to Pike |
| Compensation details | Member cost profiles | UKG Pro to Pike, when **Sync compensation to cost profiles** is on |
| Pay code edits on the timecard | Approved hours from a closed pay period | Pike to UKG Pro, when **Send hours to payroll** is on |

### Employees

| UKG Pro field | Pike field | Notes |
| - | - | - |
| First name, last name | Member name | The preferred first name when one is set |
| Work email | Member email | Also used to match existing members |
| Job title | Position | A position is created when no Pike position has the same name |
| Org level chosen under **Teams from** | Team | A team is created when no Pike team has the same name |
| Supervisor | Manager | When the supervisor's work email matches a Pike member |
| Employee status | Member status | A terminated employee becomes a deactivated member. History is kept |
| Original hire date | Hire date | |
| Salary or hourly | Employment type | Hourly employees become hourly members, salaried employees salaried members |
| Scheduled work hours | Capacity per week | Converted from the pay period to a week, spread over Monday to Friday |
| Employee number | UKG Pro ID | Shown on the member as the UKG Pro marker |

To give a part-time employee a different weekday pattern, set the [work schedule](https://usepike.com/docs/members/working-time.md#work-schedule) in Pike. Pike uses that schedule as long as the weekly total matches UKG Pro.

### Time off

| UKG Pro field (time off request) | Pike field | Notes |
| - | - | - |
| Employee | Member | Matched through the employee number |
| Pay code | Time off type | Through your type mapping |
| Start date and end date | Dates | |
| Duration in hours, or full or half day | Hours per day | A part-day request removes only its hours from capacity |
| Status | Not stored | Only requests with the status **Approved** or **Taken** import |

Default type mapping: vacation to Vacation, sick to Sick, parental to Parental, time off in lieu to Time off in lieu, unpaid to Unpaid leave, and every other pay code to Vacation. Each type counts toward the member's [norm hours](https://usepike.com/docs/members/working-time.md#norm-hours) as set on the Pike type.

### Compensation

**Sync compensation to cost profiles** is off by default. Only admins and finance users can turn it on.

| UKG Pro field | Pike field | Notes |
| - | - | - |
| Annual salary, or hourly pay rate | Cost profile salary | Hourly pay rate for hourly employees |
| Salary or hourly | Cost profile pay period | Year or hour |
| Date of last pay change | Cost profile start date | Each compensation change adds a new row |

See [Cost profile](https://usepike.com/docs/members/cost-profile.md).

### Hours to Workforce Management

**Send hours to payroll** is off by default. When on, closing a [pay period](https://usepike.com/docs/members/payroll.md) in Pike sends each hourly employee's approved hours to their UKG Pro Workforce Management timecard as pay code edits, one per day and pay code. Under **Pay codes**, map normal hours to your regular pay code and paid-out Overtime 1 and Overtime 2 to your overtime pay codes. UKG Pro Payroll then picks up the hours from the signed-off timecard. Hours for salaried employees are not sent. Pike does not run payroll or calculate tax.

## Matching and duplicates

On the first import, Pike matches before it creates:

* An employee matches a Pike member with the same work email. A match links the two, and UKG Pro values replace the Pike values for the fields in the mapping.
* An org level matches a Pike team with the same name. A job title matches a Pike position with the same name.
* Time off always imports as new time off. Time off already entered in Pike for the same member and dates stays, and the UKG Pro request is listed in **Sync issues** as an overlap.

An employee with no matching member appears under **Unmatched employees** on the integration page. Click **Invite** to send a Pike invite, or **Link to member** to link the employee to a member with a different email. With **Invite new employees** on, Pike sends the invite automatically with the default role the admin chose.

## Which system wins

| Entity | UKG Pro owns | Pike owns |
| - | - | - |
| Members | Name, work email, position, team, manager, status, employment type, hire date | Role, rates, working time per weekday, project access, allocations |
| Capacity | Scheduled work hours | How the weekly hours spread over the days |
| Time off | Dates, hours and pay code of requests from UKG Pro | Time off requested in Pike |
| Cost profiles | Salary rows, when compensation sync is on | Cost profiles, when compensation sync is off |
| Time | Punches and edits made in UKG Pro | Time entries, approvals, overtime and pay periods in Pike |

Edit UKG Pro-owned fields in UKG Pro. Pike shows them as read-only with the UKG Pro marker.

## Sync schedule

Pike syncs UKG Pro every 3 hours. On the Enterprise plan, changes sync in real time. Closing a pay period sends hours to UKG Pro straight away on every plan, as do **Import data**, **Sync now** and **Refresh** on a member. See [How sync works](https://usepike.com/docs/integrations/how-sync-works.md).

## Sync settings

While UKG Pro is connected, the **What syncs with UKG Pro** card is below the top button row on the integration page. Toggles save immediately.

| Entity | Read | Send |
| - | - | - |
| Employees | Yes | Not available |
| Org levels | Yes | Not available |
| Time off | Yes | Not available |
| Compensation | Off by default, admins and finance users only | Not available |
| Hours to payroll | Not available | Off by default, hourly employees only |

New connections start with **Read** on for employees, org levels and time off, with **Invite new employees**, compensation and **Send hours to payroll** off.

## How it works

```mermaid theme={"system"}
sequenceDiagram
  participant Person as Employee in UKG Pro
  participant Manager as Manager in UKG Pro
  participant UKG as UKG Pro
  participant Pike
  participant RM as Resource manager in Pike
  Person->>UKG: Request vacation for Thursday and Friday
  Manager->>UKG: Approve the request
  UKG->>Pike: Approved time off, on the next sync or in real time
  Pike->>Pike: Remove 16 hours from capacity
  Pike-->>RM: Allocations show the absence
  RM->>Pike: Close the pay period
  Pike->>UKG: Pay code edits for hourly employees
  UKG-->>Pike: Result per employee
```

## Use it in Pike

### Plan around approved leave

Open **Members → Allocations** to see each person's capacity for the week, set from their UKG Pro scheduled hours. Approved time off shows on the day with its type, and the hours are already removed from capacity, so an over-allocated day stands out before the work is due. See [Workspace capacity](https://usepike.com/docs/allocation/workspace-capacity.md).

### Onboard a new hire

When a new hire is added in UKG Pro, they appear in Pike with their team, position and weekly capacity on the next sync. Turn on **Invite new employees**, or click **Invite** under **Unmatched employees**, and the person can log time on their first day.

### Offboard a leaver

When an employee is terminated in UKG Pro, the member is deactivated in Pike. Their logged time, allocations and history stay on every project, and they stop counting toward capacity from the termination date.

### Send hours for hourly employees

Approve time in Pike, then close the pay period. The pay period shows **Sent to UKG Pro** with the number of pay code edits. An employee whose timecard does not accept the edits appears in **Sync issues** with the reason.

## Deletes and removed records

An integration never deletes Pike data. An employee removed from UKG Pro, or no longer visible to the web service account, is marked **Removed in UKG Pro** on the member, stays in Pike with their history, and stops syncing. A time off request canceled in UKG Pro after approval is removed from Pike capacity on the next sync, and the change appears in the member's time off history. Pay code edits already sent stay on the timecard.

## Troubleshooting

| Symptom | Fix |
| - | - |
| An employee is missing in Pike | The web service account cannot view that employee's company. Give it access in UKG Pro, then click **Sync now**. |
| An employee shows under **Unmatched employees** | The work email in UKG Pro differs from the member's email in Pike. Click **Link to member**, or correct the email in UKG Pro. |
| Approved time off is missing | Check that **Read** is on for time off, that Workforce Management is connected, and that the request is **Approved** in UKG Pro. Then click **Refresh** on the member. |
| Time off shows the wrong type | The pay code maps to a different Pike type. Change it under **Time off types**. Existing time off updates on the next sync. |
| **Sync issues** lists an overlap | Time off for the same dates already exists in Pike. Delete the Pike entry, then click **Retry**. |
| **Sync issues** lists an authentication error | The web service account password expired, or the Workforce Management API user changed. Enter the new credentials under **Credentials**. |
| A pay code edit is rejected | The timecard is signed off or the pay period is locked in UKG Pro, or the pay code is not in the employee's profile. Reopen the timecard or change the code under **Pay codes**, then click **Retry**. |

## Limits

* Pike does not create or change employees, org levels or time off requests in UKG Pro.
* Pending, refused or canceled time off requests do not sync.
* Hours go to UKG Pro only for hourly employees, only from closed pay periods, and only from approved time.
* Time off and hours need UKG Pro Workforce Management. With only UKG Pro HCM connected, employees, org levels, scheduled hours and compensation sync.
* Pike sends hours as pay code edits. It does not send punches.
* Compensation sync is off until an admin or finance user turns it on.

## Disconnect

Go to **Workspace settings → Integrations → UKG Pro** and click **Disconnect**. Syncing stops and every member, team, position and time off entry stays in Pike with its history. Reconnecting the same UKG Pro company relinks the members.

## Related

* [How sync works](https://usepike.com/docs/integrations/how-sync-works.md): The schedule, real-time sync and sync issues.
* [Pay periods and payroll](https://usepike.com/docs/members/payroll.md): Period close, pay lines and pay codes.
* [Workspace capacity](https://usepike.com/docs/allocation/workspace-capacity.md): How time off and contracts set available hours.
* [Workday](https://usepike.com/docs/integrations/workday.md): Workers, scheduled weekly hours and hours to Time Tracking.
* [SAP SuccessFactors](https://usepike.com/docs/integrations/sap-successfactors.md): Employees, departments and approved time off.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.