Compatible with Kimai 2.0

Kiosk Modus mit Barcode und RFID Unterstützung

Anwesenheitserfassung in einer Umgebung, in der Benutzer keinen Zugang zu Kimai haben (z. B. in einer Fertigungshalle). Mit Hilfeeines Barcode- oder RFID-Scanners oder einem persönlichen Codes können Zeiten gestartet und gestoppt werden.

Angeboten von

Kevin Papst

A Kimai plugin, which allows using barcodes for punch-in and punch-out time tracking with Kimai. You can use it with an attached barcode scanner, or you run Kimai on a device (e.g. tablet) with a built-in camera.

It also supports a “freestyle” mode, which allows to enter any free configurable code (up to 120 characters), so you can also use other devices for starting/stopping:

an electronic USB number-pad
an RFID scanner that acts as keyboard

If you want to use Kimai in a kiosk mode, where your users should only register their attendance time through
punch-in and punch-out mode when entering/leaving the building, then this bundle is the solution for you.

It could be as simple as:

Print the barcodes on your employee cards
Mount a tablet to the wall in your entrance room
Let your users check-in & check-out when entering the building by scanning the barcode of their employee card

You can test it in the “Plugins” demo.

Features

Start/Stop work with
- barcode scanner (via device camera, only works via HTTPS)
- barcode scanner (via USB or Bluetooth)
- RFID scanner (via USB or Bluetooth)
Upon starting/stopping a record via this plugin, the user will see a short overview screen with the entries of the current week (including some statistics)
New user profile screen for the “codes”
- Display all codes for user
- Generate a random code (automatically done if none is existing yet for the active code-type)
- Re-use existing code for user by entering (or scanning) it manually
User specific settings to configured allowed start and end working time (user can only clock in between these times)
Supports the following 1D barcodes:
- Code 128
- Code 39
- UPC-A (scanner needs to transmit check digit)
- Code 2 of 5
- Code 2 of 5 interleaved
- Codabar (scanner needs to transmit start & stop digits)
Optional: show active / inactive users in login screen
Many CSS classes to customize the look with Custom CSS Bundle

You need to configure a non-global activity for starting the record via this plugin. This will be used for every recorded timesheet that is created using the kiosk mode.

Hardware

This is NOT a hardware recommendation, but more an idea for possible use-cases.

I tried the linked products and even though all scanner are rather cheap, they work without problems.

Raspberry PI setup with touch screen (eg. for wall mount)
RFID scanner by Neuftech (desktop version)
RFID scanner by KKMoon (desktop version)
Barcode scanner which can also scan codes from mobile phones (desktop version)
Barcode scanner classic hand-held version

The above are affiliate links for Amazon (germany) where I bought them myself.

Configuration

You have to configure the bundle before you can use it - you reach the configuration via

the Plugin screen (Preferences in action dropdown behind the plugin)
the Kiosk administration (cogs icon in the upper right)
the System configuration (Kiosk & Barcode section)

The following configurations are available:

Configuration	Description
`Login mode`	whether to use camera or usb mode
`Code format`	you have to decide which code format you want to use
`Barcode includes readable code`	whether the barcode in the user profile will include the human readable code
`Duration to display confirmation dialog (in seconds)`	how long the start/stop screens will be shown after a successful scan
`Activity`	the non-global activity that will be used to track the times

Permissions

This bundle introduces new permissions, which limit access to certain functions:

Permission Name	Description
`barcode_own_profile`	allows to see and administrate barcode for the own user profile
`barcode_other_profile`	allows to see and administrate barcode for all user profiles
`kiosk_own_profile`	allows to configure user specific kiosk settings (eg. start and end time) for the own user profile
`kiosk_other_profile`	allows to configure user specific kiosk settings (eg. start and end time) for all user profiles

By default, these are granted to each user with the role ROLE_SUPER_ADMIN.

Read how to assign these permissions to your user roles in the permission documentation.

Installation

Dateien kopieren

Extract the ZIP file and upload the included directory and all files to your Kimai installation to the new directory:

var/plugins/KioskBundle/

The file structure needs to look like this afterwards:

var/plugins/
├── KioskBundle
│   ├── KioskBundle.php
|   └ ... more files and directories follow here ...

Cache leeren

After uploading the files, Kimai needs to know about the new plugin. It will be found once the cache was re-built. Call these commands from the Kimai directory:

How to reload Kimai cache

bin/console kimai:reload --env=prod

It is not advised, but in case the above command fails you could try:

rm -r var/cache/prod/*

You might have to set file permissions afterwards:

Adjust file permission

You have to allow PHP (your webserver process) to write to var/ and it subdirectories.

Here is an example for Debian/Ubuntu (to be executed inside the Kimai directory):

chown -R :www-data .
chmod -R g+r .
chmod -R g+rw var/

Test Kimai before executing these commands (they are likely not required in a shared-hosting environment). You probably need to prefix them with sudo and the group might be called different than www-data.

Datenbank erstellen

Run the following command:

bin/console kimai:bundle:kiosk:install

This will create the required database tables and update them to the latest version.

If you see an error like There are no commands defined in the "kimai:bundle:XYZ" namespace., then either the directory has a wrong name (must be var/plugins/KioskBundle/) or you forgot to clear the cache (look above).

Assets installieren

The following command will install the required assets (images, javascripts, styles):

bin/console assets:install

Aktualisierung

Updating the plugin works exactly like the installation:

Delete the directory var/plugins/KioskBundle/
Execute all installation steps again:
- Dateien kopieren
- Cache leeren
- Update database with bin/console kimai:bundle:kiosk:install
- Update assets with bin/console assets:install