Creating an extended integration for UKG Pro users

Create an integration to sync UKG Pro with Oomnitza to gain visibility of user data and manage user data.

See UKG Pro API Documentation: User Profile Details.

Before you start

To easily find the records that are uploaded to Oomnitza, it's best practice to create a dedicated user account for each integration. This will make it easier for you to retrieve the records that are uploaded to Oomnitza from the vendor application.

Creating integration users

You need the following information to add basic auth credentials to Oomnitza:

UKG username
UKG password

You need the following information to create the integration:

UKG customer API key
UKG base URL

See UKG: Documentation.

Adding your credentials

Click Configuration > Security > Credentials.
Click Add new credential.
Search for UKG.
Click the arrow next to UKG.
Enter your UKG username and password.
Save your credentials.

Creating the integration

In Oomnitza, click Configuration > Integrations > Overview.
Click Block view .
On the Integrations page, scroll down to the Extended section for user integrations.
Click NEW INTEGRATION.
In the sidebar, search for the integration.
Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

User only. Add user records.
User plus SaaS user. Add user and SaaS user records.

The benefit of adding SaaS user records is that you can run a workflow to validate the status and activity of SaaS users and retrieve information such as the role of the SaaS user. The information that can be retrieved depends on whether SaaS user workflows are available for the integration.

Installation types

Cloud. Store credentials in the Oomnitza cloud.
Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication.

Integration preferences

Create & Update. Add and update records.
Create only. Add records.
Update only. Update records.

Editing the integration details

Click Edit .
Make your changes.

Editing the credential details

If you selected Cloud as the installation type, choose one of the following options:

Select the credentials that were created for the integration.
Edit the credentials that were created for the integration.
Create new credentials

Scheduling the integration

By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.

Click Edit .
Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit .

Selecting Edit integration to add rules for syncing data. Filtering integration results.

You can add new fields to your integration by selecting Add new field on the mapping page.
Creating custom API fields.

Map the UKG fields to Oomnitza fields and create custom mappings to get the user information that you need.

Click Smart Mapping. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
Create a custom mapping for the UKG User ID field.
1. Select Add new Oomnitza users field from the User ID dropdown list.
2. Rename the field toUKG User ID.
3. Select the Unique checkbox.
4. Click CREATE.
Required. Ensure that the Email field is mapped to the Email field in Oomnitza.
Required. Ensure that the Username is mapped to Username in Oomnitza.
Required. Select the Role field and choose a role from the list.
Required. Assign a sync key to a unique field, such as the Email.
Click UPDATE.

Custom mappings

The following UKG fields can be mapped to Oomnitza:

Connect: Credentials
Connect: UKG Customer API Key
Connect: UKG Full Time
Connector Sync Time
Email
Filter Company ID
Filter Deduction Group Code
Filter Employee Type
Filter Full Time or Part Time
Filter Job Code
Filter Location Code
Filter Organization Level 1
Filter Organization Level 2
Filter Organization Level 3
Filter Organization Level 4
Filter Pay Group Code
Filter Project Code
Filter Salary Or Hourly
Filter Shift Code
Filter Status
Filter Supervisor ID
Filter Tax Calculation
Group ID
First Name
Home Company
Home Company ID
Integration User Key
Last Login
Last Name Last Password Change Date
Master Company
Master Company ID
Role Description
Role ID
Role Name
UKG Company Id
UKG Employee Id
UKG Person ID
UKG User ID
User Status
Username
Work Phone

Tracking information

When the integration is run, you can track the name of the credentials that were used and the source of the data. To do this, you map the following fields to Oomnitza:

Connect: Credentials
Connect: UKG Customer API Key
Connect: UKG Full Time
Connector Sync Time

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration.

If you selected Cloud as the installation type when creating the integration, see Running an extended integration

If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab.