Share via

UKG Pro WFM Employee (Preview)

  • Reference

Employee Self Service Actions.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name KGS
URL https://www.ukg.com/support
Email [email protected]
Connector Metadata
Publisher Ria Gupta
Website https://www.ukg.com/
Privacy policy https://www.ukg.com/privacy
Categories Human Resources

UKG Pro WFM Employee connector simplifies the steps to easy access some of the most frequently used Pro WFM Employee Self Service Actions.

Prerequisites

You will need the value of access_token generated via PRO WFM Authentication connector.

How to get credentials

Configure the connector properties using the prerequisite information during the connection creation process. Upon a successful call of WFM PRO Authentication connector, the connector's response will include both the value of access_token, which can be subsequently utilized as parameters in PRO WFM Employee connector.

Get started with your connector

  • Select Retrieve Employee Schedule action to fetch an employee's schedule according to the specified parameter.
  • Select Create Time Off Request action to submit a time off request according to the specified parameters.
  • Select Retrieve Accrual Balance action to fetch an accrual balance.
  • Select Retrieve Symbolic Value action to fetch a symbolic value.
  • Select Retrieve Request Subtype action to fetch a request subtype.

Known issues and limitations

None

Common errors and remedies

Contact us via https://www.ukg.com/support

FAQ

Contact us via https://www.ukg.com/support in case of errors and questions.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
PRO WFM Vanity URL securestring The PRO WFM Vanity URL for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create Time Off Request

Submit a time off request according to the specified parameters.
Retrieve Accrual Balance

This operation returns an accrual balance.
Retrieve Employee Schedule

Returns an employee's schedule according to the specified parameter.
Retrieve Request Subtype

This operation returns a request subtype.
Retrieve Symbolic Value

This operation returns a symbolic value.

Create Time Off Request

Operation ID:
RequestTimeOff

Submit a time off request according to the specified parameters.

Parameters

Name Key Required Type Description
Access Token
 accessToken True string

Token to access API.
End Date
 endDate True date

The end date of the time-off period.(YYYY-MM-DD)
PayCode
 qualifier True string

The qualifier of PayCode
Start Date
 startDate True date

The start date of the time-off period.(YYYY-MM-DD)
Symbolic Amount
 qualifier True string

The qualifier of Symbolic Amount.
Request Sub Type
 name True string

The name of a request subtype.

Retrieve Accrual Balance

Operation ID:
GetAccrualBalance

This operation returns an accrual balance.

Parameters

Name Key Required Type Description
Access Token
 accessToken True string

Token to access API.
subtype_id
 subtype_id integer

The ID of the request subtype associated with an accrual.
subtype_name
 subtype_name string

The name of the request subtype associated with an accrual.
date
 date string

The date associated with an accrual in format(YYYY-MM-DD).

Retrieve Employee Schedule

Operation ID:
GetSchedule

Returns an employee's schedule according to the specified parameter.

Parameters

Name Key Required Type Description
select
 select string

Set of conditions used to find the schedule request.
start_date
 start_date string

Inclusive start date of the schedule date range.
end_date
 end_date string

Exclusive end date for the schedule date range.
symbolic_period_id
 symbolic_period_id integer

Symbolic period ID associated with the schedule.
symbolic_period_name
 symbolic_period_name string

Symbolic period name associated with the schedule.
employee_id
 employee_id integer

An ID that uniquely identifies an employee.This is not personnumber.
person_number
 person_number integer

A number that uniquely identifies a person.It is not employeeID.
order_by
 order_by string

Values by which the schedule request results can be ordered.
exclude_breaks
 exclude_breaks boolean

Boolean indicator of whether to exclude breaks in emp schedule.
scratchpad-id
 scratchpad-id string

The ID of the current business interaction.
Access Token
 accessToken True string

Token to access API.

Retrieve Request Subtype

Operation ID:
GetRequestSubtype

This operation returns a request subtype.

Parameters

Name Key Required Type Description
Access Token
 accessToken True string

Token to access API.
Perform-Translation
 Perform-Translation string

Boolean indicator of whether to return localized properties.
position_id
 position_id integer

The ID of a position associated with a request subtype.
position_name
 position_name integer

The name of a position associated with a request subtype.

Retrieve Symbolic Value

Operation ID:
GetSymbolicValue

This operation returns a symbolic value.

Parameters

Name Key Required Type Description
Access Token
 accessToken True string

Token to access API.
subtype_id
 subtype_id integer

The ID of the request subtype associated with a symbolic value.
subtype_name
 subtype_name string

The name of the request subtype associated with a symbolic value.