[IMP] Attendances: updating kiosks
closes odoo/documentation#13004 Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
@@ -2,16 +2,16 @@
|
||||
Kiosks
|
||||
======
|
||||
|
||||
Odoo's *Attendances* app allows employees to check in and out of work directly from the database, or
|
||||
from a kiosk.
|
||||
Odoo's **Attendances** app allows employees to check in and out of work directly from the database
|
||||
or 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*.
|
||||
Only employees with access to the Odoo 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,
|
||||
@@ -21,24 +21,29 @@ are referred to as *users*.
|
||||
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`.
|
||||
To use kiosks in the **Attendances** application, navigate to :menuselection:`Attendances app -->
|
||||
Configuration`. On the :guilabel:`Settings` page, configure the :ref:`Modes section
|
||||
<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
|
||||
------------------
|
||||
Modes section
|
||||
-------------
|
||||
|
||||
Using the drop-down menu, select how an employee checks in when using a kiosk. Options are
|
||||
Determine how an employee checks in when using a kiosk, either by searching for their name on the
|
||||
kiosk (:guilabel:`Manual Selection`), scanning an employee ID or key fob (:guilabel:`Barcode/RFID`).
|
||||
or both.
|
||||
|
||||
On the settings page, using the drop-down menu for the :guilabel:`Kiosk Mode` :icon:`fa-building-o`
|
||||
field in the :guilabel:`Modes` section, make the desired selection. 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
|
||||
The **Barcode** application **does not** need to be installed to use one of the Barcode/RFID
|
||||
settings.
|
||||
|
||||
.. _attendances/kiosk-settings:
|
||||
@@ -49,27 +54,28 @@ 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.
|
||||
- :guilabel:`Barcode Source` :icon:`fa-building-o`: 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:`Display Time` :icon:`fa-building-o`: 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:`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.
|
||||
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.
|
||||
access the **Attendances** app kiosk. If the URL is compromised for any reason, such as in the
|
||||
event of a security breach, click :icon:`fa-refresh` :guilabel:`Generate new URL`, located
|
||||
beneath the link, to generate a new URL, and update the kiosk, accordingly.
|
||||
|
||||
Kiosk mode
|
||||
==========
|
||||
@@ -86,17 +92,17 @@ Entering *Kiosk Mode* is **only** available for users with specific :ref:`access
|
||||
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.
|
||||
.. important::
|
||||
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
|
||||
To exit *Kiosk Mode*, either close the tab in the web browser or return to the main log-in screen of
|
||||
Odoo.
|
||||
|
||||
.. _attendances/kiosk-mode-entry:
|
||||
@@ -107,11 +113,10 @@ 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.
|
||||
To check in or out using a badge, tap the :icon:`fa-barcode` :guilabel:`Scan your badge` 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
|
||||
@@ -123,7 +128,7 @@ Once the barcode is scanned, the employee is checked in or out, and a :ref:`conf
|
||||
RFID
|
||||
----
|
||||
|
||||
To check in or out using an RFID key fob, simply scan the fob with an RFID reader.
|
||||
To check in or out using an RFID key fob, 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.
|
||||
@@ -133,20 +138,20 @@ 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 the :icon:`fa-user-o` :guilabel:`Identify Manually` button on the kiosk, and a screen appears
|
||||
with all the employees that can be checked in or out. The **Employees** app 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:
|
||||
To find a specific person, either:
|
||||
|
||||
- :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.
|
||||
- Search: tap into the search bar and enter the desired person's name. As the name is typed in, the
|
||||
matching results are displayed on the screen.
|
||||
- By department: tap on any desired selection in the 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 department represents how many employees that department has.
|
||||
|
||||
PIN
|
||||
~~~
|
||||
@@ -156,15 +161,13 @@ If the :guilabel:`Employee PIN Identification` checkbox was ticked in the :ref:`
|
||||
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.
|
||||
:guilabel:`(Employee) Please enter your PIN to check in` appears above the numbers. When checking
|
||||
out, :guilabel:`(Employee) 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:
|
||||
@@ -173,19 +176,18 @@ 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.
|
||||
out information.
|
||||
|
||||
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.
|
||||
When checking in, the :guilabel:`Welcome (Employee)` message appears, along with the current date
|
||||
and time. If the employee has already checked in and out that day, an :guilabel:`Hours Previously
|
||||
Today: HH:MM` message also appears, showing the total hours logged earlier.
|
||||
|
||||
To exit the screen before the preset time in the kiosk, tap the :guilabel:`OK` button.
|
||||
When checking out, :guilabel:`Goodbye (Employee)` appears, as well as the date and time of check
|
||||
out. Beneath the message is an :guilabel:`Hours Today: HH:MM` field, with the total hours and
|
||||
minutes logged for the day.
|
||||
|
||||
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.
|
||||
Beneath both the "welcome" and "goodbye" messages is an :guilabel:`OK` button. To exit the screen
|
||||
before the preset time in the kiosk, tap the :guilabel:`OK` 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: 21 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 9.2 KiB |
|
Before Width: | Height: | Size: 5.7 KiB After Width: | Height: | Size: 22 KiB |