Connections > UltiPro connection properties
  

UltiPro connection properties

When you set up an UltiPro connection, you must configure the connection properties.
The following table describes the UltiPro connection properties:
Property
Description
Connection Name
Name of the connection.
Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -,
Maximum length is 255 characters.
Description
Description of the connection. Maximum length is 4000 characters.
Use Secret Vault
Stores sensitive credentials for this connection in the secrets manager that is configured for your organization.
This property appears only if secrets manager is set up for your organization.
This property is not supported by Data Ingestion and Replication and the Data Access Management services.
When you enable the secret vault in the connection, you can select which credentials that the Secure Agent retrieves from the secrets manager. If you don't enable this option, the credentials are stored in the repository or on a local Secure Agent, depending on how your organization is configured.
Note: If you’re using this connection to apply data access policies through pushdown or proxy services, you cannot use the Secret Vault configuration option.
For information about how to configure and use a secrets manager, see Secrets manager configuration.
Runtime Environment
The name of the run-time environment where you want to run tasks.
For more information about how to configure and use the runtime environments, see Runtime environments.
Password
The password of the UltiPro 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 UltiPro.
  • - To read Time Management data, specify the ODataService password associated with UKG support.
Username
The user name of the UltiPro 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 UltiPro.
  • - To read Time Management data, specify the ODataService user name associated with UKG support.
Service Host Name
The organization domain of UltiPro to read data from the HR, Payroll, Talent, Benefits, or the Integration Events module.
To get the service host name, navigate to UltiPro > 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.
Customer API Key
The Customer API key when you want 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 > UltiPro > Menu > Administration > Integration Studio > Integration Studio.
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 UltiPro > 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.
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 Ultipro:
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.