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 the tasks. For more information about how to configure and use the runtime environments, see Runtime environments. |
Username | The user name of the UKGPro service account. Specify one of the following user names:
|
Password | The password of the UKGPro service account. Specify one of the following passwords:
|
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:
|