Integration Using API Method

The below mentioned API can be used to push attendance data to Zoho People application directly from the biometric application. Configuration of the same has to be taken care of from the client’s end (either by the biometric vendor or by the client's IT team). Kindly check the feasibility of this method with the biometric vendor. 

API link: https://www.zoho.com/people/api/attendance-bulkimport.html

This API has a threshold limit of 10 requests/minute and a lock period of 5 minutes.

Integration Using Plugin Method

Terminologies 

It is important to have an IT person or your biometric vendor at your side to proceed with the integration.

Query Requirements

1. If the Downloaddate column is not available in the table, then we can’t assure that all the data from the SQL DB will get pushed to Zoho People, and there might be a possible chance of data loss.
2. If there are multiple shifts for your employees, all of them should be mapped in Zoho People.
3. If the biometric ID is different from the Zoho People employee ID, then the biometric ID has to be mapped in Zoho People under Operations > Attendance > Biometric ID Mapping.
4. The integration is fully dependent on the server system where the biometric data is stored. If it crashes or reboots due to improper shutdown of the system, it may corrupt the configuration page. In such a scenario, we will have to reconfigure the integration.
   

Software Required

1. Apache Tomcat 9 - https://tomcat.apache.org/download-90.cgi (Windows service installer)
2. Java - https://www.openlogic.com/openjdk-downloads (latest version and as per OS)
   

It is mandatory to have your biometric vendor/IT team at the time of integration.

Procedure

Ensure Java and Tomcat applications are downloaded and installed. Check under Local disc C > Program files or Program files (86) > whether JAVA/Tomcat is installed. If not, install both the software.

Tomcat Setup

1. Service Name: Tomcat8ZohoPeople
2. Shutdown Port: 8989
3. Connector Port/Tomcat Server Port: 8584 (check if this port no is not used in any other service)
4. Kindly select the Open Logic Java file path: Under C drive > Program Files/ Program Files X86/ Open Logic/ jdk <version>
5. Start-up Type: Start > Search Service > Tomcat8Zoho (right click) > Properties > Startup Type > Automatic
   

War File Installation

1. Click on the below link to download the war file.
   https://www.zoho.com/people/downloads/ZAttendance.war
2. Navigate to Local disc C > Program file > Apache software foundation > Tomcat8 > Web apps > Paste the war file > refresh > File will be extracted.
3. Routing to plugin page Check whether you're able to load the plugin page via the URL - http://localhost:8584/ZAttendance

1. Click on the Configure button in the top right corner of the plugin page to open the configuration page and select the database type.
   
   
2. Copy and paste the example connection URL given below the field and update the database name.
   
   
   Change the port number of the database instance accordingly.
   If MS SQL: Navigate to Program file C > Windows > Syswow64 > sql_server_manager > SQL server network.
   configuration > Protocol SQLExpress > TCP/IP > IP Address > TCP port: 1433 port > Apply > Ok.
   
   (OR)
   
   Navigate to Start > Search > Computer management > SQL Server network management or
   Configuration (second option on left ) > TCP/IP > IP Address > TCP port: 1433 port > Apply > Ok.
   
   
   If MySQL - Default port number is 3306.
   
   
   If MS ACCESS - Add the database path and change the forward slashes to backward slashes.
   
   
3.  Add the database username and password. If MySQL, the default username is "root" and for MS ACCESS is "admin".
   
   
4. Add the Delay Time and Sleep Time as 5 minutes (minimum suggested time).
   
   
5. SQL query configurations.

   
   

   If all columns are as per the requirement:

   Static Table:

   select [employeeID] as employeeId, ischeckin as isCheckin, [eventTime] as eventTime, [download-Date] FROM [ZAttendance].[dbo].[Att-checkin] where DownloadDate>=$1 and DownloadDate<$2

   
   

   Dynamic Table:

   select [employeeID] as employeeId, ischeckin as isCheckin, [eventTime] as eventTime, [Down-loadDate] FROM #Tablename_%M_%Y# where DownloadDate>=$1 and DownloadDate<$2

   
   

   When the download date column is not available: (Delay time should be 1-2 hours):

   
   

   select [Id] as employeeId, case [Checkin] when 'IN' then 1 when 'OUT' then 0 end as isCheckin, [EventTime] as eventTime FROM [ZAttendance].[dbo].[Att-checkin] where eventTime>=$1 and eventTime<$2

   
   

   When IN/OUT direction differentiation is not specified in the table:

   
   

   Push each punch as both IN & OUT to ZOHO:

   
   

   select [empid] as employeeId, '1' as isCheckin, [EventTime] as eventTime, [downloaddate] FROM [ZAttendance].[dbo].[Att_noCheck] where DownloadDate>=$1 and DownloadDate<$2

   UNION

   select [empid] as employeeId, '0' as isCheckin, [EventTime] as eventTime, [downloaddate] FROM [ZAttendance].[dbo].[Att_noCheck] where DownloadDate>=$1 and DownloadDate<$2
   
   
   (OR)

   
   Alternate In & Out Punches:

   
   

   select [Id] as employeeId ,[EventTime] as eventTime ,[DownloadDate] FROM

   [ZAttendance].[dbo].[Att-checkin] where DownloadDate>=$1 and DownloadDate<$2

   
   

   Tomcat > config.properties > url should be changed to bulkImportRawEntry instead of bulkImport.
   
   
6. Generate Auth tokens:

   Go to api-console.zoho.in (or com/eu - based on the DC). Create a Self Client client type, copy Client ID and Client Secret and paste it in the Plugin page.
   

   
   

   Generate a code under Generate Code tab,

   Scope: ZohoPeople.attendance.all

   Duration: 10 minutes

   Description: BI

   
   

   Generate Refresh Token: Paste the Client ID / Client Secret / CODE / > Select the DC >

   Generate > copy and paste it in the Refresh Token field.

   
   

   Make sure that the tokens were generated using an admin account where Zoho Role/Role is marked as "admin" under the profile.
   
   
7. Update Time Zone: Select your location’s time zone. Ensure the time zone of the attendance data in the database and the admin account's time zone are the same.

   
   
8. Manual testing and pushing: For testing, sync any one employee's data. Change the downloadDate column's name to the EventTime column's name in the SQL query after the where condition and add the employee ID filter as mentioned below.
   

   
   

   select [Id] as employeeId, [Checkin] as isCheckin, [EventTime] as eventTime , [DownloadDate] FROM [ZAttendance].[dbo].[Att-checkin] where Even-tTime>=$1 and EventTime<$2 and Id=‘1001’

   
   

   In Manual sync tab, click on 'Get record count' and fetch and upload to pull and push the data to Zoho People.
   
   
9. Once testing is done, automate the sync by clicking Resume sync in the plugin page.
   
   
10. Bookmark the URL for future reference and take a backup of the config.xml file outside the Tomcat folder.

Q/As and Common Issues Fixes