How to Set Up Facial Recognition Attendance Machine and Integrate It with uKnowva HRMS?

Introduction

Facial recognition attendance has become one of the most reliable and contactless methods for recording employee attendance. Instead of relying on biometric fingerprints, RFID cards, or manual attendance registers, employees simply authenticate themselves using facial recognition. The attendance machine captures their check-in and check-out records, ensuring faster attendance marking while reducing the chances of proxy attendance and manual errors.

However, setting up a facial recognition attendance system involves more than just installing the device. The attendance machine must communicate with a database, and the attendance data stored in the database must then be synchronized with your uKnowva HRMS instance. This integration ensures that attendance records captured by the device automatically appear in the HRMS portal without requiring manual imports.

In this article, you will learn how to connect the facial recognition device to your network, register employees, configure the SQL Server database, set up the Sync Tool, and automatically synchronize attendance records with uKnowva HRMS.

Overview

The uKnowva HRMS Attendance Sync solution automatically transfers attendance records from your attendance device to your uKnowva HRMS instance. The deployment consists of three main components that must be configured in sequence:

  • Attendance Device – Captures employee attendance records.
  • Database (Optional) – Attendance logs may be stored in a database for synchronization. If the device supports direct API integration, the database and Attendance Sync Tool are not required.  Refer to the Attendance Management API guide for API reference and use the /syncattendanceshiftwise/fetchBulkAttendanceFromAttendanceServer endpoint.
  • Attendance Sync Tool – Retrieves attendance data from the database and sends it to uKnowva HRMS using the Attendance API

Before You Begin

Before starting the deployment, make sure you have:

  • A facial recognition attendance device connected to your network.
  • The attendance software and database configured by your attendance machine vendor.
  • Confirmation from the vendor that attendance records are being captured and stored in the database.
  • The uKnowva HRMS Attendance Sync Tool installed.
  • Your uKnowva HRMS API Base URL and Bearer Token.

Prerequisite: Attendance Software Setup

Before proceeding with the uKnowva Attendance Sync integration, the attendance machine must first be connected to the attendance software provided by the respective machine vendor. The vendor will install the required software on the designated system and complete its initial configuration, including the necessary credentials and settings. This is a one-time prerequisite that the vendor will complete before the uKnowva integration begins.

Once this prerequisite is completed, you can proceed with the steps covered in this guide to configure the database connection, Attendance Sync Tool, API configuration, and synchronization with uKnowva HRMS. The remaining steps in this document explain how to complete and configure the uKnowva Attendance Sync integration using the attendance data provided by the vendor's system.

The exact attendance software and its initial setup may vary depending on the attendance machine and vendor. Therefore, the vendor is responsible only for making the attendance system ready, while this guide covers the subsequent integration process with uKnowva HRMS. 

Step 1: Confirm the Attendance Device and Database Setup with the Vendor

Before proceeding with the uKnowva Attendance Sync integration, contact your attendance machine vendor to confirm that the device and its attendance software have been set up correctly. The vendor must complete the initial configuration, including connecting the device to the attendance software and setting up the database to store attendance records. This is a one-time setup that must be completed before you begin the uKnowva integration.

The exact setup and database structure may vary depending on the attendance machine and the software provided by the vendor. Once the vendor confirms that the setup is complete and attendance records are being stored in the database, you can proceed with configuring the Attendance Sync Tool to connect the database with uKnowva HRMS.

The remaining steps in this guide cover the uKnowva Attendance Sync integration, including database connection, API configuration, and automatic attendance synchronization.

Step 2: Configure the Sync Tool Database Connection

After the database is ready, open the Attendance Sync Tool and configure its database connection.

Navigate to the Database tab and enter the SQL Server connection details, including the database type, SQL Server host, port number, SQL login credentials, database name, and SQL Server ODBC driver.

Once all details have been entered, click Test Connection to verify that the Sync Tool can successfully communicate with the SQL Server database.

If the connection is successful, click Save Database Config to save the configuration.

This step establishes communication between the Sync Tool and the database containing attendance records.

If you need detailed instructions for configuring the database connection, refer to the Complete Deployment System Guide for uKnowva HRMS Attendance Sync Application.

Step 3: Configure the API Integration

