UKG UltiPro (UKG Pro)

INFO

The UltiPro connector is a Scripted API connector. Please refer to the Scripted API documentation for more details.

The UltiPro connector allows data synchronization between UltiPro and RAC/M Identity. To do this, the connector uses the UKG Pro Workforce Management API. The API documentation is available at https://developer.ukg.com/hcm/reference/welcome-to-the-ukg-pro-api.

Like all scripts used by the Scripted API connector, this connector can be modified to meet specific requirements. You can refer to other reference scripts to see how scripts can be modified.

Configuration

The following parameters are required for all Scripted API connectors:

Configuration	Description
Script Path	Path to the Groovy script.
API URL	The URL of the API to connect to.

Additional parameters are also required for the UltiPro connector. The following section describes the required parameters.

Authentication

The UltiPro (UKG Pro) connector uses the Basic Auth (authentication using username and password) to authenticate to the API. This entails that configuration requires a few custom properties in order to allow the authentication flow to happen properly:

Configuration	Must contain
Preferred Authentication Method	password
Username	The username of the account linked with the API Key
Password	The password of the account linked with the API Key
Custom Secret 1	The US-Customer-Api-Key.
ThreadPoolSize	The number of threads to use (default: All available threads)

These properties will provide sufficient information for the connector to authenticate and perform the required operations on the API.

Threads

The UltiPro connector supports concurrent operations. To do this, it uses a thread pool. This allows multiple API calls to be made in parallel to increase performance. This is especially useful when importing a large number of users. The number of threads to use can be configured through the "Thread Pool Size" parameter. Leave this parameter empty to use all available threads.