Connection for Zoho API Integration¶
Zoho People is a Cloud-based Human Resource Management system provided by Zoho, that manages all the employee related information. In addition to the Data Extract method, Hire2Retire provides an API-based approach to facilitate integration between Zoho and Directory Services.
Create a connection¶
-
To authenticate your account you need to click the
Link account
button, which will redirect you to the Zoho sign-in page. -
Here, you will need to enter the credentials of your Zoho organizational account. The account should have the organization's admin access. It is suggested to use a service account.
-
Following successful login or signup, Zoho presents you with a permissions page. On this page, you will be asked to provide certain permissions that are required by Hire2Retire to perform its tasks. These actions typically include editing, and fetching the employee records.
-
Once you've consented to the permissions, you will be redirected back to Hire2Retire. This redirection signifies the successful establishment of the connection between the two platforms.
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
- HR to AD Profile Map
- Lifecycle Business Rules
- Employment Status
- Organizational Unit Assignment - Only defined in on-premise Active Directory
- Group Memberships
- Security Group Memberships
- Distribution List Memberships
- Microsoft 365 Groups Memberships Only defined in Hybrid (with Exchange Online Services) and Entra ID
- Entra ID Distribution List Memberships Only defined in Entra ID and Hybrid, when Exchange Online Services is configured
- Entra ID Security Groups Only defined in Hybrid (with Enable Entra ID Security Groups) and Entra ID
- Mail Enabled Security Group Memberships Only defined in Entra ID and Hybrid, when Exchange Online Services is configured
- Mailing List Assignment Provided in Google Directory
- Communication Hub
Deployment¶
Once your workflow has been setup, you have two optional features you can setup before deploying it.
- Compliance and Audit Trail
- Run Mode
- Error Notifications
- Monitor Receipt of Scheduled HR Extract
- Environment
Otherwise, you can proceed to deploy and test it on the Hire2Retire platform, see Deploy and Test Flow