Configuration Parameters

This section details information that the connector uses to connect to and interact with the UKG Pro Core HCM system through the application. Each application type requires different information to create and maintain a connection.

Note
Attributes marked with an asterisk (*) are mandatory.

This is a valid URL for the UKG Pro Core HCM API to connect to the Core HCM module of the UKG Pro system.

For example:

https://xyz.ultipro.com

Note
The UKG Pro Core HCM connector only supports the Core HCM module of the UKG Pro system.

The managed system only supports Basic Authentication at this time.

The username of the Web Service account

The password used to authenticate the Web Service account

The Customer API Key assigned in the UKG Pro Core HCM system

The number of accounts to aggregate in a single page when iterating over large datasets. The default value is 200 records and the maximum value is 200 records.

Select any additional employee status values to include in aggregation along with Active status employees. By default, the connector only aggregates the Active employee status.

Select one of the following:

  • Leave of absence

  • On strike

  • Released/laid off

  • Suspended

Important
The Active status should always be selected as that’s default aggregation status. If you deselect it, the account aggregation will fail with a validation error.

Enable to aggregate future employees ahead of their hire date.

Enter the number of days in advance of their hire date to aggregate future employees. Leave this field blank to aggregate all future employees.

Enable to aggregate terminated employees following their termination date.

Enter the number of days in the past you want to aggregate terminated employees. Leave the field blank to aggregate all terminated employees regardless of their termination date.