Biometric attendance device intergration using ICloud ADMS Protocol

In addition to using the traditional TCP protocol to integrate the time attendance machine with Viindoo software, users can now easily and conveniently use the Icloud ADMS protocol.

Requirements

This tutorial requires the installation of the following applications/modules:

• Biometric Attendance Device

Known Issue

There are a few requirements before getting into the details as follows

• Your time attendance device must support the HTTPS protocol, you can check by access the time attendance device configiration: Main Menu > COMM > Coud Server Setting > HTTPS. If you do not see the HTTPS setup option, it is likely that your device does not support this protocol. Therefore, you should consider using a different device.

How to install the module

To use the Attendance device integration function, you need to install the Biometric Attendance Device module (to_attendance_device).

Access Apps, search for “Biometric Attendance”, and then press Install.

After installing the module, the system will auto-install the Attendances module (hr_attendance), which allows you to manage the attendance data using the Biometric Attendance Device module.

Note

If you don’t see the Activate button, it is more likely that the module has been installed or not upgraded yet.

How to set up

Set up Cloud Server Setting

Take your attendance device, access to Main Menu > COMM > Cloud Server Setting, do the configuration as below:

• Server Mode: ADMS

• Enable Domain Name: Active

• Server Address: your domain instance, let’s assume: viindoo.com

• Enable Proxy Server: Unactive

• HTTPS: Active

Set up biometric attendance devices

Note

Currently, Viindoo software is designed to be able to integrate with every attendance device on the ZKTeco platform.

Enter Attendances app, select Attendance Machines > Machines Manager.

At the device information view, press New.

A Devices Information view will appear. Fill in the needed information as follow.

General information

• Name: the name of the device. You should select the most recognizable name for the device, for example ZKTeco K14 No.1.

• Protocol: Icloud - ADMS

• Technician: The employee in charge of this device.

• Location: Where the device is put, for example Viindoo Headquarters

• Last Sync.: Show the latest time the device is synced, the system will auto-update after every synchronization.

• Description: Note, description for the device.

• Serial Number: Your attendance machine Serial number. On your device, you can access Main Menu > System Info > Device Info > Serial Number for checking.

• Unaccent User Name: User name without an accent.

After filling in the important information, click Confirm and then click Upload Setting. You will see an Command to Device is auto generated with draff state. Now, you only need to wait for a while (about 30 seconds).

If everything is fine, the command’s state then will change to Done.

• Now, go back to the time attendance machine setup interface, and you will see that other information related to the machine has been updated automatically.

  • OEM Vendor;
  • Device Name;
  • Platform;
  • Firmware Version;

Attendance Status Codes tab

This is the summary of the employees’ Attendance Status Codes set in the device. The manager will use this information to know if the attendance is a normal or an overtime one, in order to calculate the employee’s salary.

Here is how it display.

Attendance Status Codes:

• State Code: State codes are set in the Attendance device, to show if an attendance is check-in or check-out, normal attendance or overtime. Select the Bin icon to delete a State code.

If there is not enough state code to serve your purpose, you can create a new state code in two ways below

• Press Add a line on the tab Attendance status code from the machine information interface.

• Navigate to Attendance > Attendance Machines > Attendance Status, click on New button.

There are some fields, you need to fill in:

• Name: The status name, for example, Check-In, Check-Out, Start Overtime, etc.
• Code Number: The code of this status, need to be an integer value and not a duplicate of another activity, status code.
• Activity: Select the activity that you want.
• Activity Type: select Check-In or Check-out, depend on the name of the status.

After filling in all the information, press Save icon. To cancel information, select Discard icon.

If there is not Activity you want, pressing Attendance > Attendance Machines > Attendance Activity, press New.

• Name: The name of the activity, for example, overtime, normal attendance, etc.
• Attendance Statuses: create attendance status for this activity

To save the setting on Attendance Activity, press Save.

Technical Settings Tab

Input the technical information of the attendance device.

Here is how it display. You need to pay attention to the following information:

• Timezone: the device’s timezone, the date and time in the attendance report will be update based on this timezone. The system will update the timezone base on the value set on the timezone of the attendance device creator.

• Map Employee Before Download: If checked, the system will map the users of the attendance device with the employees of the system (if available) before downloading data.

• Generate Employee During Mapping: If checked, the system will auto-create new employees for the attendance device users that don’t match employee data of the system, and then map them together.

• Download Error Notification: If checked,the system will send a notification when there is an error during download, to help the manager quickly find the error and fix them.

• Auto Clear Attendance Data: If checked, the system will automatically clear the attendance data on the device after synchronization with Viindoo system to avoid full data.

• Debug Message: send notifications in the Open Chatter when there is an error, to help with the debug process.

Upload employees list to the attendance machine

To reduce the workload when importing data into the attendance machine, you can upload the employee list to the attendance device.

Devices Information statuses and buttons

Device status

After successfully integrating the time attendance machine, the device status is Confirmed. If the device is no longer in use, press Cancelled on the Devices Informations view. The status will change to Cancelled.

Use active buttons on the Devices Information view

On the Devices Information view, you can see the following buttons:

You can press on the buttons to perform the following actions:

• Check connection: check the connection with the attendance device.

• Get Machine Info: Connect with the device and automatically update the information into the system: OEM Vendor, Device name, etc.

• Download Attendace: Download attendance data from the device to Viindoo system.

• Download Users: Download the users list that is set on the attendance device.

• Upload Users: Upload the employees list to the attendance device.

• Map Employees: Map the employees with users set on the attendance device.

• Download Fingersprints: Download the employee fingers template from the Attendance device.

• Clear Attendance Data: Clear all the data from the attendance device.

• Restart Machine: Restart the attendance device.

• Show Machine Time: Show the attendance device real time. The time set in the attendance device can be more/less or equal to the time set in the Viindoo system (Activate debug mode to view this feature).

See also

Related article

• Link Attendance device users with employees in Viindoo system

• Installing time attendance machine integrated with the software

• Manage attendance data

• Check-in/check-out management based on the work schedule

Optional module

• HR Attendance Validation

• Payroll Attendance