Key Features
- Support both UDP and TCP for large attendance data (tested with a real machine that store more than 90 thousand attendance records)
- Support connection with either domain name or IP
- Authenticate devices with password.
- Multiple Devices for multiple locations
- Multiple device time zones at multiple locations
- Multiple Attendance Status support (e.g. Check-in, Check-out, Start Overtime, End Overtime, etc)
- Store fingerprint templates in employee profiles to quickly set up new device (Added since version 1.1.0)
- Delete Device's Users from Odoo
- Upload new users into the devices from Odoo's Employee database
- Auto Map Device Users with Odoo employee base on Badge ID mapping, or name search mapping if no Badge ID match found
- Store Device Attendance data permanently
- Manual/Automatic download attendance data from all your devices into Odoo (using scheduled actions)
- Manual/Automatic synchronize device attendance data with HR Attendance so that you can access them in your salary rules for payslip computation
- Automatically Clear Attendance Data from the Device periodically, which is configurable.
- Designed to work with all attendance devices that based on ZKTeco platform.
- Fully TESTED with the following devices:
- RONALD JACK B3-C
- ZKTeco K50
- ZKTeco MA300
- ZKTeco U580
- ZKTeco T4C
- ZKTeco G3
- RONALD JACK iClock260
- Reported by clients that the module has worked great with the following devices
- ZKTeco K40
- ZKTeco U580
- iFace402/ID
- ZKTeco MB20
- ZKteco IN0A-1
- Uface 800
- ... (please advise us your devices. Tks!)
Credit
Tons of thanks to fananimi for his pyzk library @ https://github.com/fananimi/pyzk
We got inspired from that and customize it for more features (device information, Python 3 support,
TCP/IP support, etc) then we integrated into Odoo by this great Attendance Device application
Editions Supported
- Community Edition
- Enterprise Edition
Installation
- Navigate to Apps
- Find with keyword 'to_attendance_device'
- Install it as usual then you are done
Concepts
Device Location: is a model to store locations where your attendance devices are installed.
Each location consists of the following information
- Name: the name of the location.
- Time zone: the time zone of the location. This is to support for attendance logs at multiple locations of different time zones
Attendance State: is a model to store states of attendance activity that can be defined by users.
States could be Check in, Check out, Overtime Check in, Overtime Start, etc. Please navigate to
Attendance > Configuration > Attendance Status to see the list of default states that were created
during installation of this application.
Attendance Activity: is a model that classifies attendances in activities such as Normal Working, Overtime, etc.
Navigate to Attendance > Configuration > Attendance Activity to see the list of default activities that were created during installation of this application. Each Attendance Activity is defined with the following
- Name: the unique name of the activity
- Attendance Status: List of the attendance states that are applied to this Activity.
Device User is a model that stores all the devices' users in your Odoo instance and map such the users with Employees in the Odoo instance. Each Device User consists of (but not limited to) the following information
- Name: The name of the user stored in the device
- Attendance Device: The device to which this user belong
- UID: The ID (technical field) of the user in the device storage, which is usually invisible at the device's inteface/screen
- ID Number: The ID Number of the user/employee in the device storage. It is also known as "User ID" in some devices
- Employee: the employee that is mapped with this user. If you have multiple device, each employee may map with multiple corresponding device users
User Attendance: is a model that stores all the attendance records downloaded from all the devices. In other words,
it a central database of attendance logs for all your devices. This log will be used as the based to create HR Attendance. During that creation,
Odoo will also check for a validity of the attendance to ensure that the HR Attendance data is clean and valid.
HR Attendance: is a model offered by the Odoo's standard module hr_attendance and is extended to have the following fields
- Check In: the time of check in
- Check Out: the time of check out
- Employee: the related employee
- Checkin Device: the attendance device that logged the check in
- Checkout Device: the attendance device that logged the check out
HR Attendance records is created automatically and periodically by the Scheduled Action named "Synchronize attendances scheduler"
Employee: is a model in Odoo that is extended for additional following information
- Unmapped Devices: to show the list of attendance devices that have not get this employee mapped
- Created from Device: to indicate if the employee profile was created from device (i.g. Download users -> auto create employee -> au map them).
This will helps you filter your employees to see ones that were or were not created from devices
Attendance Device: is a model that store all the information of an attendance device. It also provides a lot of tools such as
- Upload Users: to upload all your employee to an attendance device (e.g an new and fresh device)
- Download Users: to download all the device's users data into odoo and map those users with employees (if auto mapping is set)
- Map Employee: to map device users with employees in your Odoo instance
- Check connection: to check if your Odoo instance could connect to the device
- Get Device Info: to get the most important information about the device (e.g. OEM Vendor, Device Name, Serial Number, Firmware Version, etc)
- Download Attendance: to download manually all the attendance data from the device into your Odoo database, although this could be done automatically be the scheduled action named "Download attendances scheduler"
- Restart: to restart the device
- Clear Data: this is to empty your data. It is very DANGEROUS function and is visible to and accessible by the HR Attendance Manager only
- And many more...
Setup a new attendance device
Navigate to Attendances > Attendance Devices > Devices Manager
Click Create button to open device form view
Input the name of the device (optional)
Enter the IP of the device. It must be accessible from your Odoo server.
If your Odoo instance is on the Internet while the device is in your office,
behind a router, please insure that port forwarding is enabled and the device's network configuration is
properly set to allow accessing your device from outside via Internet. You may need to refer to your router manufacturers for documentation on how to do NAT / port forwarding
Port: the port of the device. It is usually 4370
Protocol: which is either UDP or TCP. Most the modern devices nowadays support both. TCP is more reliable but may not be supported by a behind-a-decade device
Location: the location where the device is physically installed. It is important that the time zone of the location should be correct.
You may want to see other options (e.g. Map Employee Before Download, Time zone, Create Employees During Mapping, etc)
Hit Save button to create a new device in your Odoo.
Hit Check Connection to test if the connection works. If it did not work, please trouble shout for the following cases
- Check network setting inside the physical device: IP, Gateway, Port, Net Mask
- Check your firewall / router to see if it blocks connection from your Odoo instance.
- Try on switching between UDP and TCP
Map Devices Users and Employees
- If this is a fresh device without any data stored inside:
- If this is not a fresh device,
- you may want to Clear Data before doing the step 10.1 mentioned above
- Or, you may want to Download Users and map them to existing employee or create a new employee accordingly
- Validate the result:
- All Device Users should link to a corresponding employee
- No unmapped employees shown on the device form view
Test Attendance Data download and synchronization
Do some check-in and check out at the physical device
- Wait for seconds between check in and check out
- Try some wrong actions: check in a few times before check out
Come back to the device form view in Odoo
- Hit Download Attendance Data and wait for its completion. For just a few attendance records, it may take only a couple of seconds even
your device is located in a country other than the Odoo instance's
Validate the result
- Navigating to Attendances > Attendance Devices > Attendance Data to validate if the attendance log is recorded there.
- If found, you are done now. You can continue with the following steps to bring the new device into production
- Clear the sample attendance data you have created:
- Navigate to Attendances > Attendance Devices > Attendance Data, find and delete those sample records
- Navigate to Attendances > Attendance Devices > Synchronize and hit Clear Attendance Data button
- Hit the Confirmed state in the header of the device form view. If you don't do it, the schedulers will ignore the device during their runs
- If not found, there should be some trouble that need further investigation
- Check the connection
- Try to get the device information
- Check the work codes of the device if they are match with the ones specified in the "Attendance Status Codes" table in the device form view
- Contact the author of the "Attendance Device" application if you could not solve the problem your self.
Set up for a new Employee
- Create an employee as usual
- Hit the Action button in the header area of the employee form view to find the menu item "Upload to Attendance Machine" in the dropped down list
- Select the device(s) that will be used for this employee then hit Upload Employees button
- You can also do mass upload by selecting employees from the employee list view. Or go to the devices
How the automation works
There are two schedule actions:
- Download attendances scheduler: By default, it runs every 30 minutes to
- Download the attendance log/data from all your devices that are set in Confirmed status. Devices that are not in this status will be ignored
- Create User Attendance records in your Odoo database
- Depending on the configuration you made on the devices, it may also do the following automatically
- Create new employees and map with the corresponding device users if new users are found in the devices
- Clear the attendance data from the device if it's time to do it.
- Synchronize attendances scheduler: By default, it runs every 30 minutes to
- find the valid attendance in the user attendance log
- create HR Attendance records from such the log
This software and associated files (the "Software") may only be
used
(executed, modified, executed after modifications) if you have
purchased a
valid license from the authors, typically via Odoo Apps,
or if you
have
received a written agreement from the authors of the
Software (see the
COPYRIGHT file).
You may develop Odoo modules that use the Software as a library
(typically
by depending on it, importing it and using its
resources), but
without
copying any source code or material from the
Software. You may distribute
those modules under the license of your
choice, provided that this
license
is compatible with the terms of
the Odoo Proprietary License (For
example:
LGPL, MIT, or proprietary
licenses similar to this one).
It is forbidden to publish, distribute, sublicense, or sell
copies of the
Software or modified copies of the Software.
The above copyright notice and this permission notice must be
included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT
SHALL THE
AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING
FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE
SOFTWARE.
