UKG Pro WFM

Overview

The UKG Pro Workforce Management (WFM) connector (the product formerly known as 'Dimensions') allows you to integrate with UKG Pro's time-off management functionality. This connector enables users to retrieve leave balances, view leave history, submit new leave requests, and manage existing requests.

Authentication

UKG Pro WFM uses OAuth 2.0 authentication. You'll need to obtain an access token before performing any actions.

Input Fields

Field Name	Description
URL	The UKG authentication URL for your environment
Username	Your UKG username
Password	Your UKG password

Actions

Get Current User Info

This action retrieves information about the currently authenticated user.

Input Fields

Field Name	Description
None	No additional input required beyond authentication

Use case

This action can be used by AI Agent of UKG Pro to fetch user's information and accordingly show relevant information to the user if asked for it

Get Leave Balance

This action retrieves the accrual balance for a specific time-off type/sub-type.

Input Fields

Field Name	Description
Subtype Name	The name of the time-off subtype (e.g., "S-Time Off")
Date	The date for which to check the balance (format: YYYY-MM-DD)

Get Leave History

This action retrieves the history of time-off requests for an employee.

Input Fields

Field Name	Description
Person Number	The employee's identifier
Start Date	Beginning of the date range to check (format: YYYY-MM-DD)
End Date	End of the date range to check (format: YYYY-MM-DD)

Apply leave

This action submits a new time-off request for an employee.

Input Fields

Field Name	Description
Person Number	The employee's identifier
Start Date	The first day of the requested time off (format: YYYY-MM-DD)
Start Time	The starting time on the first day (format: HH:MM)
End Date	The last day of the requested time off (format: YYYY-MM-DD)
Duration	The duration of the time off in hours
Pay Code ID	The ID of the pay code to use (can be retrieved via Request Subtypes)
Symbolic Amount Qualifier	The unit of measure for the duration (e.g., "HOURS")
Request Subtype ID	The ID of the request subtype (obtainable via Get Request Subtypes)

Cancel Leave Request (internal action)

This action cancels an existing time-off request.

Input Fields

Field Name	Description
Person Number	The employee's identifier
Time Off Request ID	The ID of the time-off request to cancel
Comment	A note explaining the cancellation

Update Leave Request Status

This action updates the status of a time-off request (can be used for approval/rejection/cancellation).

Input Fields

Field Name	Description
Person Number	The employee's identifier
Time Off Request ID	The ID of the time-off request to update
New Status	The desired status (e.g., "Approved", "Rejected", "Cancelled")
Comment	Optional note regarding the status change

Get Manager Approval Requests

This action retrieves time-off requests pending for manager approval.

Input Fields

Field Name	Description
Employee Qualifiers	List of employee identifiers to check
Start Date	Beginning of the date range to check (format: YYYY-MM-DD)
End Date	End of the date range to check (format: YYYY-MM-DD)
Completion State	Filter by completion state (e.g., "COMPLETE", "PENDING")

Common Use Cases

1. Employee Self-Service

Check leave balances
Submit time-off requests
View leave history
Cancel planned time off

2. Manager Functions

Review pending time-off requests
Approve or reject requests
Monitor team leave patterns

3. HR Administration

Track organization-wide leave usage
Generate reports on time-off patterns
Ensure policy compliance

Implementation Notes

The Pay Code ID and Request Sub-type ID values must be retrieved using the Get Request Sub-types action before creating a leave request.
When canceling or updating a request, you must have the Time Off Request ID, which can be obtained from the Leave History.
Duration is typically specified in hours, with a full day usually represented as 8 hours (may vary by organization policy).