Skip to content

Ceridian (API-Integration)

Introduction

Ceridian is a cloud-based HCM platform that offers a comprehensive solution for managing various aspects of HR, including payroll, benefits, workforce management, and talent management. This platform assists in handling every stage of an employee's journey, from recruitment and onboarding to compensation and career development.

Getting Your HR Data

Hire2Retire is a pre-packaged integration solution for managing the employee lifecycle. This product takes the input as employee data and syncs the data in AD by applying all the rules and transformation logic configured by the customer while setting up the flow.

To process data from Ceridian using Hire2Retire, please ensure that you have granted the necessary permissions.

Required Permissions

Please update the necessary permissions for the user's specified role by following these steps:

Step 1: Configure Feature Access

  1. From the hamburger button on the top left of your screen, click on System Admin > Roles

    Connection page

    Figure 1. Configure Feature Accesss

  2. Navigate to "Features" tab. Ensure that "Web Services" under "HCM Anywhere" both are marked check.

    Connection page

    Figure 2. Configure Feature Accesss

  3. Expand "Web Services" and make sure to check "Read Data".

    If you want to use WriteToHR feature, ensure that "Patch/Post Employee HR Data" is checked.

    ​Connection page

    Figure 3. Configure Feature Accesss

Step 2: Configure Field-Level Access

  1. Navigate to "Web Services Field-Level Access" and select the "RESTful Services" option

    Connection page

    Figure 4. Select Web Services Field Level Access

  2. Click on "Human Resources" and expand "Employee".

    Connection page

    Figure 5. Select Human Resources Section

  3. Scroll to the very last one and ensure "XRefCode" is enabled and also check all the attributes which you want to configure on Hire2Retire portal.

    Connection page

    Figure 6. Enable Employee XRefCode.

    ​Connection page

    Figure 7. Enable Employee Attributes.

Step 3: To sync employment status of an employee, click on the "Authorizations" tab and check "Employment Status" > "Can Read" checkbox.

Create a Connection

Hire2Retire requires the following details to create a connection with your Ceridian server:

  • Connection Name - A user-defined nomenclature for your connection. By default, the connection name is "Connection-TokenBasedAuth", you can change the name as per your preference.

  • Environment - The specific Ceridian Dayforce environment, such as Production, Staging, or Development.

  • Company Host - The server or network location where the company's data and services are hosted.

  • Username - Name of the Dayforce user dedicated to Web service calls.

  • Password - Password of the specified user.

  • Company Namespace - Uniquely identifies the client's Ceridian Dayforce instance and is needed to log in.
    Connection page

Figure 8. Ceridian Connection Set Up page - Create Connection

Configuration

Once you have successfully configured the connections, you can continue with the Design section to configure the rest of the workflow following these steps in order.

  1. Ceridian Report Definition
  2. Lifecycle Business Rules
  3. Employment Status
  4. HR to AD Profile Map
  5. Organizational Unit Assignment - Only defined in on-premise Active Directory
  6. Security Group Assignment
  7. Distribution List Assignment
  8. Communication Hub

Deployment

Once your workflow has been setup, you have two optional features you can setup before deploying it.

Otherwise, you can proceed to deploy and test it on the Hire2Retire platform, see Deploy and Test Flow