Kiosk mode
Kiosk mode with support for Barcode, RFID, Web NFC
- 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)
- Web NFC (see docs)
- 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
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.
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 |
Which login mode should be used |
Allow Camera-switch |
Requires browser-access approval in the used device |
Hide entered/scanned code |
The browsers password manager needs to be disabled |
Placeholder for input field |
Some text, which will be displayed in the login input field (e.g. for assisting your users) |
Code format |
Use Freestyle for everything except barcodes, for which you need to select the used barcode type |
Barcode includes readable code |
Whether the barcode in the user profile will include the human readable code |
Activity |
The non-global activity that will be used to track the times |
Hide logo on confirmation page |
Do not display the logo (Kimai/Your Company) on the login screens |
Show "not logged in" users on login screen |
Show all active users that do not have a running timesheet (hides System-Accounts) |
Show "logged in" users on login screen |
Show all active users that have a running timesheet (hides System-Accounts) |
Save client IP for new timesheets |
Stores the Client IP in a custom-field if activated |
Duration of confirmation dialog |
How long the start/stop screens will be shown after a successful scan (in seconds) |
Play a short sound for logins and logouts |
On successful login and logout a short sound will be played |
Prevent page reload in login process |
If enabled, the reload of the submitted login page will be prevented |
Stop only kiosk activities when clocking out |
If enabled, all “non-kiosk activities” will not be stopped for the user when clocking out |
Login modes
Free Input (e.g. keyboard)
A free text input field where a user can manually enter a code, like a personal code.
Also used in combination with Web NFC or similar tokens.
Barcode via USB scanner
A text input field, which will submit the scanned barcode.
Barcode via device camera
Opens a camera screen on the website and then a javascript tool tries to find a barcode on the scanned area.
Needs the Code format
to be configured correctly.
This mode has limitations and should ONLY be used for test purposes. Use a dedicated barcode scanner for production usage.
Permissions
This bundle introduces new permissions, which limit access to certain functions:
Permission Name | Description |
---|---|
kiosk_admin |
whether the current user can see the Kiosk administration and assign codes |
kiosk_own_profile |
configure codes and user specific kiosk settings (eg. start and end time) for own account |
kiosk_other_profile |
configure codes and user specific kiosk settings (eg. start and end time) for other accounts |
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.