Prerequisites for different Biometric Integration Methods

Discover the prerequisites for biometric integration in Keka HRMS. Learn how to set up and integrate biometric devices for efficient attendance tracking.

TABLE OF CONTENTS

• Required System Configuration
• Standard Prerequisites for SQL, SDK, and PUSH Integration Methods
• Integration Specific Requirements
  • MS-SQL Based Integration
  • Push Based Integration
  • SDK Based Integration
  • API Based Integration

This article will provide a detailed overview of the system requirements, integration prerequisites, and specific requirements based on the integration method used, whether it's SQL, SDK, PUSH, or API based.

Before beginning the integration process, please ensure that your system meets the minimum requirements as below in order to ensure the smooth and seamless operation of the Keka Sync tool: 

1. Operating System: Windows 10
2. Processor: Intel Pentium 4 or higher
3. RAM: 4 GB or higher
4. Disk Space: Approximately 500GB or higher

Standard Prerequisites for SQL, SDK, and PUSH Integration Methods

Before moving forward with any of the three aforementioned integration methods, it is essential to verify the following:

1. All biometric devices intended for integration are connected to your LAN network.
2. The system or PC, in which the Keka Sync tool will be installed, should stay 'powered on' and maintain a constant internet connection for uninterrupted synchronization.
3. Biometric devices are displaying the correct date and time to ensure accurate logs in Keka.
4. The attendance numbers listed in Keka align with those in the biometric devices.
5. Office premise's time zone matches the time zone setting in the device.
6. In the presence of a network firewall, add the host as a.keka.com and ports as 80 or 443 to the exception list.
7. Install 'Anydesk' for a remote connection to your PC.

Integration Specific Requirements
MS-SQL Based Integration

Currently, Keka only supports MS-SQL based integration. In order to have a quick and seamless SQL-based integration setup, in addition to the standard prerequisites, please keep the following information handy before our integration call:

1. Server Name (Mandatory)
2. Database Name (Mandatory)
3. Authentication type (MS-SQL) (Mandatory)
4. Username (Mandatory)
5. Password (Mandatory)
6. Table Name (Mandatory)

The Table Columns should be structured as follows:

1. Device Number (Data Type (varchar 64), Not Null): This is the column containing the device number of the Biometric device.
2. User ID (Data Type (varchar 64), Not Null): This column contains the attendance numbers of the organization.
3. Log Time (Data Type (datetime), Not Null): This column contains the attendance entry (or) log.
4. Status (Data Type (varchar 64), Not Null): This column contains the direction of the log, IN or OUT (0 indicates IN and 1 indicates OUT log).
5. Log Index (Data Type INT IDENTITY): This column contains the index of the total logs in the table.

Here's how the tables should look for both device configurations (1 Device for In & Out, Multiple Devices for In & Out)

Single Device Table View:

Multi-Device Table View:

Push Based Integration

In order to have a quick and seamless push-based integration setup, in addition to the standard prerequisites, please keep the following information handy before our integration call: 

1. Biometric Device Images (Mandatory)
2. Device Name (Not Mandatory if Device Image is shared)
3. Model Number (Not Mandatory if Device Image is shared)
4. Serial Number (Mandatory) - You can access the serial no. of the device from Menu > System info > Device Info.
5. IP Address of all Biometric devices (Mandatory): Please set the device IP address via Menu > Comm. > Ethernet

Important: configurations In addition to keeping the above information handy, please ensure that the following configurations are done in your device:

1. Enable domain name in Menu > comm > Cloud Server Settings
2. Set server address to a.keka.com in Menu > Comm. > Cloud Server Settings

SDK Based Integration

In order to have a quick and seamless SDK-based integration setup, in addition to the standard prerequisites, please keep the following information handy before our integration call: 

1. Biometric Device Images (Mandatory)
2. Device Name (Not Mandatory if Device Image is shared)
3. Model Number (Not Mandatory if Device Image is shared)
4. Serial Number (Mandatory) - You can access the serial no. of the device from Menu > System info > Device Info.
5. IP Address of all Biometric devices (Mandatory): Please set the device IP address via Menu > Comm. > Ethernet

API Based Integration

In order to have a quick and seamless API-based integration setup, please keep the following information handy before our integration call:

1. Number of Devices
2. Device Names
3. Device Images
4. Device Manufacturer Names

We have also published a detailed API Guide for Attendance Log Ingestion to walk you through the API Integration. You can access it here.