ADP API Integration Connection¶
ADP (Automatic Data Processing) is a provider of cloud-based human capital management (HCM) solutions to employers. ADP-API will use ADP Rest API to fetch all the employees’ data.
Create a Connection¶
Hire2Retire requires the following details to create a connection with your ADP server:
-
Connection Name - A user-defined nomenclature for your connection. By default, the connection name is "Connection-OAuth Client Cred", you can change the name as per your preference.
-
Client ID - This is the application Client ID to interact with ADP API. You will get the client ID created at the time of your registration on ADP portal.
-
Client Secret - This is the application Client Secret to interact with ADP API. You will get the client secret created at the time of your registration on ADP portal.
-
SSL Client Certificate - This is the SSL client certificate generated on registration with ADP portal. You can find this in cert file (.cer, .pem or .crt.).
-
SSL Client Key - This is the SSL client key generated on registration with ADP portal. You can find this inthe key file (.key).
-
Passphrase - This is the optional field, if you added a password while generating SSL certificate, you have to enter that password here, otherwise leave it blank.
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.
- HR Data Definition
- Lifecycle Business Rules
- Employment Status
- HR to AD Profile Map
- Organizational Unit Assignment - Only defined in on-premise Active Directory
- Security Group Assignment
- Distribution List Assignment
Deployment¶
Once your workflow has been setup, you can optionally setup notifications and archival for your workflow.
Otherwise, you can proceed to deploy and test it on the Hire2Retire platform, see Deploy and Test Flow