> ## Documentation Index
> Fetch the complete documentation index at: https://help-empuls.xoxoday.com/llms.txt
> Use this file to discover all available pages before exploring further.

# UKG Pro

> Learn how the UKG and Empuls Integration works and helps automate Employee Engagement, Recognition & Rewards

## Before You Begin

You'll need admin access to both UKG Pro and Empuls. Obtain your UKG Pro API credentials from the UKG Pro admin console.

## Why this Integration?

This integration automates user account management processes in Empuls based on employee data available in your UKG Pro account.

With this integration, you can:

* Add new employees to Empuls automatically when their UKG Pro profile is created.
* Edit existing employee data in Empuls simply by updating their UKG Pro profile.
* Remove exited employees from Empuls based on their exit date/status in UKG Pro.

Once this integration is enabled, the data will sync once every 24 hours between Empuls and your UKG Pro account.

## How to set up this integration?

<Steps>
  <Step title="Log in to your Empuls account">
    Log in to your Empuls account.
  </Step>

  <Step title="Go to Admin Dashboard by clicking on Reports">
    Go to **Admin Dashboard** by clicking on "**Reports and Admin**".
  </Step>

  <Step title="Navigate to Integrations">
    Navigate to "**Integrations.**"
  </Step>

  <Step title="Navigate to the HRMS Applications section and click">
    Navigate to the **HRMS Applications** section and click on the **UKG Pro app**.
  </Step>

  <Step title="Click on the Add UKG Pro button">
    Click on the "**Add UKG Pro**" button to start the integration.
  </Step>

  <Step title="Enter your UKG Pro account API credential">
    Enter your UKG Pro account API credential, which includes the API username, password, key, and your UKG Pro URL. Click on the "Test Connection & Proceed" button to verify your UKG Pro account connection.

    <Frame>
      <img src="https://mintcdn.com/empuls/q51axUBYAOtnfX7W/images/integrations/ukg-pro-1.png?fit=max&auto=format&n=q51axUBYAOtnfX7W&q=85&s=927be4b6cb6ed7a270213c722ad1271b" alt="Ukg Pro 1" width="813" height="128" data-path="images/integrations/ukg-pro-1.png" />
    </Frame>

    **Note:** We need the following permissions on the UKG Service account. All the permissions are "View" only.

    1. Company Configuration Integration
    2. Employee User-Defined Fields
    3. Employee Person
    4. Employee Contact
    5. Employee Employment Information
    6. Employee Termination
    7. Employee Export
    8. Employee Person Details
  </Step>

  <Step title="This step allows you to select the data">
    This step allows you to select the data to be uploaded to your Empuls account.

    Data can be mapped for multiple fields like

    1. First name
    2. Last name
    3. Official email
    4. Employee code/ID
    5. Grade
    6. Department
    7. Designation
    8. Date of birth
    9. Date of Joining
    10. Mobile number
    11. Business Unit
    12. Cost center
    13. Location
    14. Contact/Mobile number, and many more

    * Select the data fields to be imported into Empuls. All the fields are selected by default. You may uncheck the boxes to deselect specific fields. For example, Uncheck the Work Contact Number fields if you do not wish to share this information with Empuls. A few fields, like the First Name, email ID, and Status, are mandatory, so they cannot be unchecked.
    * Map the data fields on your UKG Pro account to the correct fields on Empuls to configure the platform according to your needs.
    * Select the date format for the **Date of Joining** and **Date of Birth** fields to ensure that dates are updated correctly on Empuls.
  </Step>

  <Step title="Download data to validate">
    Admins can download employee data in CSV format before uploading to Empuls to validate that the data fields are mapped and no record is repeated.

    <Frame>
      <img src="https://mintcdn.com/empuls/q51axUBYAOtnfX7W/images/integrations/ukg-pro-2.png?fit=max&auto=format&n=q51axUBYAOtnfX7W&q=85&s=9327a59c0b915cdf8a6434e0e7495bd6" alt="Ukg Pro 2" width="1049" height="353" data-path="images/integrations/ukg-pro-2.png" />
    </Frame>
  </Step>

  <Step title="In this step, you can choose between two">
    In this step, you can choose between two data sync options:

    * Run Date Sync Once Now: Select this option to launch Empuls platform and create accounts for all employees and send invites immediately.
    * Schedule First Data Sync for Later: Select this option to schedule employee account creation to a later date and time. This option will help you plan and execute employee account creation on Empuls to coincide with your internal launch announcements.

    Click on\*\* Save & Finish\*\* to complete your integration setup.
  </Step>
</Steps>

## How to stop data sync with your UKG Pro account?

Based on the period you wish the data sync to be stopped, there are two ways to achieve this. Refer to the Temporary and permanent changes below.

**1. Temporarily Disable Data Sync with UKG Pro**

<Steps>
  <Step title="Log in to your Empuls account">
    Log in to your Empuls account.
  </Step>

  <Step title="Click on Settings from the left-hand menu">
    Click on **Settings** from the left-hand menu.
  </Step>

  <Step title="Navigate to the Other Settings section and click">
    Navigate to the **Other Settings** section and click on **Integrations**.
  </Step>

  <Step title="Navigate to the Active Integrations section and click">
    Navigate to the \*\*Active Integrations \*\*section and click on **the UKG Pro app**.
  </Step>

  <Step title="Scroll down to see the ellipses (i.e., three">
    Scroll down to see the ellipses (i.e., three dots) icon. Click on the icon to get the option to **Disable UKG Pro** to turn off your data sync with UKG Pro.

    **2. Permanently Disable Data Sync with UKG Pro**
  </Step>

  <Step title="Log in to your Empuls account">
    Log in to your Empuls account.
  </Step>

  <Step title="Click on Settings from the left-hand menu">
    Click on **Settings** from the left-hand menu.
  </Step>

  <Step title="Navigate to the Other Settings section and click">
    Navigate to the **Other Settings** section and click on **Integrations**.
  </Step>

  <Step title="Navigate to the Active Integrations section and click">
    Navigate to the \*\*Active Integrations \*\*section and click on **the UKG Pro app**.
  </Step>

  <Step title="Scroll down to see the button Remove UKG">
    Scroll down to see the button **Remove UKG Pro**. Click this button to turn off your data sync with UKG Pro permanently.

    <Note>Note: You can re-enable your data sync by following the instructions in "How to set up this integration?"</Note>

    **Where to find this in the platform?**
    ​
    Next Steps

    Run a validation test with a small data sample before full import. Review any validation errors and clean data as needed.
    ​
  </Step>
</Steps>
