UKG Pro (Ultimate Software UltiPro)
  • 14 Jun 2022
  • 3 Minutes to read
  • Dark
    Light
  • PDF

UKG Pro (Ultimate Software UltiPro)

  • Dark
    Light
  • PDF

UKG Pro (formerly Ultimate Software UltiPro) is cloud-based human capital management (HCM) software.

Types of Assets Fetched

This adapter fetches the following types of assets:

  • Users

Parameters

  1. Domain (required, default: https://service2.ultipro.com) - The base URL of the UKG Pro system.

  2. User Name and Password (required) - The credentials for a web service account that has the permissions to fetch assets. For more information see Service Accounts

  3. US Customer API Key (required) - An API Key associated with a web service account that has permissions to fetch assets.

  4. Verify SSL (required, default: false) - Select to verify the SSL certificate offered by the value supplied in Domain. For more details, see SSL Trust & CA Settings.

  5. HTTPS Proxy (optional, default: empty) - A proxy to use when connecting to the value supplied in Domain.

    • When supplied, Axonius uses the proxy when connecting to the value supplied in Domain.
    • When not supplied, Axonius connects directly to the value supplied in Domain.
  6. HTTPS Proxy User Name (optional, default: empty) - The user name to use when connecting to the value supplied in Domain via the value supplied in HTTPS Proxy.

    • When supplied, Axonius authenticates with this value when connecting to the value supplied in HTTPS Proxy.
    • When not supplied, Axonius does not perform authentication when connecting to the value supplied in HTTPS Proxy.
  7. HTTPS Proxy Password (optional, default: empty) - The password to use when connecting to the value supplied in Domain via the value supplied in HTTPS Proxy.

    • When supplied, Axonius authenticates with this value when connecting to the value supplied in HTTPS Proxy.
    • When not supplied, Axonius does not perform authentication when connecting to the value supplied in HTTPS Proxy.
  8. To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.

UKGAdapter.png


Advanced Settings

Note:

From version 4.6 Advanced settings can either apply for all connections for this adapter, or you can set different advanced settings and/or different scheduling for a specific connection, refer to ​Advanced Configuration for Adapters

  1. Fetch person details *(optional, default: true) - Select whether to fetch information about person details as users.
    • If enabled, all connections for this adapter will also fetch information about person details for each user.
    • If disabled, all connections for this adapter will not fetch information about person details for each user.
  2. Fetch employee details (optional, default: false) - Select whether to fetch information about employee details for each user.
    • If enabled, all connections for this adapter will also fetch information about employee details for each user.
    • If disabled, all connections for this adapter will not fetch information about employee details for each user.
  3. Ignore employees with termination date greater than X days (optional, default: 90) - Ignore employees with a termination date greater than the number of days set. This only applies to employees fetched from Fetch employee details .
    • If enabled, all connections for this adapter will ignore employees with the termination date greater than the date set.
    • If disabled, all connections for this adapter will fetch all employee data.
  4. Field(s) to exclude (optional, default: empty) - Specify fields to exclude from the Basic and Advanced views, such as fields containing sensitive data or fields that display irrelevant information. To specify multiple values, separate them by a comma.
    • If fields from the Advanced view are specified, these fields will be excluded from data fetched from the Basic and Advanced views.
    • If fields are not specified, all fields from the UKG Pro API will be fetched and displayed accordingly.
Note:
  • Make sure that the specified fields are only from the Advanced view. Adding field names only displayed in the Basic view will not exclude them from the fetch.
  • The specified names must be in the raw values from the API response.
  • Fields from the Advanced view that are added to the Field(s) to exclude parameter will not fetch data from Basic and Advanced views.


Note:

To learn more about general advanced settings under the Adapter Configuration tab, see Adapter Advanced Settings.


APIs

Axonius uses the UKG Pro API.

Required Permissions

The value supplied in API Key must be associated with credentials for the UltiPro service account that have the "View" role for the "Employee Person Details" Web Service and "View" role for the EmployeeExport Web Service.



First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.