How it works
We retrieve data from ADP API https://developers.adp.com/, mainly, if not only, using the Workers V2 endpoint https://developers.adp.com/apis/api-explorer/hcm-offrg-wfn/hcm-offrg-wfn-hr-workers-v2-workers
We extract from that data such as:
- Person’s names
- Contact information
- Birthdate
- Photo
- Work assignments - (start and end dates, department...)
An example of how the real data gets transferred can be found on the workers-v2-api page
Requirements
In order to use ADP API, a CSR (Certificate Signing Request) must be sent to ADP to get credentials. The CSR must be issued by the Customer following the steps on the ADP CSR page.
After issuing the CSR, the customer must have the following data ready to configure on the Cleary platform:
- clientId (E.g. 88a73992-07f2-4714-ab4b-de782acd9c4d - The consumer application's account identifier, assigned during account registration or at secret reset.)
- clientSecret (E.g. a130adb7-aa51-49ac-9d02-0d4036b63541 - The consumer application's account password, assigned during account registration or at secret reset.)
- A certificate PEM file (certificate.pem)
- A certificate KEY file (certificate.key)
- The certificate password
Note: Possibly extra steps are required to give the issued CSR access to the Workers V2 API.
Configure on the Cleary Platform
- Go to the App Integrations page
- Expand "People" section
- Click on "Configure ADP"
-
Fill in the form fields
- For Certificate PEM and Certificate Key fields make sure you open the related files with your text editor and copy/paste the content of them into the form fields
- Save it
Field Mapping
|
Workers (/hr/v2/workers) |
|
|
Cleary field |
ADP field |
|
employee_id |
workerID.idValue |
|
birthday |
person.birthDate |
|
last_name |
person.legalName.familyName1 |
|
first_name |
person.legalName.givenName |
|
start_date |
workerDates.originalHireDate |
|
end_date |
workerDates.terminationDate |
|
city |
person.legalAddress.cityName |
|
country |
person.legalAddress.countryCode |
|
region |
person.legalAddress.countrySubdivisionLevel1.shortName |
|
active |
workAssignments.primaryIndicator.assignmentStatus.statusCode.codeValue |
|
worker_type |
workAssignments.primaryIndicator.workerTypeCode.shortName |
|
manager_employee_id |
workAssignments.primaryIndicator.reportsTo.workerID.idValue |
|
title |
workAssignments.primaryIndicator.jobTitle |
|
office_location |
workAssignments.primaryIndicator.homeWorkLocation.nameCode.shortName |
|
manager |
workAssignments.primaryIndicator.managementPositionIndicator |
|
email_type |
businessCommunication.emails.nameCode.codeValue |
|
|
businessCommunication.emails.emailUri |
|
phone_mobile_type |
person.communication.mobiles.nameCode.codeValue |
|
phone_mobile |
person.communication.mobiles.formattedNumber |
|
personal_email_type |
person.communication.emails.nameCode.codeValue |
|
personal_email |
person.communication.emails.emailUri |
|
hris_external_group_ids |
workAssignments.primaryIndicator.assignedOrganizationalUnits.nameCode.codeValue |
|
|
|
|
Departments (/codelists/hr/v3/worker-management/departments/WFN/1) |
|
|
Cleary field |
ADP field |
|
group_type.name |
codeListTitle |
|
group.external_id |
listItems.codeValue |
|
group.name |
listItems.longName || listItems.shortName || listItems.valueDescription |