Kiosk plugin

• Features
• Purchase
  • Compatibility
• Installation
  • Copy files
  • Clear cache
  • Create database
  • Install the bundle assets
• Configure the plugin
• Permissions
• Updating the plugin
• Screenshots

A Kimai 2 plugin, which allows to use 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 (eg. tablet) with a built-in camera.

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 from the emplyoee card

You can test it in the “Plugins” demo.

Features

• Start/Stop work with device camera or a hardware barcode scanner (eg. via USB)
• 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
• The following 1D barcodes are currently supported:
  • 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)
• New user profile screen for the “barcode”
  • Display current barcode (randomly generated if empty)
  • Regenerate random barcode
  • Re-use existing barcode for user
• User specific settings for allowed start and end time (user can only clock in between these times)

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.

Purchase

Compatibility

Please make sure to use the correct version of the plugin, which must be compatible with your Kimai version:

Installation

Copy files

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 like like this afterwards:

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

Clear cache

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:

bin/console kimai:reload --env=prod

bin/console cache:clear --env=prod
bin/console cache:warmup --env=prod

You might have to set file permissions afterwards:

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

Create database

Run the following command:

bin/console kimai:bundle:kiosk:install

This will install all required databases.

Install the bundle assets

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

bin/console assets:install

Configure the plugin

You have to configure the bundle before you can use it via the Plugin screen. Click the actions dropdown and select Preferences (see screenshot).

The following configurations are available:

• Login mode - whether to use camera or usb mode
• Barcode 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 ships a new permission, which limit access to certain functions:

• 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.

Please adjust all permission settings in your administration.

Updating the plugin

Updating the bundle works the same way as the installation does.

• Delete the directory var/plugins/KioskBundle/ (to remove deleted files)
• Execute all installation steps again:
  • Copy files
  • Clear cache
  • Update database with bin/console kimai:bundle:kiosk:install
  • Update assets with bin/console assets:install

Screenshots

When logged in as SUPER_ADMIN, change to the Plugins menu:

Open the plugins preferences, which you need to save once before you can use the plugin:

After updating the settings, change to the user menu. You will see a new entry in the action menu for every user:

Choose Barcode to open the users barcode:

This new barcode can now be printed and handed out to the user.

The Barcode with USB scanner login mode show a screen like this, the input field is pre-selected and the scanner will submit it after finding a code:

The Barcode with device cam login mode will show the camera video and scan constantly for barcodes:

When scanning an existing barcode and the user does not have a running record a new one will be started:

Or when a record is running, it will be stopped: