[ADD] Attendances: new kiosk mode doc
closes odoo/documentation#9832 Signed-off-by: Lara Martini (larm) <larm@odoo.com>
This commit is contained in:
Lara Martini (larm)
parent
8f5909a0cb
commit
d383da505d
@ -66,48 +66,10 @@ Configuration` to access the configuration menu.
|
||||
Modes
|
||||
-----
|
||||
|
||||
.. _attendances/kiosk-mode:
|
||||
|
||||
- :guilabel:`Kiosk Mode`: using the drop-down menu, select how an employee checks in when using a
|
||||
kiosk. Options are :guilabel:`Barcode/RFID`, :guilabel:`Barcode/RFID and Manual Selection`, or
|
||||
:guilabel:`Manual Selection`.
|
||||
|
||||
.. important::
|
||||
The *Barcode* application **does not** need to be installed to use one of the Barcode/RFID
|
||||
settings.
|
||||
|
||||
- :guilabel:`Attendances from Backend`: activate this selection to allow users to check in and out
|
||||
directly from the Odoo database. If this is not activated, users must use a kiosk to check in and
|
||||
out of work.
|
||||
|
||||
.. _attendances/kiosk-settings:
|
||||
|
||||
Kiosk settings
|
||||
--------------
|
||||
|
||||
This section only needs to be configured if employees use kiosks for checking in and out. If kiosks
|
||||
are **not** being used, modifying any of these fields does **not** adversely affect the
|
||||
*Attendances* application.
|
||||
|
||||
- :guilabel:`Barcode Source`: this setting appears **only** if either of the two Barcode/RFID
|
||||
selections were configured for the :ref:`Kiosk Mode <attendances/kiosk-mode>` setting. Select how
|
||||
barcodes are scanned at the kiosk, either with a dedicated barcode :guilabel:`Scanner`, or the
|
||||
device's :guilabel:`Front Camera`, or :guilabel:`Back Camera`.
|
||||
- :guilabel:`Employee PIN Identification`: activate this option if employees should use a unique PIN
|
||||
to check in. PINs are configured on each individual employee record. Refer to the
|
||||
:doc:`../hr/employees/new_employee` documentation for more information on setting up PINs.
|
||||
- :guilabel:`Display Time`: set the duration (in seconds) the check in and check out confirmation
|
||||
screen remains on the kiosk before going back to the main check in screen.
|
||||
- :guilabel:`Attendance Kiosk Url`: Odoo generates a unique web address (URL) to use a device as a
|
||||
kiosk without having to sign in to the Odoo database. When setting up a kiosk device, navigate to
|
||||
this unique web address in a web browser to present the Attendances application kiosk.
|
||||
|
||||
.. important::
|
||||
These kiosk URLs are **not** secured with any type of access code. Anyone who has the URL can
|
||||
access the Attendances application kiosk. If the URL is compromised for any reason, such as in
|
||||
the event of a security breach, click :guilabel:`Generate a new Kiosk Mode URL`, located
|
||||
beneath the link, to generate a new URL and update the kiosk accordingly.
|
||||
|
||||
Extra hours
|
||||
-----------
|
||||
|
||||
@ -151,122 +113,6 @@ time is not logged.
|
||||
activated, the extra hours can be :ref:`deducted from an approved time off request
|
||||
<time_off/deduct-extra-hours>`.
|
||||
|
||||
.. _attendances/kiosk-mode-entry:
|
||||
|
||||
Kiosk mode
|
||||
==========
|
||||
|
||||
Some companies may opt to use a dedicated device (a laptop or desktop PC, a tablet, or a mobile
|
||||
phone) for employees to check in and check out from. Kiosk mode is used for these scenarios.
|
||||
|
||||
.. important::
|
||||
If users check in and out using either a badge or an RFID, then an accessible device in kiosk
|
||||
mode **must** be available to check in and check out using these two methods.
|
||||
|
||||
Entering kiosk mode is only available for users with specific :ref:`access rights
|
||||
<attendances/access-rights>`.
|
||||
|
||||
Kiosk mode can be activated in three different ways:
|
||||
|
||||
#. Navigate to the :guilabel:`Attendances` application, and click :guilabel:`Kiosk Mode` in the top
|
||||
menu. The device then enters kiosk mode.
|
||||
#. Navigate to the :menuselection:`Attendances application --> Configuration`. In the
|
||||
:guilabel:`Kiosk Settings` section, click on the link in the :guilabel:`Attendance Kiosk Url`
|
||||
field. A new tab opens in kiosk mode. It is recommended to close the database tab to keep the
|
||||
database secure.
|
||||
#. Navigate to the :menuselection:`Attendances application --> Configuration`. In the
|
||||
:guilabel:`Kiosk Settings` section, click :guilabel:`Copy` next to the link beneath the
|
||||
:guilabel:`Attendance Kiosk Url` field. Paste this URL into a web browser on the kiosk device and
|
||||
navigate to it.
|
||||
|
||||
.. image:: attendances/kiosk-url.png
|
||||
:align: center
|
||||
:alt: The Attendances Kiosk URL field in the settings section of the Attendances application.
|
||||
|
||||
As a security measure, once a device is in kiosk mode, it is not possible to exit kiosk mode and go
|
||||
back into the database without signing back in. To exit kiosk mode, click the back button in the web
|
||||
browser. This logs the user out of the database, and returns to the main log in screen. This adds an
|
||||
extra layer of security, preventing anyone from accessing the database.
|
||||
|
||||
Badge
|
||||
-----
|
||||
|
||||
To check in or out using a badge, tap the :guilabel:`📷 (camera) Tap to scan` image in the center of
|
||||
the kiosk. Then, scan the barcode on the badge using the method configured in the :ref:`kiosk
|
||||
settings <attendances/kiosk-settings>` section of the configuration menu. Options are a dedicated
|
||||
barcode scanning device, or the kiosk's front or back camera. Once the barcode is scanned, the
|
||||
employee is checked in or out, and a :ref:`confirmation message <attendances/confirmation>` appears
|
||||
with all the check in or check out information.
|
||||
|
||||
.. image:: attendances/scan-badge.png
|
||||
:align: center
|
||||
:alt: The Attendances Kiosk view displaying the scan badge image.
|
||||
|
||||
RFID
|
||||
----
|
||||
|
||||
To check in or out using an RFID key fob, simply scan the fob with an RFID reader. Once scanned, the
|
||||
employee is then either checked in or checked out, and a :ref:`confirmation message
|
||||
<attendances/confirmation>` appears with all the check in or check out information.
|
||||
|
||||
Manually
|
||||
--------
|
||||
|
||||
Users who do not have a scannable badge or an RFID fob can manually check in and out at a kiosk. Tap
|
||||
the :guilabel:`Identify Manually` button on the kiosk, and a screen with all the employees that can
|
||||
be checked in or out appears. This is the same view as in the *Employees* application dashboard. Tap
|
||||
on the person, and they are either checked in or checked out, and a :ref:`confirmation message
|
||||
<attendances/confirmation>` appears.
|
||||
|
||||
When a large number of employees appear in the list, making scrolling inefficient, there are two
|
||||
ways to quickly find a specific person:
|
||||
|
||||
- :guilabel:`Search...`: tap on the :guilabel:`Search...` field and enter the person's name. As the
|
||||
name is typed in, the matching results are displayed on the screen.
|
||||
- :guilabel:`Department`: to quickly filter the presented employees, tap on a department to display
|
||||
only those employees that are part of that department. The :guilabel:`Departments` are listed on
|
||||
the left side of the screen, and the number at the end of each department indicates how many
|
||||
employees are part of the department, and is displayed when selected.
|
||||
|
||||
PIN
|
||||
~~~
|
||||
|
||||
If the :guilabel:`Employee PIN Identification` option was activated in the :ref:`kiosk settings
|
||||
<attendances/kiosk-settings>` section of the configuration menu, the employee is prompted to enter a
|
||||
PIN when manually checking in or out.
|
||||
|
||||
After the employee is selected, a number pad appears with a message. When checking in,
|
||||
:guilabel:`(Employee) Welcome! Please enter your PIN to check in` appears above the numbers. When
|
||||
checking out, :guilabel:`(Employee) Want to check out? Please enter your PIN to check out` appears
|
||||
above the numbers.
|
||||
|
||||
Tap in the PIN using the number pad, then tap :guilabel:`OK` when done. The employee is then checked
|
||||
in or out, and a :ref:`confirmation message <attendances/confirmation>` appears.
|
||||
|
||||
.. image:: attendances/enter-pin.png
|
||||
:align: center
|
||||
:alt: The pop-up that appears when prompted to enter a pin.
|
||||
|
||||
.. _attendances/confirmation:
|
||||
|
||||
Confirmation message
|
||||
--------------------
|
||||
|
||||
When an employee checks in or out, a confirmation message appears with all the check in or check out
|
||||
information. When checking in, a welcome message appears, as well as the date and time of check in.
|
||||
An :guilabel:`Hours Previously Today: HH:MM` field also appears, displaying any time already logged
|
||||
for that employee for the day. If no time has already been logged, the value displayed is `00:00`.
|
||||
Beneath the message is an :guilabel:`OK` button. To exit the screen before the preset time in the
|
||||
kiosk, tap the :guilabel:`OK` button.
|
||||
|
||||
When checking out, the screen displays a goodbye message, with the date and time of check out, and
|
||||
the total hours logged for the day. Beneath the message is a :guilabel:`Goodbye` button. To exit the
|
||||
screen before the preset time, tap the :guilabel:`Goodbye` button.
|
||||
|
||||
.. image:: attendances/goodbye-message.png
|
||||
:align: center
|
||||
:alt: The goodbye message with all the employee's check out information.
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
@ -458,10 +304,12 @@ button and a pop-up appears. Select the desired spreadsheet, and click :guilabel
|
||||
|
||||
.. seealso::
|
||||
- :doc:`attendances/check_in_check_out`
|
||||
- :doc:`attendances/kiosks`
|
||||
- :doc:`attendances/hardware`
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
attendances/check_in_check_out
|
||||
attendances/kiosks
|
||||
attendances/hardware
|
||||
|
||||
191
content/applications/hr/attendances/kiosks.rst
Normal file
191
content/applications/hr/attendances/kiosks.rst
Normal file
@ -0,0 +1,191 @@
|
||||
======
|
||||
Kiosks
|
||||
======
|
||||
|
||||
Odoo's *Attendances* app allows employees to check in and out of work directly from the database, or
|
||||
from a kiosk.
|
||||
|
||||
A kiosk is a :doc:`dedicated device <hardware>` (a PC, tablet, or mobile phone) for employees to use
|
||||
when they check in and out.
|
||||
|
||||
Kiosks are needed for employees who do **not** have access to the database.
|
||||
|
||||
Only employees with access to the database can check in and out from the *Attendances* app, and they
|
||||
are referred to as *users*.
|
||||
|
||||
.. important::
|
||||
If employees :ref:`check in and out <attendances/kiosk-mode-entry>` using a badge or an RFID,
|
||||
then an :doc:`accessible device <hardware>` in :ref:`Kiosk Mode <attendances/kiosk-mode>`
|
||||
**must** be available in order to use these two methods.
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
There are only a few configurations needed to use kiosks in the *Attendances* application. Navigate
|
||||
to :menuselection:`Attendances app --> Configuration` to access the :guilabel:`Settings` page to
|
||||
configure the :ref:`attendances/kiosk-mode` and the :ref:`attendances/kiosk-settings`.
|
||||
|
||||
Once all desired settings have been configured, click the :guilabel:`Save` button on the
|
||||
:guilabel:`Settings` page, to activate and enable them.
|
||||
|
||||
.. _attendances/kiosk-mode:
|
||||
|
||||
Kiosk Mode section
|
||||
------------------
|
||||
|
||||
Using the drop-down menu, select how an employee checks in when using a kiosk. Options are
|
||||
:guilabel:`Barcode/RFID`, :guilabel:`Barcode/RFID and Manual Selection`, or :guilabel:`Manual
|
||||
Selection`.
|
||||
|
||||
.. note::
|
||||
The *Barcode* application **does not** need to be installed to use one of the Barcode/RFID
|
||||
settings.
|
||||
|
||||
.. _attendances/kiosk-settings:
|
||||
|
||||
Kiosk Settings section
|
||||
----------------------
|
||||
|
||||
The various settings in the :guilabel:`Kiosk Settings` section determine how employees check in and
|
||||
out with kiosks.
|
||||
|
||||
- :guilabel:`Barcode Source`: this setting **only** appears if one of the two *Barcode/RFID*
|
||||
selections were configured for the :ref:`Kiosk Mode <attendances/kiosk-mode>` setting.
|
||||
|
||||
If available, select how barcodes are scanned at the kiosk, via one of the drop-down menu options.
|
||||
Barcodes can be scanned with a dedicated :guilabel:`Scanner`, or with a device's camera
|
||||
(:guilabel:`Front Camera` or :guilabel:`Back Camera`).
|
||||
- :guilabel:`Employee PIN Identification`: tick this checkbox if employees should use a unique PIN
|
||||
to check in. PINs are configured on each individual employee record. Refer to the :ref:`new
|
||||
employee documentation <employees/hr-settings>` documentation for more information on setting up
|
||||
PINs.
|
||||
- :guilabel:`Display Time`: determine how many seconds a check-in/check-out confirmation message
|
||||
remains on the kiosk screen before returning to the main check in screen.
|
||||
- :guilabel:`Attendance Kiosk Url`: Odoo generates a unique web address (URL) to use a device as a
|
||||
kiosk, without having to sign in to the Odoo database. When setting up a kiosk device, navigate to
|
||||
this unique web address in a web browser to present the *Attendances* app kiosk.
|
||||
|
||||
.. important::
|
||||
These kiosk URLs are **not** secured with any type of access code. Anyone who has the URL can
|
||||
access the *Attendances* app kiosk. If the URL is compromised for any reason, such as in the
|
||||
event of a security breach, click :guilabel:`Generate a new Kiosk Mode URL`, located beneath
|
||||
the link, to generate a new URL, and update the kiosk, accordingly.
|
||||
|
||||
Kiosk mode
|
||||
==========
|
||||
|
||||
Entering *Kiosk Mode* is **only** available for users with specific :ref:`access rights
|
||||
<attendances/access-rights>`.
|
||||
|
||||
*Kiosk Mode* can be activated in two different ways:
|
||||
|
||||
#. Navigate to the :menuselection:`Attendances app`, and click :guilabel:`Kiosk Mode` in the top
|
||||
menu. The device then signs out of Odoo and enters *Kiosk Mode*.
|
||||
#. Navigate to the :menuselection:`Attendances app --> Configuration`. In the :guilabel:`Kiosk
|
||||
Settings` section, use the link in the :guilabel:`Attendance Kiosk Url` field to open *Kiosk
|
||||
Mode* on any device.
|
||||
|
||||
.. image:: kiosks/kiosk-url.png
|
||||
:align: center
|
||||
:alt: The Attendances Kiosk URL field in the settings section of the Attendances application.
|
||||
|
||||
As a security measure, once a device is in *Kiosk Mode*, it is not possible to go back into the
|
||||
database without signing back in.
|
||||
|
||||
.. note::
|
||||
At any time, a new kiosk URL can be generated, if needed. Click the :icon:`fa-refresh`
|
||||
:guilabel:`Generate a new Kiosk Mode URL`
|
||||
|
||||
To exit *Kiosk Mode*, just close the tab in the web browser or return to the main log-in screen of
|
||||
Odoo.
|
||||
|
||||
.. _attendances/kiosk-mode-entry:
|
||||
|
||||
Check in and out with a kiosk
|
||||
=============================
|
||||
|
||||
Badge
|
||||
-----
|
||||
|
||||
To check in or out using a badge, tap the :icon:`fa-camera` :guilabel:`Tap to scan` image in the
|
||||
center of the kiosk.
|
||||
|
||||
.. image:: kiosks/scan-badge.png
|
||||
:align: center
|
||||
:alt: The Attendances Kiosk view displaying the scan badge image.
|
||||
|
||||
Then, scan the barcode on the badge using the method configured in the :ref:`Kiosk Settings
|
||||
<attendances/kiosk-settings>` section of the configuration menu.
|
||||
|
||||
Once the barcode is scanned, the employee is checked in or out, and a :ref:`confirmation message
|
||||
<attendances/confirmation>` appears with all the information.
|
||||
|
||||
RFID
|
||||
----
|
||||
|
||||
To check in or out using an RFID key fob, simply scan the fob with an RFID reader.
|
||||
|
||||
Once scanned, the employee is either checked in or checked out, and a :ref:`confirmation message
|
||||
<attendances/confirmation>` appears with all the information.
|
||||
|
||||
Manually
|
||||
--------
|
||||
|
||||
Users who do not have a scannable badge, or an RFID fob, can manually check in and out at a kiosk.
|
||||
|
||||
Tap the :guilabel:`Identify Manually` button on the kiosk, and a screen appears with all the
|
||||
employees that can be checked in or out. The *Employees* application dashboard has the same display.
|
||||
|
||||
Tap on a person to check them in or out, and a :ref:`confirmation message
|
||||
<attendances/confirmation>` appears.
|
||||
|
||||
There are two ways to quickly find a specific person:
|
||||
|
||||
- :guilabel:`Search...`: tap on the :guilabel:`Search...` field, and enter the desired person's
|
||||
name. As the name is typed in, the matching results are displayed on the screen.
|
||||
- :guilabel:`Department`: tap on any desired selection in the :guilabel:`Department` section,
|
||||
located on the left-side of the screen, to **only** view employees from that specific department.
|
||||
The number at the end of each listed :guilabel:`Department` represents how many employees that
|
||||
department has.
|
||||
|
||||
PIN
|
||||
~~~
|
||||
|
||||
If the :guilabel:`Employee PIN Identification` checkbox was ticked in the :ref:`Kiosk Settings
|
||||
<attendances/kiosk-settings>` section of the configuration menu, the employee is prompted to enter a
|
||||
PIN when manually checking in or out.
|
||||
|
||||
After the employee is selected, a number pad appears with a message. When checking in,
|
||||
:guilabel:`(Employee) Welcome! Please enter your PIN to check in` appears above the numbers. When
|
||||
checking out, :guilabel:`(Employee) Want to check out? Please enter your PIN to check out` appears
|
||||
above the numbers.
|
||||
|
||||
Tap in the PIN using the number pad, then tap :guilabel:`OK` when done. The employee is then checked
|
||||
in or out, and a :ref:`confirmation message <attendances/confirmation>` appears.
|
||||
|
||||
.. image:: kiosks/enter-pin.png
|
||||
:align: center
|
||||
:alt: The pop-up that appears when prompted to enter a pin.
|
||||
|
||||
.. _attendances/confirmation:
|
||||
|
||||
Confirmation message
|
||||
--------------------
|
||||
|
||||
When an employee checks in or out, a confirmation message appears, with all the check in or check
|
||||
out information. When checking in, a welcome message appears, as well as the date and time of check
|
||||
in.
|
||||
|
||||
An :guilabel:`Hours Previously Today: HH:MM` field also appears, displaying any time that has
|
||||
already been logged for that employee for the day. If no time has been logged, the value displayed
|
||||
is: `00:00`. Beneath the message is an :guilabel:`OK` button.
|
||||
|
||||
To exit the screen before the preset time in the kiosk, tap the :guilabel:`OK` button.
|
||||
|
||||
When checking out, the screen displays a goodbye message, with the date and time of check out, and
|
||||
the total hours logged for the day. Beneath the message is a :guilabel:`Goodbye` button. To exit the
|
||||
screen before the preset time, tap the :guilabel:`Goodbye` button.
|
||||
|
||||
.. image:: kiosks/goodbye-message.png
|
||||
:align: center
|
||||
:alt: The goodbye message with all the employee's check out information.
|
||||
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 5.7 KiB After Width: | Height: | Size: 5.7 KiB |
Loading…
Reference in New Issue
Block a user