# UKG Pro Workforce Management setup

UKG Pro Workforce Management connects through the **unified HRIS connector**.
This page covers the UKG-side configuration you complete first. Once it's done,
add the connector in Mesh by following [Connect your HR
system](../connect-your-hr-system.md).

This is a different product from [UKG Pro](./ukg-pro-integration.md) and takes
different credentials. If you're not sure which you have, check with your UKG
administrator before starting.

You finish with four values:

| Value | Where it comes from |
|---|---|
| **Client ID** | Issued when your tenant was provisioned |
| **Client secret** | Issued at the same time |
| **Username** | The API user you create |
| **Password** | Set on that user |

## Before you start

You need **administrator access** to your company's UKG Pro instance, or a
colleague who has it.

> **note**

They are normally handed over when the tenant is provisioned, so they may be
held by whoever set UKG up rather than being discoverable in the interface. If
you cannot find them, UKG Global Support can reissue them.

> **warning**

These steps reflect Axiad's current understanding of UKG Pro Workforce
Management's configuration. Because it is a third-party product, there may be
variations between your experience and what this guide describes, depending on
the version in use and recent updates.

If you find a significant difference, or anything that doesn't make sense, let
us know through Axiad support.

## Step 1 — Create an API user

The quickest route is to duplicate an existing administrator who can already see
every employee and location, then convert the copy into a dedicated API account.

1. Go to **Menu → Maintenance → People Information**.
2. Select an administrator whose access covers all employees and locations, then
   choose **Person → Duplicate**.
3. In the new profile, select **Edit Licenses** and confirm at least a
   **Manager** license is selected. Broader access may need more.
4. Under **Information**, set:

   | Field | Value |
   |---|---|
   | Last name | `APIUser` |
   | ID | `APIUser`, or another unused user ID |
   | Username | `APIUser` |

5. Set the authentication details and save.

Using a dedicated account rather than a person's login means the connection
keeps working when individuals change role or leave.

## Step 2 — Assign a function access profile

The API user needs a function access profile granting the permissions the
connector reads through. Assign one that covers employee, location, and
organizational data.

> **caution**

The connection authenticates on the account's credentials, so a missing or
too-narrow function access profile shows up as a healthy connector returning few
or no records rather than as an authentication error.

## Step 3 — Connect in Mesh

Follow [Connect your HR system](../connect-your-hr-system.md), choose UKG Pro
Workforce Management in the connection window, and supply the client ID, client
secret, and the API user's username and password.

## After connecting

The connector appears in your connectors list with **Health: Initializing**
while the first collection runs, then moves to **Good**. Access is
**read-only**: Mesh does not write back to UKG.

If it doesn't come online, see [Troubleshoot HR
connectors](../troubleshoot-hr-connectors.md).

## Troubleshooting

| What you see | Likely cause | Fix |
|---|---|---|
| You cannot find the client ID or secret | They were issued at tenant provisioning rather than through the interface | Ask UKG Global Support to reissue them |
| The connector authorizes but returns few records | The API user's function access profile is too narrow | Widen the profile in Step 2, then re-run the collection |
| Authentication fails | The credentials are for UKG Pro rather than UKG Pro Workforce Management | Confirm which product you have, and use [UKG Pro setup](./ukg-pro-integration.md) if appropriate |