> ## 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 Ready

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

# **Why this Integration?**

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

With this integration, you can:

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

Once this integration is enabled, the data will sync once every 24 hours between Empuls and your UKG Ready 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 Ready app**.
  </Step>

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

  <Step title="Enter your UKG Ready account API credentials">
    Enter your UKG Ready account API credentials, which include the API username, password, key, and Company Short Name. Click on the "Test Connection & Proceed" button to verify your UKG Ready account connection.

    <Note>Need help on getting this information on your UKG Ready account? Read UKG Ready help documentation below the article.</Note>

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

    1. Employee Information
    2. Account/Personal Information
    3. Primary Email
    4. Name
    5. Account status
       ​
       ​The *permissions mentioned above are mandatory. The client can allow more permissions with Account/Personal Information according to their needs.*
       ​
    6. Reports
    7. Export Reports (CSV/text)
  </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.
    * Map the data fields on your UKG Ready 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-ready-1.png?fit=max&auto=format&n=q51axUBYAOtnfX7W&q=85&s=32ed602e0cf0b2088d80af0e5cb97953" alt="Ukg Ready 1" width="1049" height="353" data-path="images/integrations/ukg-ready-1.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 Ready 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 Ready

<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 Settings**".
  </Step>

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

  <Step title="Navigate to the Active Integrations section and click">
    Navigate to the \*\*Active Integrations \*\*section and click on **the UKG Ready 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 Ready** to turn off your data sync with UKG Ready.
  </Step>
</Steps>

## \*\*2. \*\*Permanently Disable Data Sync with UKG Ready

<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 Settings**".
  </Step>

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

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

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

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