ZKTeco Biometric Attendance Module Documentation ☰

Introduction

This documentation provides complete guidance on the installation, configuration, and usage of the ZKTeco Biometric Attendance Module for Perfex CRM. This module allows administrators to seamlessly integrate hardware biometric attendance devices with the CRM for automated real-time logging, staff mapping, and comprehensive attendance tracking.


Designed as a plug-and-play add-on utilizing ADMS push mode, this module eliminates manual record-keeping by automatically synchronizing device punches, detecting late arrivals, early exits, half-days, and calculating working hours variance (+/-). Administrators can monitor daily logs, generate advanced date-filtered reports, and manage shift configurations directly within the CRM interface while maintaining high system performance and reliability.

System Requirements

  • Perfex CRM v3.1.0 or higher

Installation

Installing the module is quick and simple, It takes just a few minutes :

  • Extract the main .zip file and locate the biometric_attendance.zip file.
  • Log in to the Perfex CRM admin panel as an administrator and go to Setup → Modules.
  • Click Choose File and select the biometric_attendance.zip
  • Click Install to complete the process.
Module Installation

Once the module is installed, it will appear in the list of available modules below. Simply click the Activate button to enable it.

Module Activation

Configuration :

To establish seamless real-time synchronization between your physical ZKTeco biometric hardware and Perfex CRM, you must configure the ADMS (Automatic Data Master Server) or Cloud Server communication settings directly on your biometric device or its local management console.


Navigate to your ZKTeco machine's communication or network menu, locate the Server URL / ADMS setting, and enter your CRM's push data endpoint. The endpoint URL follows this standard structure:
https://yourdomain.com/biometric_attendance/api/cdata


Once saved and connected, the biometric device will automatically push all real-time punch logs and attendance events back to your Perfex CRM instance, enabling the system to process daily check-ins, late entries, early exits, and hour variances instantly.

Usage

The ZKTeco Biometric Attendance Module adds a comprehensive management suite directly into your Perfex CRM sidebar, allowing administrators to monitor attendance, link physical hardware IDs to CRM staff members, and track daily workforce metrics effortlessly.


1. Staff Mapping

Before attendance records can be processed, physical users from your biometric device must be linked to your CRM staff members. Navigate to the module's Staff Mapping section to assign each device user (identified by their User PIN or Enrollment ID) to the correct active staff member in Perfex CRM. This ensures that incoming punches map accurately to the right individual.


2. Dashboard & Today's Attendance

The main dashboard provides an instant, real-time snapshot of today's workforce activity. It automatically lists all active staff members for the current day, displaying:

  • Check-In / Check-Out Times: Formatted cleanly (e.g., 1 Nov 2026 9:15 AM) or showing active working status.
  • Last Activity: The timestamp and specific device serial number of the staff member's most recent punch.
  • Absent Detection: Automatically flags staff who have not checked in yet for the day.

3. Advanced Attendance Reports

For historical analysis, the Reports section offers advanced filtering capabilities:

  • Date Range Filters: Select custom start and end dates.
  • Status Filtering: Filter logs instantly by all, present, absent, or late.
  • Staff Filtering: Select specific staff to check their log.

Support

For support, please reach out to us at codeonstring@gmail.com. We will respond as soon as possible, typically within one working day.

Changelog

VERSION 1.0.0 – Initial Release