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.

Kevin Papst
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.

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.

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/

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.

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

Kompatibilität

Die folgende Tabelle enthält einen Vergleich zwischen Plugin und benötigter Kimai Version.

Plugin Version Minimale Kimai Version
2.5.0 2.1.0
2.4.0 2.0.33
2.3.0 - 2.3.1 2.0.29
2.2.1 2.0.20
2.0 - 2.2.0 2.0
1.9 1.15
1.7 1.14

Demo

Sie können das Plugin testen auf demo.kimai.org:

Benutzername: susan_super
Passwort: kitten

Weitere Zugänge finden Sie hier.

Bilder

Screenshot
Übersicht der Liste aller Benutzer mit deren hinterlegten Anmelde-Codes
Screenshot
Einstellungen des Kiosk-Plugins, der Anmeldemodus und das Code-Format sind voneinander abhängig
Screenshot
Dieser neue Barcode kann nun gedruckt und den Benutzern ausgehändigt werden
Screenshot
Der Barcode mit USB Scanner Modus zeigt einen Bildschirm mit Eingabefeld, welches durch den Scanner nach Auslesen des Codes abgesendet wird
Screenshot
Die Anmeldemaske mit optionaler Benutzerübersicht (Anwesend, Abwesend)
Screenshot
Der Anmeldemodus Barcode mit Gerätekamera wird show the camera video and scan constantly for barcodes
Screenshot
Der Scan eines existierenden Codes startet eine neue Zeitmessung
Screenshot
Oder wenn ein laufende Zeitmessung existiert, wird diese gestoppt

Kaufen

You can buy the plugin via Lemon Squeezy (CreditCard, instant access) or from the developer (bank-transfer, up to one week)

Support-questions, bug-reports and feature-requests will be answered in this Github repository

Angeboten von

Kevin Papst

Building Kimai since 2009

Wenn Sie Fragen haben, nutzen Sie bitte die folgenden Informationen, um den Entwickler direkt zu kontaktieren.
Top