ZKBio WDMS User Manual - V1.0
ZKBio WDMS User Manual - V1.0
ZKBio WDMS User Manual - V1.0
User Manual
ZKBio WDMS
Date: December 2021
English
Thank you for choosing our product. Please read the instructions carefully
before operation. Follow these instructions to ensure that the product is
functioning properly. The images shown in this manual are for illustrative
purposes only.
Without the prior written consent of ZKTeco, no portion of this manual can be copied or forwarded in any
way or form. All parts of this manual belong to ZKTeco and its subsidiaries (hereinafter the "Company" or
"ZKTeco").
Trademark
is a registered trademark of ZKTeco. Other trademarks involved in this manual are owned by
their respective owners.
Disclaimer
This manual contains information on the operation and maintenance of the ZKTeco equipment. The
copyright in all the documents, drawings, etc. in relation to the ZKTeco supplied equipment vests in and is
the property of ZKTeco. The contents hereof should not be used or shared by the receiver with any third
party without express written permission of ZKTeco.
The contents of this manual must be read as a whole before starting the operation and maintenance of the
supplied equipment. If any of the content(s) of the manual seems unclear or incomplete, please contact
ZKTeco before starting the operation and maintenance of the said equipment.
It is an essential pre-requisite for the satisfactory operation and maintenance that the operating and
maintenance personnel are fully familiar with the design and that the said personnel have received
thorough training in operating and maintaining the machine/unit/equipment. It is further essential for the
safe operation of the machine/unit/equipment that personnel has read, understood and followed the
safety instructions contained in the manual.
In case of any conflict between terms and conditions of this manual and the contract specifications,
drawings, instruction sheets or any other contract-related documents, the contract conditions/documents
shall prevail. The contract specific conditions/documents shall apply in priority.
ZKTeco offers no warranty, guarantee or representation regarding the completeness of any information
contained in this manual or any of the amendments made thereto. ZKTeco does not extend the warranty
of any kind, including, without limitation, any warranty of design, merchantability or fitness for a particular
purpose.
ZKTeco does not assume responsibility for any errors or omissions in the information or documents which
are referenced by or linked to this manual. The entire risk as to the results and performance obtained from
using the information is assumed by the user.
ZKTeco in no event shall be liable to the user or any third party for any incidental, consequential, indirect,
special, or exemplary damages, including, without limitation, loss of business, loss of profits, business
interruption, loss of business information or any pecuniary loss, arising out of, in connection with, or
relating to the use of the information contained in or referenced by this manual, even if ZKTeco has been
advised of the possibility of such damages.
This manual and the information contained therein may include technical, other inaccuracies or
typographical errors. ZKTeco periodically changes the information herein which will be incorporated into
new additions/amendments to the manual. ZKTeco reserves the right to add, delete, amend or modify the
information contained in the manual from time to time in the form of circulars, letters, notes, etc. for better
operation and safety of the machine/unit/equipment. The said additions or amendments are meant for
improvement /better operations of the machine/unit/equipment and such amendments shall not give any
right to claim any compensation or damages under any circumstances.
ZKTeco shall in no way be responsible (i) in case the machine/unit/equipment malfunctions due to any
non-compliance of the instructions contained in this manual (ii) in case of operation of the
machine/unit/equipment beyond the rate limits (iii) in case of operation of the machine and equipment in
conditions different from the prescribed conditions of the manual.
The product will be updated from time to time without prior notice. The latest operation procedures and
relevant documents are available on http://www.zkteco.com.
ZKTeco Headquarters
ZKTeco is one of the world’s largest manufacturer of RFID and Biometric (Fingerprint, Facial, Finger-vein)
readers. Product offerings include Access Control readers and panels, Near & Far-range Facial Recognition
Cameras, Elevator/Floor access controllers, Turnstiles, License Plate Recognition (LPR) gate controllers and
Consumer products including battery-operated fingerprint and face-reader door locks. Our security
solutions are multi-lingual and localized in over 18 different languages. At the ZKTeco state-of-the-art
700,000 square foot ISO9001-certified manufacturing facility, we control manufacturing, product design,
component assembly, and logistics/shipping, all under one roof.
The founders of ZKTeco have been determined for independent research and development of biometric
verification procedures and the productization of biometric verification SDK, which was initially widely
applied in PC security and identity authentication fields. With the continuous enhancement of the
development and plenty of market applications, the team has gradually constructed an identity
authentication ecosystem and smart security ecosystem, which are based on biometric verification
techniques. With years of experience in the industrialization of biometric verifications, ZKTeco was
officially established in 2007 and now has been one of the globally leading enterprises in the biometric
verification industry owning various patents and being selected as the National High-tech Enterprise for 6
consecutive years. Its products are protected by intellectual property rights.
All figures displayed are for illustration purposes only. Figures in this manual may not be exactly consistent
with the actual products.
Document Conventions
GUI Conventions
For Software
Convention Description
Bold font Used to identify software interface names e.g. OK, Confirm, Cancel.
Multi-level menus are separated by these brackets. For example, File > Create >
>
Folder.
For Device
Convention Description
<> Button or key names for devices. For example, press <OK>.
Window names, menu items, data table, and field names are inside square brackets.
[]
For example, pop up the [New User] window.
Multi-level menus are separated by forwarding slashes. For example,
/
[File/Create/Folder].
Symbols
Convention Description
Table of Contents
8 APPENDICES ...................................................................................................................................... 96
8.1 PERSONNEL SELECTION ................................................................................................................................................................................96
8.2 DATE SELECTION ...........................................................................................................................................................................................97
8.3 IMPORT...........................................................................................................................................................................................................98
8.4 EXPORT ....................................................................................................................................................................................................... 102
8.5 CUSTOM DISPLAY FIELDS.......................................................................................................................................................................... 103
8.6 ADAPTIVE COLUMN WIDTH ...................................................................................................................................................................... 104
8.7 MULTI-LABEL FUNCTION........................................................................................................................................................................... 105
8.8 CUSTOM THEME ......................................................................................................................................................................................... 106
8.9 FILTER SEARCH FUNCTION ........................................................................................................................................................................ 107
8.10 CUSTOM BOOKMARK ................................................................................................................................................................................. 109
8.11 LOG VIEW ................................................................................................................................................................................................... 110
1 System Overview
As a middleware, ZKBio WDMS allows you to deploy on kinds of servers and databases for devices and
transactions management.
ZKBio WDMS provides unified management to customers in terms of time management and operational
safety. It helps the customers to continuously improve safety management by affording a simple and
efficient platform that can manage all the time and security-related aspects at a single instance.
System Features
With a powerful data handling capacity, the system can manage the attendance data of 10,000
employees.
Support multiple companies and dividing administrators with different the permissions.
Automatic user management makes the system more simple and efficient.
The hierarchical management ensures user data security.
The real-time data processing system ensures data availability to the administrators at any time.
The MTD module records the health status of employees.
Software Requirements
Supported Operating Systems: (64-bits) Windows 7/8/8.1/10, Windows Server 2008/2008 R2/
2012/2012 R2/2016/2019.
Supported Databases: PostgreSQL (Default), MSSQL Server2005/2008/2012/2014/2016/2017/ 2019,
Oracle 10g/11g/12c/19c, MySQL 5.0/5.6/5.7.
Supported Mainstream Browsers: IE 11+, Google Chrome 33+, and Firefox 27+.
System Modules
Personnel Module: The Personnel Module sets the company, department, position and area. Enter
employee’s information (personnel information fields support user customization) into the system,
allocating employees to various company, departments and to maintain employee detail. Added the
function of importing and exporting personnel information via USB disk.
Device Module: The Device Module sets the communication parameters to connect the devices. The
communication with the devices will be successful only after the communication parameters are set
properly, including the settings in both the system and devices. Once the communication is
successful, you can view information about connected devices and perform operations such as
remote monitoring, upload, and download.
MTD Module: The MTD Module detects the body temperature and whether the personnel is wearing
a mask. It generates statistic reports about mask and temperature. If there is personnel who has
higher body temperature or does not wear a mask, an email notification will be sent to the personnel
himself, the system superuser and system user who has permission to access the department which
the personnel belongs to.
System Module: The System Module assigns System Users and configures their roles. It sets the
system parameters and manages the system operation logs. By configuring the automatic import
function, users can have the system import personnel information automatically. At the same time,
the biometric templates saved in the software are encrypted to secure employees' personal
information. To avoid information leakage, the export of employee-related data can be password-
protected.
1. Create a Superuser and login to the system with the created user account.
2. Create user accounts and roles for the users using the system (such as Company Management
Personnel, Registrars, and Attendance Administrators).
3. Set the common system information such as System parameters, Announcements, and Alerts.
4. Set the organization architecture according to the company’s structure and set the corresponding
position details.
5. Enter the employee information.
6. Set the regional structure of the company. Add T&A devices for the system and configure the devices.
7. Export attendance transaction to the third-party software for further calculation.
3 System Management
3.1 Login
1. Once the program is installed on the system, double-click the program icon on the desktop to view
the system login interface. Other systems can access the application through the network.
2. Open the browser, enter the Server IP Address and the Port number in the address bar. Click Enter to
login.
3. To use the system on a server, select [Program] > [ZKBio WDMS] > [ZKBio WDMS Server Controller]
and start the service. Then, double-click the shortcut icon of ZKBio WDMS Home Page on the desktop.
The system login interface pops up.
Note: In Windows 7/Vista, right-click ZKBio WDMS Server Controller and select Run as
administrator from the shortcut menu.
4. When the user logs in to the system, authentication is required to guarantee the system security. A
superuser account (with all operational permissions) needs to be created for a user who is using the
system for the first time.
The superuser can assign employees (such as Company Management Personnel, Registrars, and
Statistics Clerks) as new users and they can configure the corresponding user roles. For detailed
operation, please refer to "7.1.2 User Management".
5. After the user logs in, the system displays the dashboard as shown in the below figure.
On the Dashboard, the user can see four modules namely Personnel, Device, MTD, and System.
Click the related module to perform the related functionalities.
3.2 Logout
Click the User Profile on the top-right of the interface, select Logout, and click Confirm to log out
from the application.
After logging out, stop the service in ZKBio WDMS Server Controller and quit the service counter.
A Superuser or new users can change their passwords to guarantee a safe system operation. Click the User
Profile on the top-right and select Password. Enter the old password, new password, and confirm the
new password. Click Confirm to change the password.
4 Personnel Management
The Personnel management module allows you to set the main architecture of the company. It includes
adding employees to the system, allocating employees to departments and maintaining the employees,
and so on.
Before adding the employees, set the organizational structure of the company. When the module is used
for the first time, a level 1 company with the company name as "Company" and Company Code as "1" will
be created as a default.
Company Name: Enter the corresponding Company Name maximum of 100 characters.
2. After entering the required details, click [Confirm] to save the new Company.
If you want to change the organization’s structure, you can modify the Company Name and Company
Code. Click the Company Code of the Company to be modified or, click in the same row of the
Company to be modified. After modifications, click [Confirm] to save the modified Company information.
Select the Company to be deleted and then click [Delete] on the upper left of the Company list. Or directly
click in the same row of the Company to be deleted. Click [Confirm] to delete the Company.
Notes:
Deleting or modifying a Company causes the employees association to the particular Company is no
longer valid for any other Companies.
If deletion or modification is indeed required, transfer the personnel in the particular Company to
another Company and then delete the Company.
That is, the Company which is currently being used cannot be deleted.
2. Before adding the employees, set the organizational structure of the department. When the module is
used for the first time, a level 1 department with department name as "Department" and Department
Code as "1" will be created as a default.
1. Select [Personnel] > [Department] > [Add] to add a new Department, as shown in the figure below.
Company: Click and select the Company to which the department belongs.
Department Name: Enter the corresponding Department Name maximum of 100 characters.
Superior: Click and select a superior Department of this Department from the drop-down list.
Notes:
The department codes and department names of two positions in different companies can be the
same.
The department codes of two departments in the same company cannot be the same, and the
department names can be the same.
2. After entering the required details, click [Confirm] to save the new Department. Click to refresh
the Department tree.
Notes:
The user can click [Import] to import the Department information to another software or system. For
detailed operation, please refer to "8.3 Import" in "8 Appendices".
The user can click to export the Department data locally. For detailed operation, please refer to
"8.4 Export" in "8 Appendices".
If you want to change the organization’s structure, you can modify the Department Name, Department
Code, and the Superior Department. Click the Department Code of the Department to be modified or,
click in the same row of the Department to be modified. After modifications, click [Confirm] to save the
modified Department information.
Select the Department which is going to be deleted and click [Delete] on the upper left of the Department
list. Or directly click in the same row of the Department to delete. Click [Confirm] to delete the
Department.
Notes:
Deleting or modifying a Department causes the employees belonging to the particular Department
will not be associated with any of the Departments.
If deletion or modification is indeed required, transfer the personnel in the particular Department to
other Departments, and then delete the Department.
That is the Department which is currently in use that cannot be deleted.
The user can adjust employees to the selected Department in batches. The steps are given below:
1. Select [Personnel] > [Department]. Select the corresponding Department and click [Personnel
Transfer].
2. In the employee’s list, select the employee(s) whom you want to adjust to the selected Department in
batches (The user can search employees by Department, Name, or Employee ID).
3. Select the Employee and click [Confirm]. The Departments of the selected employee will be changed.
Company: Click and select the Company to which the position belongs.
Position Code: Enter a unique Position Code.
Position Name: Enter the Position Name.
Superior: Click and select a superior Position of this Position from the drop-down list.
2. After entering the required details, click [Confirm] to save the new position.
Notes:
The position codes and position names of two departments in different companies can be the same.
The position codes of two positions in the same company cannot be the same, but the position
names can be the same.
If the user wants to edit the position details, click the Position or in the same row of the position to be
edited.
Select the position which is to be deleted and then click [Delete] on the upper left of the position list or
click in the same row of the position to get deleted. Click [Confirm] to delete the position.
1. Select [Personnel] > [Position]. Select the corresponding position and click [Personnel Transfer].
2. In the employee’s list, select the employees whom you want to change the position. (You can search
employees by Name or Employee ID).
3. Select the employee(s) and click [Confirm]. The position of the selected employee will be changed.
Notes:
The user can click [Import] to import the position information in another software or system. For
detailed operation, please refer to "8.3 Import" in "8 Appendices".
The user can click to export the position data locally. For detailed operation, please refer to "8.4
Export" in "8 Appendices".
The system will set a default area named [Not Authorized] whose area code is 1 for every Company.
Company: Click and select the Company to which the area belongs.
Superior: Click and select a superior area of this area from the drop-down list.
2. After entering the required details, click [Confirm] to add the new area.
Notes:
The area codes and area names of two areas in different companies can be the same.
The area codes of two areas in the same company cannot be the same, but the area names can be the
same.
1. In the area list, click an area code, or click in the same row of the area to be edited.
1. In the area list, select the area to be deleted and then click [Delete] on the upper of the area list or
Notes:
1. Select [Personnel] > [Area]. Select the corresponding area and click [Personnel Transfer].
2. In the employee’s list, select the employees whom you want to change the area (The user can search
employees by Department, Name, or Employee ID).
3. Select the employee and click [Confirm]. The area of the selected employees will be changed.
Notes:
The user can click [Import] to import the area information in another software or system. For detailed
operation, please refer to "8.3 Import" in "8 Appendices".
The user can click to export the position data locally. For detailed operation, please refer to "8.4
Export" in "8 Appendices".
You can click to export the personnel data locally. For detailed operation, please refer to "8.4
Export" in "8 Appendices".
1. Select [Personnel] > [Employee] > [Employee] > [Add] to add an Employee.
Profile
Company: Click and select the Company to which the employee belongs.
Employee ID: Enter the Employee ID a maximum of 20 digits. The digits will be incremented
automatically based on the system settings.
Department: Select the Employee’s Department from the drop-down list. (If no Department has
been set, only the default Department existing in the system can be chosen)
Area: Select an area from the drop-down list. (If no area has been set, only the default area existing
in the system can be chosen)
Employment Type: Select the employment type from the drop-down list. It can be set as Official,
Temporary, and Probation. If Temporary or Probation is selected, then users can set the valid
working period for the personnel.
After the valid period, the personnel details will be deleted from the corresponding device(s).
Employee Photo: Click [Photo] and select the photo to be uploaded. After selection, the photo is
displayed, as shown in the figure below.
Note: While HTTPS is enabled, users can access the system with https address and enroll personnel photos
with a USB camera or the inbuilt system camera.
Private Information
Verify Mode: Select the verification mode when the employee checks-in/out for attendance.
Device Privilege: Select the privilege of a user in the device from the following options.
These four device privileges are the default device privileges. Some devices only display
"Employee" and "Super Administrator". Once the personnel device privilege is set as "Registrar",
"System Administrator" or "Super Administrator", the person corresponds to all devices in the area,
and the personnel with "Employee" privilege can only make verification on the device, and cannot
open and operate the device menu. Only "Registrar", "System Administrator" or "Super
Administrator" can open the device and operate the corresponding device menu.
Card NO.: Enter the card number manually and assign the card numbers to employees to verify
attendance.
PIN: Set the employee’s password. The black-and-white T&A devices support a password
maximum of 5 digits. The color-screen T&A devices support passwords of 8 digits. Password digits
exceeding the specified length are cut out by the system automatically. When the user needs to
change the password, clear the old password in the text box and enter the new password.
Custom Attribute
1. Click [Custom Attribute] to enter the other specific data of the Employee.
2. After entering the required details, click [Confirm] to save and update the details.
The Import USB Format Employee function can import the personnel data exported from the device to the
USB into the system.
1. Click [Import] > [Import USB Format Employee] to import employee by USB.
Existing Data: Select whether to ignore or overwrite the data that already exists in the system.
2. After clicking [Confirm], the personnel data will be uploaded to the system.
The Export USB Employee function can export the personnel data of the system to USB. These data can be
imported into the device or system again.
2. Click [Confirm], and the personnel data will be exported to the ZKBioWDMS\files\usb_data.
1. In the employee’s list, click the Employee ID or click in the same row of the employee to be edited.
1. Select the employee(s) and click [Delete] on the upper left of the employee’s list or click in the
same row of the employee to be deleted.
Note: When the user deletes an employee, the information of the employee in the database is also deleted.
Personnel Transfer
This includes Department Transfer, Position Transfer, Area Transfer, and Pass Probation.
1. In the employee’s list select the employee(s) and click [Personnel Transfer] > [Department Transfer]
to adjust the department.
2. In the Company drop-down list, select the Company to which the employee is to be moved.
3. In the Department drop-down list, select the Department to which the employee is to be moved and
enter the remarks.
4. Click [Confirm] to save the details.
Note: The operation of Adjust Position, Adjust Area, and Pass probation are the same as the operation of
Department adjustment.
Personnel Resignation
1. In the employee’s list, select the employee (s), and click [Personnel Transfer] > [Resignation] to add
the resignation details.
Resignation Type: Select the resignation type. The types are Suspension, Dismissal, Resignation,
Transfer, and Unpaid retention.
It synchronizes the employee details on the software to the devices in the corresponding area.
1. In the employee’s list, select the employee(s) and click [More] > [Re-synchronize to Device] to
synchronize the data.
1. In the employee’s list, select the employee(s) and click [More] > [Re-upload from Device] to re-
upload the employee details from the specified devices.
2. Click [Confirm] to re-upload the employee details from the device to the software.
1. In the employee’s list, select the employee(s) and click [More] > [Delete Biometric Template] to
delete the biometric templates.
2. Select the type of biometric template and click [Confirm]. The biometric template of the employee
will be deleted from the device.
1. Select [Personnel] > [Employee] > [Resign] > [Add] to add the employee’s resignation details.
Employee: Select the employee to enter the resignation details. (You can filter the employees by
Department, Name, or Employee ID).
Resign Type: Select the type of resignation. The types are Quit, Dismissed, Resign, Transfer, Retain
Job Without Salary.
Attendance: When the "Disable" option is selected, the employee will be automatically removed
from the device and cannot be verified by it.
1. Select the employee(s) to be deleted and click [Delete] on the upper left of the personnel list or click
4.6.3 Reinstate
It restores a resigned employee from the resigned employee’s list. The details of the employee will be
deleted from the resigned employee’s list.
1. In the resigned employee’s list, select the employee whom you want to restore from resignation. Click
[Reinstate] to restore the employee.
Notes:
You can click [Import] to import the employee’s resignation details in another software or system. For
detailed operation, please refer to "8.3 Import" in "8 Appendices".
You can click to export the employee’s resignation details locally. For detailed operation, please
refer to "8.4 Export" in "8 Appendices".
1. On the personnel module, click [Configuration] > [Custom Attribute] > [Add] to manually create
field.
Input Type: Select the format type from the drop-down list (default format: Text).
1. Select the attribute to be deleted and click [Delete] on the upper left of the personnel list or click
in the same row of the employee to be deleted.
5 Device Management
Device Management includes the installation of devices and setting the device parameters. It allows you
to manage the connected devices from the system, thereby implementing virtual management. It also
includes uploading the user attendance data, downloading the configuration information.
5.1 Device
Initially, communication parameters must be set to connect the devices. Once the communication is
successful, you can view the information on the connected devices and perform operations such as
remote monitoring, uploading, and downloading.
Select [Device] > [Device] to view the Device Management interface. All the connected T&A devices are
displayed in a list as shown in the below image.
Device Name: Displays the name of the device. For automatically connected devices, it will be
displayed as Auto add.
Area: Displays the area in which the device is defined in the software.
State: indicates that the device is connected. indicates that the device is not connected.
indicates that the user needs to assign an area except for the default area to the device.
Last Activity: Represents the last time the command was executed.
User Qty: Displays the number of employees already registered on the device.
Last Sync: Displays the time in which the system issued data to the device last time.
There are two ways to add a T&A device: Manually adding a T&A device and automatically adding a T&A
device.
Area: In the drop-down list, select the area to which the T&A device belongs.
Time Zone: When a time zone is selected, the time on the T&A device will be automatically
synchronized to the standard time in the particular time zone.
Registration Device: Select whether the device is a registration device or not. If yes, then only the
employees registered from the device will be uploaded to the software automatically.
Heartbeat Request: Set the time for the device to automatically transmit the data to the system.
Transfer Mode: Select the data transfer mode between software and devices. The Transfer mode
can be real-time or at a specified time.
Note: When an employee is added to a device, the employee information will be uploaded to the server
automatically. It will be synchronized with other devices in the same area.
It is unnecessary to manually add T&A devices of certain models. You can connect such devices to the
system via HTTP by completing the settings on the devices. Once the devices are connected to the
internet, the device list will display all the T&A devices. Please refer to the relevant user manuals for the
detailed operating procedures.
Note: The devices added automatically must be assigned to custom areas to communicate with the
software.
Click a device name or click in the same row of the device to be edited.
Note: Serial Number and Device IP are read-only. The device name must be unique.
1. Select the device and click [Delete] above the device list or click in the same row of the device to
be deleted.
Select [Device] > [Device] > [New Area] to create a new area. For detailed operation, please refer to "4.4.1
Add an Area ".
Select the device and click [Device Menu] > [Clear Pending Command]. Click [Confirm] to clear all the
pending commands.
1. Select a device and click [Data Clean] > [Clear Attendance Data].
1. It is used to upload the user data from the device to the software.
2. Select a device and click [Data Transfer] > [Upload User Data].
3. Here you can select to upload all or specified user data to the software.
4. Click [Confirm] to upload the user data.
Note: You can upload the personal information on a T&A device to the server in batches by uploading it
again. If time is out, uploading will be interrupted and you need to perform the upload operation again.
Upload Transaction
1. You can upload the attendance transactions from the device to the software.
2. Select a device and click [Data Transfer] > [Upload Transaction].
3. Here you can select to upload all transactions or set the start time and end time to upload the
transactions within the specified time.
4. Click [Confirm] to upload transactions.
1. Synchronize data from the server to all the devices. Generally, this operation needs to be performed
only when the data in devices are inconsistent with those in the server due to Internet abnormalities
or other conditions.
2. In the device list, select the device to which data needs to be synchronized and click [Data
Transfer] > [Sync Data to Device]. Select the data to synchronize.
Note: Synchronizing the data to the devices will delete the existing data (excluding event records) in the
devices and then the setting details will be re-downloaded. Ensure that the internet connection is smooth
and there is no power failure while performing this operation.
Reboot
Read Information
1. Reads the number of persons, attendance records, and the firmware version on a device.
2. Select a device and click [Device Menu] > [Read Information] and click [Confirm] to download the
information.
Enroll Remotely
This function is applicable when the device administrator is not available to operate the device and enroll
the fingerprint.
1. Select the corresponding device, and click [Device] > [Device] > [Enroll Remotely] to access the
enroll remotely interface:
Bio Type: Select the biometric type. Currently, it supports fingerprint only.
2. Click [Confirm]. The software will issue a command to the device, and the device will open the
fingerprint enrolling menu. The employee just needs to enroll in the fingerprint.
Capture Setting
Upgrade Firmware
3. Click [Choose File] to upload the corresponding firmware (emfw.cfg) file. Click [Confirm] to upgrade
the firmware for the device.
1. Select the corresponding device(s), click [Device Menu] > [Daylight Saving Time] to open the
setting page of daylight-saving time.
2. Users can set the Daylight-Saving Mode as by date/time or by week/day. Confirm the setting, the
daylight-saving time will be issued to the device(s).
2. If you want to clear the command issued by the software to a device during communication, click
to access the device command clearing interface:
3. You can also delete commands before a certain point in time by clicking [Bulk Delete].
5.3 Message
All personnel on the device to which the public message is delivered can see this message.
1. Select [Device] > [Message] > [Public] > [Add] to add a public message.
1. Select [Device] > [Message] > [Private] > [Add] to add a private message.
2. Click [Confirm] to send public messages to the designated devices and private messages to the
devices to which the particular employees are added.
1. When a short message is deleted on software, it will be deleted on the device also.
2. Click [Confirm] and the message will be deleted from the list and the device.
5.4 Employee
This employee list is used to show the related employee data fields from device, such as employee’s
biometric templates, device privilege, verify mode, area and so on. These kinds of fields will not show on
the employee list of Personnel Module, but it can be edited.
Select [Device] > [Data] > [Work Code] to assign work code.
1. Select [Device] > [Work Code] > [Add] to access the adding work code interface:
Company: Select the company, and this work code can only be sent to devices of the selected
company.
Issues work code to the device. Only devices of the company to which the work code belongs can be
selected.
5.6 Bio-Template
Displays detailed information about employees' biometric templates.
5.7 Bio-Photo
Registers the visible light comparison photos to verify on the visible light device.
2. Scan the QR code and register the bio-photo of the user on the mobile phone (the user details must
be saved in the software), the following interface will be displayed after scanning.
3. Take the photo, enter the employee's ID Number. First Name and Last Name are optional. Click [Enroll]
to complete the registration.
5. Select the Approve State and click [Confirm] to complete the approval process. After approval, the
user can use the face to verify on the visible light device.
1. Select [Device] > [Data] > [Bio-Photo] > [Import Bio-Photo] to import the bio-photo.
Ignore Error: If it is set as Yes, then the software will automatically ignore the error that happened
during the importation.
Notes:
1. Select the application(s) and click [Delete] on the upper left of the list or click in the same row of
the bio-photo to be deleted.
5.8 Transaction
The transaction table displays the attendance records of all employees, including the logs from the
software and the devices.
Select [Device] > [Data] > [Transaction] to view the transaction table.
1. Users can export the transaction table in .xls, PDF, CSV or .txt file formats based on the requirements.
Please refer to "8.4 Export" in "8 Appendices" for detailed operation.
2. Users can select the fields to be displayed in the transaction table based on requirements (the fields
are displayed if the columns are checked).
3. Users can change the column width by dragging the column border to the left or right.
4. Users can define the number of records to be displayed on each interface in the transaction table.
5. Click any row of the attendance record and view the corresponding photo and employee information
on the right side.
You can import the attendance records to the software from the USB disk.
Upload File: Click [Choose File] and select the attendance record file to be uploaded.
You can import the attendance records to the software from the USB disk.
1. Click [Device] > [Data] > [Transaction] > [Download Attendance Photo] to open the download
setting page.
2. Set the start time and end time, select the device. Click [Confirm] to download the captured
attendance pictures of the corresponding time period from the software.
5.13 Configuration
Registration Device: Set whether the device works as a registration device or not.
Allow Auto Add: Set whether to allow to add a device automatically or not.
Allow Upload Card: Set whether to allow to upload the employee’s card number from the device.
Allow Download Name: Set whether to allow to upload employee’s names from the device.
Global Setup: When Global Setup is enabled, heartbeat and transfer mode set here will be applied
to all devices. If users want to set different heartbeat and transfer mode for different devices, users
need to disable this global setup firstly.
Default Timezone: Set the default timezone for new added device(s).
Set the Bio-Photo approval policy. It can be [Pending] or [Auto Approved]. If it is set as [Pending], then
the Bio-Photo must be approved by the administrator. Only the approved Bio-Photo will be issued to the
visible light device for verification.
Set the retention days for data, including transactions, command, device log, and upload log. It is set as
9999 to keep all data by default.
6 MTD Module
The MTD Module detects the body temperature and whether the personnel is wearing a mask. It generates
statistic reports about mask and temperature. If there is personnel who has a higher body temperature or
does not wear a mask, an email notification will be sent to the personnel himself, the system superuser,
and the system user who has permission to access the department to which the personnel belongs. And
also, if the personnel’s APP status is enabled, the software will push notification to the corresponding
personnel APP account.
Abnormal Records
When the following three situations occur, the personnel will be recorded in the abnormal records:
If the person in the abnormal record is a person registered in the device and there is an email message on
the software, an email reminder will be sent to the person and the administrator.
If the abnormal recorder is not registered on the device, the administrator will be reminded by email.
Normal Records
Only personnel with normal body temperature and wearing masks will be included in the normal record.
6.2 Dashboard
Daily Status: It displays the daily statistics of personnel who have a higher temperature, who are
all without a mask, who do not detect temperature and mask, and who are with mask and
temperature is regular.
Department Summary: Displays the statistics by the department of personnel who have a higher
temperature, who is without a mask, and who do not detect temperature and mask.
6.3 Transaction
It shows the transactions uploaded from the body temperature & mask detection device. If the body
temperature detected exceeds the warning temperature set on the software, then the temperature will be
marked in red.
6.4 Report
There are three kinds of reports:
Daily Detail
Department Summary
It is the statistics of all the personnel’s mask and temperature detection in a department.
Abnormal Detail
6.5 Configuration
Temperature Setting
Set the warning temperature and the temperature unit. The temperature unit can be set as °C or °F.
Alert Setting
Enable [Temperature Alarm] or [Mask Alarm] function, then if there is personnel who has higher
body temperature or does not wear a mask, an email notification will be sent to the person
himself, the system superuser, and system user who has permission to access the department
which the personnel belongs to. And also, if the personnel’s APP status is enabled, the software
will push the notification to the corresponding personnel APP account.
And the email notification is in real-time. Once there is an abnormal event, the notification email
will be sent to the corresponding email account.
Example: There is an personnel Andy, he belongs to Test Department , APP status is enable and has set
email account.
1. Nancy who is not a system superuser, but has the permission of Test Department and can set the
email address.
2. Mike who is a system superuser and has set the email address.
Then when Andy has the mask and body temperature detection, if he is not wearing a mask or his body
temperature exceeds the warning temperature, then an email alert will be sent to Andy, Nancy and Mike,
as the email content is as following:
7 System Settings
The system setting facilitates you to assign system users (such as Company Management Personnel,
Registrars, and Statistics Clerk), configure roles for each user, and set mailbox function, automatic export,
backup, data migration, operation logs, etc.
While using the system, the superuser needs to assign different levels to new users. To avoid assigning one
by one, you can set roles with specific levels in role management. You can also assign appropriate roles to
users while adding users. The permissions are configured for all the functional modules namely Personnel,
Device, Attendance, Payroll, Access, and System. The default super users of the system have all the
privileges and can assign new users based on the requirements and they can set the corresponding
permissions.
Name: Enter the name of the role ( e.g.: Employee, Device Administrator, etc).
Permissions: In the permission list under each functional module, select the checkbox of the
required permissions. If you want to select all the permissions under a module, select the Master
check box.
1. In the privilege group list, click the role name or click in the same row of the role to be edited.
2. Modify the parameters as per your requirements (refer to the parameter setting method in "Adding a
role"). After modifications, click [Confirm] to save the parameters.
1. In the privilege group list, select the privileged group and click [Delete] on the upper part of the
interface to be deleted.
Adds new users to the system and assigns the role (permissions) to users.
Add a User
1. Select [System] > [User] > [Add] to access the Add User interface:
Note: You can delete the existing users. Click the [Delete] at the top of the user list. The detailed
operations are the same as those in "Deleting a permission group".
Change Password
1. Select [System] > [User] > [Change Password] to change the password.
2. Enter the Original Password, New Password, and confirm the New Password. Click [Confirm] to
change the Password.
You can backup the data to prevent data loss. The software can be set to back up the database
automatically or manually. And it also supports to restore the PostgreSQL database.
Backup Automatically
1. Select [System] > [Database] > [Backup Automatically] to back up the data manually.
Store Path: Set the storage path. A corresponding folder will be created to store the original
backup files.
Day and Time: Enter the Day and Time for backup.
Backup photos: Select whether to backup photos (including personnel photos, bio-photos, and
attendance photos).
Backup Manually
1. Select [System] > [Database] > [Backup Manually] to back up the database manually. Enter the
Storage path and select whether to backup photos (including user photo, bio-photo, and attendance
photo).
1. Select [System] > [Database] > [Restore Manually] to restore the Database.
2. After setting the details, click [Confirm] to restore the file manually.
It supports specific data to migrate from ZKBio WDMS5, ZKBio WDMS6 and ZKTime Net 3.0 to ZKBio
WDMS.
Migrate From: Select the software from which you want to migrate (currently supported).
Database Type: Select the database type used by the original software.
2. Select the fields to be migrated and click [Test Connection]. If it is successful, then click [Migrate].
7.3 Integration
Based on the time period and repetition frequency, the attendance data will be exported automatically.
Select [System] > [Auto Export] > [Add] to set the auto export details.
File Name: Enter the file name to be exported. Set the Date and Time format.
Data Template: Select the data to export from the menu on the right side of the interface. By
default, all the data will be auto exported.
Format Setting
ID Digits: Set the length of the Employee ID when exporting. If the length is insufficient, 0 will be
appended to the Employee ID.
File Format: Set the file format of the exported file (Excel, CSV, Txt).
Filter By: Select Upload time to represent the time when the attendance data is uploaded to the
software and select Punch time to represent the time when the user punches.
Include Today: When exporting a file, select Yes to indicate that the data exported is included in
the data of today, and select No to indicate that the data exported is not included the data of that
particular day.
Department: Click to select the Department to export. If the Department is not selected, the
attendance data of all the departments will be auto exported.
Area: Click to select the area to export. If the area is not selected, the attendance data of all the
areas will be exported.
Frequency: Set the export frequency. The export time-frequency can be set on a
monthly/weekly/daily basis. According to the selected frequency, set the date and time.
Export Path: After entering the file name, a new folder will be created in \files\temp of the
installation directory of the local computer to store all the exported files.
Email: When an Email is set, it receives the exported file when it is exported.
FTP Path: Set the name of the folder, which is the existing folder on the FTP server. The exported
files will be saved in the corresponding folder under the FTP server in the file format of "/ABC/"
(ABC is the existing folder on the FTP server).
FTP Server: Click to select the FTP server. When the attendance record is exported, the
exported file will be saved on the FTP server.
Manual Export
After the automatic export settings are saved, you can export the attendance records in real-time by
clicking [Manual Export] at the top of the list.
1. Select the set automatic export and click [Manual Export] to export the data manually.
Query By: Select Upload time if you want to search by the time when the attendance data is
uploaded to the software. Select Punch time if you want to search by the time when the user
punches.
2. After entering the details, click [Confirm] to export the attendance records.
1. In the auto export template, select the template and click [Delete] at the top of the template list, or
According to the time period and repetition frequency, employee information will be automatically
imported.
1. Select [System] > [Auto Import] > [Add Default] to set the auto import details.
Import Data Type: Select the type of imported data. Currently, only personnel information is
supported.
Frequency: Set the import frequency. The import time-frequency can be set on a
monthly/weekly/daily basis. According to the selected frequency, set the date and time.
FTP Server: Click to select the FTP server. After the template is filled in the personnel
information and stored in the FTP server, the personnel information can be imported into the
system.
FTP Path: Set the name of the folder, which is the existing folder on the FTP server. The imported
files need to be saved in the corresponding folder under the FTP server in the file format of "/ABC/"
(ABC is the existing folder on the FTP server).
Import Path: Enter the local storage path of the personnel information document.
Archived Path: The personnel information document imported into the system will be backed up
in this path.
1. Select [System] > [Integration] > [Auto Import] > [Add User Define] to set the auto import details.
Import Data Type: Select the type of imported data. Currently, only personnel information is
supported.
Field & Excel col Setting: Set the column order corresponding to the fields in the personnel
information document. The corresponding column of the field not included in the personnel
information document should be empty.
Frequency: Set the import frequency. The import time-frequency can be set on a
monthly/weekly/daily basis. According to the selected frequency, set the date and time.
FTP Server: Click to select the FTP server. After the template is filled in the personnel
information and stored in the FTP server, the personnel information can be imported into the
system.
FTP Path: Set the name of the folder, which is the existing folder on the FTP server. The imported
files need to be saved in the corresponding folder under the FTP server in the file format of "/ABC/"
(ABC is the existing folder on the FTP server).
Import Path: Enter the local storage path of the personnel information document.
Archived Path: The personnel information document imported into the system will be backed up
in this path.
7.4 Log
The log displays all the operational log records in the system.
Select [System] > [Log] > [User Log] to access the Log interface.
Action Time: The actual time in which the user performed some operation.
The log displays all the system log records in the system.
Select [System] > [Log] > [System Log] to access the Log interface.
The log displays all the API log records in the system.
Select [System] > [Log] > [API Log] to access the Log interface.
1. Select [System] > [Configuration] > [System Setting] > [Email Settings].
2. The email setting is used to trigger an alert when the specific value set by the administrator has
crossed the limit.
Note: The domain name of the E-mail address and E-mail sending server (outgoing server) must be the
same. For example, the Email address is test@yahoo.com, and the E-mail sending server must be
smtp.mail.yahoo.com.
Obtain the mail server details and fill it accordingly. An example is shown below.
Password: Enter the One-time random authorization password from the mailbox provider.
Note: The password is a one-time random authorization password provided by the email service provider.
Authentic Method: Enter the authentication method to access the FTP server.
The FTP Settings can be used to transfer the files exported by the software to the specified FTP server
for data transfer.
Note: Click the FTP server or the in the same row of the FTP server.
1. In the FTP list, select the FTP server and click [Delete] at the top of the FTP server list, or click in
the same row of the FTP server.
1. Select [System] > [Configuration] > [System Setting] > [PDF Export].
Direction: Set the direction of the exported PDF. It can be "Portrait" or "Landscape".
Footer Left: Set the content to be displayed in the lower-left corner of the exported PDF page. It
can be "Blank", "current page number / total number of pages", "author", "time", "author + time".
Footer Right: Set the content to be displayed in the lower right corner of the exported PDF page.
It can be "Blank", "current page number / total number of pages", "author", "time", "author + time".
7.5.4 Bookmarks
Add a Bookmark
You can save the filtered query as a bookmark to simplify the search operation next time. See "8.8 Custom
bookmark" in "8 Appendices" for a custom bookmark.
After saving successfully, you can view the saved filter under the bookmarks list.
Delete Bookmark
1. In the bookmarks list, select the bookmark and click [Delete] at the top of the bookmarks list, or click
Login Setup
Single Login
If it is enabled, then the software will forbid system users to log in to the software from multiple
places. This feature is only for the system administrator login. For self-service, multiple logins are not
allowed by default.
Verification Code
If it is enabled, then while log in to the software, users need to fill in the QR code. Here the users can
set the length and valid duration of the verification code.
Failed Locked
If it is enabled, if the user enters the login password incorrectly equal to the set login failed times
within 24 hours, the system will lock the user and prohibit the user from login. After the set lock
duration, the user can log in again.
Password Policy
If it’s enabled, then when the system users or employees login to the software for the first time, it is
required to change the password and login to the software with the new password.
Users can set the expiration day of the password. Before the expiration date, the users need to change
the password.
Forget Password
While forgetting the login password, users and personnel can click [Forget Password] on the login page
to get a new password.
The email of resetting the password will be sent to the corresponding email account.
Users need to click the link in the email within 2 hours to get the new password.
Then the user will receive an email with the new password, and the user will be able to log in to the
software according to the password in the email.
8 Appendices
Search by Department: Click the Department search box to search the corresponding
Department. Click the Master to view all the employees in all the Departments. If only one of the
departments is selected, all the employees in that Department will be displayed.
Search by ID/Name: Enter the Employee ID or Name to be searched in the textbox and click .
Then the related employee details will be displayed.
If the required employee is displayed in the selected employee’s list and you need to delete one or
more employees, deselect the checkboxes.
The system automatically displays the date selection window when you click the Date textbox as shown in
the figure below.
1. Click the year on the top and select a year from the year list (by default, the system displays the
current year).
2. Click the month and select a month from the month list (by default, the system displays the current
month).
Clear: Click Clear to clear the selected date if you want to re-select the date.
8.3 Import
An example to import an employee data is shown below, and there are two ways to import.
1. Select [Personnel] > [Employee] > [Employee] > [Import] > [Import Employee].
3. Click [Download Template] to download the template. Fill in the template and save the
corresponding employee’s information. You can use the employee import function to import the file
(.xls file) to the system.
4. Click [Choose File]. A dialog box will open as shown in the figure below.
5. Select the file to be imported and click [Open] or directly double-click the file to be imported.
Note: Only .xls and .csv files can be imported.
6. Click [Confirm] to import the records.
1. Select [Personnel] > [Employee] > [Employee] > [Import] > [Import Employee].
3. Adjust the fields order in the table to be consistent with that of the imported file.
5. Click [Choose File]. A dialog box will open as shown in the figure below.
6. Select the file to be imported and click [Open] or directly double-click the file to be imported.
Notes:
8.4 Export
An example to export employee’s list is shown below:
1. Select [Personnel] > [Employee] and click on the top right corner of the screen. The exporting
options are shown below:
2. File Type: if you want to export the file in Excel format, select Excel Export.
Select "Current Page" to export the data for the current page.
3. Click [Confirm] to set the export path. Under the corresponding path, the file will be successfully
exported, as shown in the figure below:
Select [Personnel] > [Employee] and click on the top right corner of the screen, the field selection
window will pop-up as shown below:
You can adjust the display order and decide whether the fields need to be displayed or not (checked
means it will be displayed, un-checked means it will not be displayed). When adjusting the order, simply
move the cursor to the field to be moved, and then drag the field to move the order when the
appears after the field. After adjusting the order, click Confirm to reorder the fields.
1. After setting the number of fields to be displayed, click and choose [Best Fit] to adjust the column
width, as shown in the figure below:
2. Click [Best Fit With Scale] to adjust the columns with the best ratio, as shown in the figure below:
1. Click [Personnel] to open the Personnel module. When you open any menu, you can see the opened
menu label at the top of the page, as shown in the below image:
2. The menu can be switched randomly. When switching, the data which is entered will not be refreshed.
1. Click the at the top right of the page and select Theme to set the theme color.
2. Click [Themes] to select the background of the menu. Then click [Pure Colors] to customize the
theme color. Then click Change to apply the color effects.
Take the Employee list as an example. Click [Personnel] > [Employee] > [Employee] to view the
Employee’s list.
1. In the Filters section, enter the keyword such as Employee ID (The toggle button moves to the right to
indicate that the search has been filtered, and to the left to indicate that the search has been
excluded).
2. Select from the search criteria: Exact search, Start field, End field, Include, One of, or Regular
expression.
In this example, an employee with an Employee ID as 3 is being searched. Enter "3" and click . The
filtered result will be displayed as shown below:
Multiple Search
Multiple search criteria can also be selected, but the same field and the same criteria can only be
selected once.
Click Clear Filter to clear the search criteria.
In the search term that appears at the top of the employee’s list, click to toggle whether the
search term is filtered or excluded.
Note: The filter function under each menu in the system is similar. But the difference lies in the field
settings.
1. When multiple filters are set, the page will be displayed as shown below:
2. Click Bookmarks, select [New Bookmark]. Enter the bookmark name and click [Save]. The saved
bookmarks can be seen under the Bookmarks menu.
Select [System] > [Log] > [User Log]. Click on the top right corner to access the Logs as shown in the
figure below.
Notes:
The Logs interface displays only the operation logs of the current operation module.
You can view all log records in Log under the System module.
This End-User License Agreement ("EULA") is a legal agreement between ZKTeco and you(either an
individual or a company)The Software product includes the Software application, associated media,
printed materials, and "online" or electronic documentation. By installing, copying, or using the Software
Product, you agree to accept the terms of this EULA. If you do not agree to the terms of this EULA, do not
install, or use the Software Product.
The Software Product is protected by copyright laws and international copyright agreements, as well as
other intellectual property laws and agreements. The Software Product is licensed, and it cannot be sold
by any third party.
Installation and Use. You may install the Software Product in an unlimited number of systems.
Replication and Distribution. You may distribute the software product to an unlimited number of
systems; provided that each copy shall be a true and complete copy, including all copyright and trade
notices, and shall be accompanied by a copy of this EULA. The Software Product may be distributed as
a standalone product or included with your own product.
Limitations on Reverse Engineering, Recompilation, and Disassembly. You may not destruct,
decompile, or disassemble the Software Product only to the extent that such activity is expressly
permitted by applicable law and notwithstanding this limitation.
Separation of Components.
The Software Product is licensed as a single product. Its components may not be separated for use on
more than one system.
Software Transfer.
You may permanently transfer all of your rights, provided the recipient agrees to the terms of this
EULA.
Termination.
Without prejudice to any other rights, ZKTeco may terminate this EULA if you fail to comply with the
terms and conditions of this EULA. In such a case, you must destroy all copies of the Software Product
and all of its components.
Distribution.
The Software Product may not be sold or included in a product or package, which intends to receive
benefits from the inclusion of the Software Product. The Software Product may be included in any free
or non-profit packages or products.
3. COPYRIGHT.
All copyrights of the Software Product(including but not limited to images, photographs, animations,
video, audio, music, text, and "applets" incorporated into the Software Product), the accompanying
printed materials, and any copies of the Software Product are owned by ZKTeco. The Software Product
is protected by copyright laws and international treaty provisions. Therefore, you must treat the
Software Product like any other copyrighted material except that you may install the Software Product
on a single computer, and you can keep the original solely for backup or archival purposes.
LIMITED WARRANTY
NO WARRANTIES.
ZKTeco expressly disclaims any warranty for the Software Product. The Software Product and any related
documentation being provided "as is" without warranty of any kind, either express or implied, including,
without limitation, the implied warranties of merchantability, fitness for a particular purpose, or no
infringement. The entire risk arising out of usage or performance of the Software Product remains with
you.
In no event ZKTeco will be liable for any damages (including but not limited to damages, loss of business
profits, business interruption, loss of business information, or any other pecuniary loss) arising out of the
using this product or inability to use this product, even if ZKTeco has advised of the possibility of such
damages.
Acknowledgment of Agreement.
I have carefully read and understood this Agreement, ZKTeco CO., LTD.’s Privacy Policy Statement.
I acknowledge and understand that by accepting this agreement, I have to abide by the terms and
conditions to use the Software Product to ensure smooth function. I also acknowledge that ZKTeco can
terminate the License Agreement if I do not comply with the terms and conditions.
I acknowledge and understand that by refusing to accept these terms, I have rejected this license
agreement and therefore have no legal right to install, use, or copy this Product or the Licensed Software
that it incorporates.
www.zkteco.com