The next step is to configure the Sync Tool so that it can transfer attendance data from the SQL Server database to uKnowva HRMS.

Open the API Configuration section.

If an API configuration already exists, click on it to select it and then click the Edit Selected button to modify the existing configuration. If no configuration is available, click the Add New API Config button to create a new API configuration.

Under DB Configuration, leave Use Dynamic Table disabled because the integration uses the fixed database view named facial_recognition.

Specify facial_recognition as the fixed table name and leave the Custom SQL field empty, allowing the Sync Tool to automatically retrieve attendance data from the database view.

Configure the synchronization limit according to your organization's requirements. You can specify a maximum number of records to synchronize in each execution or leave it as zero to synchronize all available records.

Step 4: Configure Body Mapping

Body Mapping determines how the database fields are mapped to the fields expected by the uKnowva HRMS attendance API.

Map the employee code field to Empcardno, the attendance date field to Date, and configure the punch type using the facial_recognition literal as specified in the implementation guide.

After configuring each mapping, click Add/Update to save it.

Correct body mapping is essential because the HRMS API uses these mappings to identify employees, attendance dates, and the attendance source.

Step 8: Configure Incremental Synchronization

To prevent duplicate attendance records from being sent repeatedly, configure the Last Run Filter.

Select the Date column as the tracking field.

The Sync Tool automatically stores the last synchronized value after every successful execution. During future synchronizations, it only processes records that were created after the previously synchronized date.

This significantly improves synchronization efficiency while preventing duplicate attendance entries.

Step 5: Configure the HRMS API Details

Next, configure the HRMS API endpoint.

Enter the organisation’s Base URL, specify the attendance synchronization API path, choose the POST request method, and enter the Bearer Token provided for the organisation’s HRMS instance.

Finally, enable the Published option by setting it to Yes.

 

Field

Value

Domain / Base URL

{instance_url} — the organisation’s own portal address

Method

POST

API Path

/api.php/hrm/syncattendanceshiftwise/fetchBulkAttendanceFromAttendanceServer

Authorization

Bearer Token (given for each organisation)

Published

Yes

These settings allow the Sync Tool to securely authenticate with the HRMS portal and upload attendance records automatically.

After completing the configuration, click Apply & Close to save the API settings.

Step 6: Start Automatic Attendance Synchronization

The final step is to start automatic synchronization between the attendance database and uKnowva HRMS.

Return to the main screen of the Sync Tool and configure the synchronization interval according to your organization's requirements. For example, setting an interval of 5 minutes instructs the tool to check for new attendance records every five minutes.

If required, enable Auto-start with Windows so the synchronization service automatically starts whenever the computer restarts.

Before enabling continuous synchronization, click Run Once Now to verify that attendance records are transferred successfully.

If the manual synchronization completes successfully, click Start Auto Sync to begin continuous attendance synchronization.

From this point onward, every new attendance punch captured by the facial recognition device will automatically be synchronized with the uKnowva HRMS portal without requiring manual intervention.

Viewing Detailed Punch Records

To view the detailed records captured from the biometric machines, go to the side navigation panel and click on the Analytics menu. From the available options, select the Reports sub-menu.

On the Reports page, locate the Punchin from Biometric Machine report under the Attendance category.

Click on the report to open it and view the punch records captured from the biometric machine.

Note: If you use multiple biometric machines, the report can be configured to identify the records from each machine separately. This allows you to assign distinct names to the machines and filter the punch records based on the respective machine.

Quick Checklist

Before completing the setup, verify the following:

  • Attendance device is connected to Wi-Fi.

  • Employees are enrolled on the device.

  • TextfileData table is recording attendance logs.

  • facial_recognition view is created.

  • Database connection is configured and tested.

  • API configuration is saved and Published is set to Yes.

  • Auto Sync is running, and Run Once Now test is successful.

Conclusion

That's it!

You've now successfully configured the attendance device, Attendance Sync Tool, and uKnowva HRMS for automatic attendance synchronization.

By following this process, you ensure accurate and automatic attendance synchronization with uKnowva HRMS.

If you have any questions or need additional support, feel free to contact us at This email address is being protected from spambots. You need JavaScript enabled to view it.

Was this Article helpful?