Collectors
      Back to home
      1. Knowledge Base
      2. Connect & Transform
      3. Collectors

      UKG Pro (Ultipro) Collectors

      Overview

      DataBlend collects the following UKG data types:

      • Company, "Permissions - UKG Pro service account must have "View" role for the "Company Configuration Integration" Web Service."
      • Earnings "Your UKG Pro service account must have the Get role for the Payroll Integration Web Service."
      • Earnings Configurations, "It is a public API that user can access once they have a valid username and password."
      • Employees "Permissions - UKG Pro service account must have "View" role for the "Personnel Integration" Web Service."
      • Job Codes "Permissions - The Pro service account must have the "View" role for the "Company Configuration Integration" Web Service."
      • Location Configurations "Permissions - Ultipro service account must have "View" role for the "Company Configuration Integration" Web Service."
      • Organization Levels "Permissions - Ultipro service account must have "View" role for the "Company Configuration Integration" Web Service."
      • Project Codes No Permissions specified in the UKG API documentation
      • Reports*
      • Shift Codes "Permissions - UKG Pro service account must have "View" role for the "Company Configuration Integration" Web Service."

      * The Reports Collector collects from BI within UKG not the general reports.  If the report is not setup in BI it will not appear in the collector dropdown.  If you do not currently have access to BI in UKG there are two steps you will need to take:

      1. Open a case with the BI team requesting use of RAAS.  If needed they may also need to assist setting up custom reports in BI.
      2. Create a service account in BI and assign to the user setup

      Configuration

       

      Field

      Required/ Optional

      Comments

      Type

      Required

      UKG Pro (Ultipro)

      Name

      Required

      Descriptive free-text name for the collector

      Data Source

      Required

      Choose a pre-configured data source from the drop down or click Create New to create a new data source.

      Schema Name

      Required

      Enter a name for the schema where the collected data will be stored. This can be a pre-configured schema or a new schema which will be created the first time the collector is run.

      Credential

      Required

      Choose a pre-configured UKG Pro credential from the drop-down.

      UltiPro Collector Type

      Required

      Utilize the pre-populated Collector Type drop-down menu.

      Report

      Dependent

      Choose from the list of Report Names to collect. The list will dynamically appear based on the user’s access via credentials.
       

      To learn more about Ultipro API requirements, please visit UKG Developer Hub.