Connections > Connection properties > UKGPro connection properties
  

UKGPro connection properties

When you set up a UKGPro connection, you must configure the connection properties.
The following table describes the UKGPro connection properties:
Property
Description
Runtime Environment
The name of the run-time environment where you want to run the tasks.
Username
The user name of the UKGPro service account.
Specify one of the following user names:
  • - To read HR, Payroll, Talent, and Benefits or Integration Events data, specify the user name of the service account in UKGPro.
  • - To read Time Management data, specify the ODataService user name associated with UKG support.
Password
The password of the UKGPro service account.
Specify one of the following passwords:
  • - To read HR, Payroll, Talent, and Benefits or Integration Events data, specify the password of the service account in UKGPro.
  • - To read Time Management data, specify the ODataService password associated with UKG support.
Service Host Name
The organization domain of UKGPro to read data from the HR, Payroll, Talent, Benefits, or the Integration Events module.
To get the service host name, navigate to UKGPro > Menu > System Configuration > Security > Web Services.
Specify the service host name in the following format:
service$.ultipro.com,
where $ is a numeric value.
To read the Time Management data, specify the clock server URL provided by UKG support.
User API Key
The User API key when you want to read data from the HR, Payroll, Talent, Benefits, or Integration Events module.
To get the user API key, navigate to UKGPro > Menu > Administration > Integration Studio > Integration Studio Dashboard > Service Accounts graphic tile
To read the Time Management data, specify None as the value of the user API key.
Customer API Key
The Customer API key to read data from the HR, Payroll, Talent, Benefits, or Integration Events module.
To get the customer API key, navigate to Dashboard > Service Accounts graphic tile > UKGPro > Menu > Administration > Integration Studio > Integration Studio.
Application Module
Determines the type of objects that you can access through the connection.
You can select from the following modules to access data from UKGPro:
HR, Payroll, Talent, and Benefits
Access HR, Payroll, Talent, and Benefits objects.
Integration Events
Access the Integration Events object to read subscribed Integration Events, such as the date and time of the completed events.
Other
Access Time Management objects.