How to use IBM App Connect with UKG

Ultimate Kronos Group (UKG), previously known as Kronos Worksuite Dimension, is a flexible solution that transforms 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.

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 hostname that is configured for users with IDP accounts. This part of the URL is set as part of a tenant's federation configuration.
User name The username for your UKG account.
Password The password for your UKG account.
Client ID The OAuth application client ID for regenerating the access token.
Tip: To get the client ID, raise a request with your UKG support team.
Client secret The OAuth application client secret for regenerating the access token.
Tip: To get the client secret, raise a request with your UKG support team.
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 in the UKG documentation.

To connect to a UKG endpoint from the App Connect Designer Connect > Applications and APIs page (previously the 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.

Object Action Description
Attendance Retrieve attendance records Retrieves records for the specified employees within a date range
Reset attendance balance Resets the balances for a list of employees within a date range
Attendance balances Retrieve attendance balance types Retrieves point balance summaries for a list of employees within a date range
Employee extensions Retrieve employee employment details Retrieves extensions data for a person record
Employee schedules Retrieve employee schedules Retrieves the schedule of a list of employees within a specified date range
Employees Retrieve employees Retrieves a list of employees
Job preferences Retrieve employee job preferences Retrieves job preferences for one or more employees
Leave records Retrieve employee leave records Retrieves auditing records for employees within a date range
People Create person Creates and saves a new person record

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 complete actions on UKG. For example, go to the Discover page and search for UKG.

Learn more