How to use IBM App Connect with UKG

Ultimate Kronos Group (UKG), previously known as Kronos Worksuite Dimension, is a flexible and seamless solution that aims to transform businesses with global HCM and offers data-based, actionable insights to enhance workforce management. It includes technology and services for HR, talent, payroll, and workforce management, allowing you to manage the entire employee journey from a single platform.
Availability:
  • App Connect Enterprise as a Service connector
  • A local connector in a Designer instance of IBM App Connect in containers (Continuous Delivery release)Local connector in containers (Continuous Delivery release)
  • A local connector in a Designer instance of IBM App Connect in containers (Long Term Support)Local connector in containers (Long Term Support release)
  • A local connector in a Designer instance of IBM App Connect in containers (Support Cycle 2)Local connector in containers (Long Term Support Cycle-2 release)
The following information describes how to use IBM® App Connect to connect UKG to your other applications.

Supported product and API versions

To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.

Connecting to UKG

To connect App Connect to a UKG account, you need the following connection details:

Connection field Description
Endpoint URL The UKG URL in the format 'https://<hostName>.mykronos.com', where <hostName> is the tenant's host name that's configured for users with IDP accounts. This part of the URL is set as part of a tenant's federation configuration.
User name The user name for your UKG account.
Password The password for your UKG account.
Client ID The OAuth application client ID for regenerating the access token.
Tip: You will need to raise a request to your UKG support team to get the client ID.
Client secret The OAuth application client secret for regenerating the access token.
Tip: You will need to raise a request to your UKG support team to get the client secret.
Application key You can generate the application key in the UKG development portal. All requests against the UKG APIs need a valid application key to be passed in the HTTP header.
Tip: For more information, see Generate and Access App Keys on the UKG documentation page.

To connect to a UKG endpoint from the App Connect Designer Catalog page for the first time, expand UKG, then click Connect. For more information, see Managing accounts.

Tip:

Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.

General considerations

Before you use App Connect Designer with UKG, take note of the following considerations:

  • (General consideration) You can see lists of the trigger events and actions that are available on the Applications and APIs page of the App Connect Designer.

    For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

  • (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

UKG events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Note: Events are not available for changes in this application. You can trigger a flow in other ways, such as at a scheduled interval or at specific dates and times.

UKG actions

Your flow completes these actions on this application.

Attendance
Retrieve attendance records
Reset attendance balance
Attendance balances
Retrieve attendance balance types
Employee extensions
Retrieve employee employment details
Employee schedules
Retrieve employee schedules
Employees
Retrieve employees
Job preferences
Retrieve employee job preferences
Leave records
Retrieve employee leave records
People
Create person

Examples

Dashboard tile for a template that uses UKG

Use templates to quickly create flows for UKG

Learn how to use App Connect templates to quickly create flows that perform actions on UKG. For example, open the Templates gallery, and then search for UKG.

Learn more