Skip to main content

Varicent ELT Assistant

UKG Pro

Connect your Varicent ELT and UKG Pro accounts to import your data.

  1. In Varicent ELT, select the Data module from the sidebar navigation pane.

  2. Click Import data.

  3. In the Third party sources section, under the Available section, click UKG.

  4. On the Connect to your API page, under Connector name, enter the name of the connection.

  5. Under the Authentication method drop-down list, select the desired method to authenticate:

    • None: There is no authentication required.

    • Basic: A username and password pair. This is commonly used if the system uses basic HTTP authentication.

    • API Key: If UKG Pro provides an API key for authentication, use this method. Add the API Key generated from UKG Pro.

    • OAuth client credentials: Enter the Authentication URL, Token type, Scope Key and Secret.

    • OAuth client code: Enter the Third-party authentication URL, Access token URL, Scope, Client ID and Client secret.

  6. In the Endpoint URL field, enter the base URL for the UKG Pro API, such as https://api.ukg.com/v1/.

    Note

    Ensure that you confirm with your UKG team the proper URL to use.

  7. In the Path to data field, enter the specific endpoint path that you want to pull data from. For example, if you want to pull employee data, the endpoint path would be /employees. Some other example paths are: /timecards and /payrolls.

  8. Select the Flatten checkbox if each row of data that is being returned from the API, at the path that you specified in Path to data, is formatted as a multi-level object, and should be flattened to a single-level object before being processed.

  9. In the Table key field, enter the name of the identifier or key column in your expected data, such as  EmployeeID or TimeCardID.

  10. Under the Pagination drop-down list, select one of the following pagination types:

    • None: Select this option if you do not want to paginate your data.

    • Cursor: Select this option if your UKG API supports cursor-based paging.

      • Page size: The number of entries that you want in each page.

      • Request page size label: The name of the field that specifies the page size in requests to the UKG API.

      • Request cursor label: The name of the field that specifies the cursor value in requests to the UKG API. Cursor values are taken from the column given in the Table key.

      • Last page error code: The HTTP error code that is provided in the API response after the last page of data is retrieved.

    • Offset: Select this option if the UKG API supports paging where you can specify the page size.

      • Page size: The number of entries that you want in each page.

      • Request page size label: The name of the field that specifies the page size in requests to the UKG API.

      • Path to offset: A JSONPath formatted string that locates the current offset amount from the payload returned from the UKG API. Learn more.

      • Request offset label: The name of the field that specifies the offset in the request to the UKG API.

      • Last page error code: The HTTP error code that is provided in the API response after the last page of data is retrieved.

    • Paged: Select this option if the UKG API supports basic pagination.

      • First page number: The page number that you want to retrieve first. Pages occurring before this number are not retrieved.

      • Request page label: The name of the field that specifies the page number in requests to the UKG API.

      • Last page error code: The HTTP error code that is provided in the API response after the last page of data is retrieved.

Example API configuration

Let’s say you’re using the API Key authentication and want to pull employee data from UKG Pro. Your configuration might look the following configuration:

  • Authentication method: API Key

  • API Key: <Your API Key here>

  • Endpoint URL: https://api.ukg.com/v1/

  • Path to Data: /employees

  • Table Key: EmployeeID

  • Pagination: Paged

This configuration authenticates via API key, pulls data from the /employees endpoint, uses EmployeeID as the unique key for the records, and handle large datasets with paged pagination.