2
2
Kiosks
3
3
======
4
4
5
- Odoo's *Attendances * app allows employees to check in and out of work directly from the database, or
6
- from a kiosk.
5
+ Odoo's ** Attendances ** app allows employees to check in and out of work directly from the database,
6
+ or from a kiosk.
7
7
8
8
A kiosk is a :doc: `dedicated device <hardware >` (a PC, tablet, or mobile phone) for employees to use
9
9
when they check in and out.
10
10
11
11
Kiosks are needed for employees who do **not ** have access to the database.
12
12
13
- Only employees with access to the database can check in and out from the *Attendances * app, and they
14
- are referred to as *users *.
13
+ Only employees with access to the database can check in and out from the ** Attendances ** app, and
14
+ they are referred to as *users *.
15
15
16
16
.. important ::
17
17
If employees :ref: `check in and out <attendances/kiosk-mode-entry >` using a badge or an RFID,
@@ -21,20 +21,22 @@ are referred to as *users*.
21
21
Configuration
22
22
=============
23
23
24
- There are only a few configurations needed to use kiosks in the *Attendances * application. Navigate
25
- to :menuselection: `Attendances app --> Configuration ` to access the :guilabel: `Settings ` page to
26
- configure the :ref: `attendances/kiosk-mode ` and the :ref: `attendances/kiosk-settings `.
24
+ There are only a few configurations needed to use kiosks in the **Attendances ** application.
25
+ Navigate to :menuselection: `Attendances app --> Configuration ` to access the :guilabel: `Settings `
26
+ page to configure the :ref: `Modes section <attendances/kiosk-mode >` and the
27
+ :ref: `attendances/kiosk-settings `.
27
28
28
29
Once all desired settings have been configured, click the :guilabel: `Save ` button on the
29
30
:guilabel: `Settings ` page, to activate and enable them.
30
31
31
32
.. _attendances/kiosk-mode :
32
33
33
- Kiosk Mode section
34
- ------------------
34
+ Modes section
35
+ -------------
35
36
36
- Using the drop-down menu, select how an employee checks in when using a kiosk. Options are
37
- :guilabel: `Barcode/RFID `, :guilabel: `Barcode/RFID and Manual Selection `, or :guilabel: `Manual
37
+ On the settings page, using the drop-down menu for the :guilabel: `Kiosk Mode ` :icon: `fa-building-o `
38
+ field in the :guilabel: `Modes ` section, select how an employee checks in when using a kiosk. Options
39
+ are :guilabel: `Barcode/RFID `, :guilabel: `Barcode/RFID and Manual Selection `, or :guilabel: `Manual
38
40
Selection `.
39
41
40
42
.. note ::
@@ -49,27 +51,28 @@ Kiosk Settings section
49
51
The various settings in the :guilabel: `Kiosk Settings ` section determine how employees check in and
50
52
out with kiosks.
51
53
52
- - :guilabel: `Barcode Source `: this setting **only ** appears if one of the two *Barcode/RFID *
53
- selections were configured for the :ref: `Kiosk Mode <attendances/kiosk-mode >` setting.
54
+ - :guilabel: `Barcode Source ` :icon: `fa-building-o `: this setting **only ** appears if one of the two
55
+ *Barcode/RFID * selections were configured for the :ref: `Kiosk Mode <attendances/kiosk-mode >`
56
+ setting.
54
57
55
58
If available, select how barcodes are scanned at the kiosk, via one of the drop-down menu options.
56
59
Barcodes can be scanned with a dedicated :guilabel: `Scanner `, or with a device's camera
57
60
(:guilabel: `Front Camera ` or :guilabel: `Back Camera `).
61
+ - :guilabel: `Display Time ` :icon: `fa-building-o `: determine how many seconds a check-in/check-out
62
+ confirmation message remains on the kiosk screen before returning to the main check in screen.
58
63
- :guilabel: `Employee PIN Identification `: tick this checkbox if employees should use a unique PIN
59
64
to check in. PINs are configured on each individual employee record. Refer to the :ref: `new
60
65
employee documentation <employees/hr-settings>` documentation for more information on setting up
61
66
PINs.
62
- - :guilabel: `Display Time `: determine how many seconds a check-in/check-out confirmation message
63
- remains on the kiosk screen before returning to the main check in screen.
64
67
- :guilabel: `Attendance Kiosk Url `: Odoo generates a unique web address (URL) to use a device as a
65
68
kiosk, without having to sign in to the Odoo database. When setting up a kiosk device, navigate to
66
- this unique web address in a web browser to present the *Attendances * app kiosk.
69
+ this unique web address in a web browser to present the ** Attendances * * app kiosk.
67
70
68
71
.. important ::
69
72
These kiosk URLs are **not ** secured with any type of access code. Anyone who has the URL can
70
- access the *Attendances * app kiosk. If the URL is compromised for any reason, such as in the
71
- event of a security breach, click :guilabel: `Generate a new Kiosk Mode URL `, located beneath
72
- the link, to generate a new URL, and update the kiosk, accordingly.
73
+ access the ** Attendances * * app kiosk. If the URL is compromised for any reason, such as in the
74
+ event of a security breach, click :icon: ` fa-refresh ` : guilabel: `Generate new URL `, located
75
+ beneath the link, to generate a new URL, and update the kiosk, accordingly.
73
76
74
77
Kiosk mode
75
78
==========
@@ -86,17 +89,17 @@ Entering *Kiosk Mode* is **only** available for users with specific :ref:`access
86
89
Mode * on any device.
87
90
88
91
.. image :: kiosks/kiosk-url.png
89
- :align: center
90
92
:alt: The Attendances Kiosk URL field in the settings section of the Attendances application.
91
93
92
- As a security measure, once a device is in *Kiosk Mode *, it is not possible to go back into the
93
- database without signing back in.
94
+ .. important ::
95
+ As a security measure, once a device is in *Kiosk Mode *, it is not possible to go back into the
96
+ database without signing back in.
94
97
95
98
.. note ::
96
99
At any time, a new kiosk URL can be generated, if needed. Click the :icon: `fa-refresh `
97
100
:guilabel: `Generate a new Kiosk Mode URL `
98
101
99
- To exit *Kiosk Mode *, just close the tab in the web browser or return to the main log-in screen of
102
+ To exit *Kiosk Mode *, either close the tab in the web browser or return to the main log-in screen of
100
103
Odoo.
101
104
102
105
.. _attendances/kiosk-mode-entry :
@@ -107,11 +110,10 @@ Check in and out with a kiosk
107
110
Badge
108
111
-----
109
112
110
- To check in or out using a badge, tap the :icon: `fa-camera ` :guilabel: `Tap to scan ` image in the
111
- center of the kiosk.
113
+ To check in or out using a badge, tap the :icon: `fa-barcode ` :guilabel: `Scan your badge ` image in
114
+ the center of the kiosk.
112
115
113
116
.. image :: kiosks/scan-badge.png
114
- :align: center
115
117
:alt: The Attendances Kiosk view displaying the scan badge image.
116
118
117
119
Then, scan the barcode on the badge using the method configured in the :ref: `Kiosk Settings
@@ -133,20 +135,20 @@ Manually
133
135
134
136
Users who do not have a scannable badge, or an RFID fob, can manually check in and out at a kiosk.
135
137
136
- Tap the :guilabel: `Identify Manually ` button on the kiosk, and a screen appears with all the
137
- employees that can be checked in or out. The *Employees * application dashboard has the same display.
138
+ Tap the :icon: `fa-user-o ` :guilabel: `Identify Manually ` button on the kiosk, and a screen appears
139
+ with all the employees that can be checked in or out. The *Employees * application dashboard has the
140
+ same display.
138
141
139
142
Tap on a person to check them in or out, and a :ref: `confirmation message
140
143
<attendances/confirmation>` appears.
141
144
142
145
There are two ways to quickly find a specific person:
143
146
144
- - :guilabel: `Search... `: tap on the :guilabel: `Search... ` field, and enter the desired person's
145
- name. As the name is typed in, the matching results are displayed on the screen.
146
- - :guilabel: `Department `: tap on any desired selection in the :guilabel: `Department ` section,
147
- located on the left-side of the screen, to **only ** view employees from that specific department.
148
- The number at the end of each listed :guilabel: `Department ` represents how many employees that
149
- department has.
147
+ - Search: tap into the search bar and enter the desired person's name. As the name is typed in, the
148
+ matching results are displayed on the screen.
149
+ - By department: tap on any desired selection in the department section, located on the left-side of
150
+ the screen, to **only ** view employees from that specific department. The number at the end of
151
+ each listed department represents how many employees that department has.
150
152
151
153
PIN
152
154
~~~
@@ -156,15 +158,13 @@ If the :guilabel:`Employee PIN Identification` checkbox was ticked in the :ref:`
156
158
PIN when manually checking in or out.
157
159
158
160
After the employee is selected, a number pad appears with a message. When checking in,
159
- :guilabel: `(Employee) Welcome! Please enter your PIN to check in ` appears above the numbers. When
160
- checking out, :guilabel: `(Employee) Want to check out? Please enter your PIN to check out ` appears
161
- above the numbers.
161
+ :guilabel: `(Employee) Please enter your PIN to check in ` appears above the numbers. When checking
162
+ out, :guilabel: `(Employee) Please enter your PIN to check out ` appears above the numbers.
162
163
163
164
Tap in the PIN using the number pad, then tap :guilabel: `OK ` when done. The employee is then checked
164
165
in or out, and a :ref: `confirmation message <attendances/confirmation >` appears.
165
166
166
167
.. image :: kiosks/enter-pin.png
167
- :align: center
168
168
:alt: The pop-up that appears when prompted to enter a pin.
169
169
170
170
.. _attendances/confirmation :
@@ -173,19 +173,19 @@ Confirmation message
173
173
--------------------
174
174
175
175
When an employee checks in or out, a confirmation message appears, with all the check in or check
176
- out information. When checking in, a welcome message appears, as well as the date and time of check
177
- in.
176
+ out information.
178
177
179
- An :guilabel: `Hours Previously Today: HH:MM ` field also appears, displaying any time that has
180
- already been logged for that employee for the day. If no time has been logged, the value displayed
181
- is: `00:00 `. Beneath the message is an :guilabel: `OK ` button.
178
+ When checking in, :guilabel: `Welcome (Employee) ` appears, as well as the date and time of check in.
179
+ If an employee has already logged in and out on the sam day, When checking in, an :guilabel: `Hours
180
+ Previously Today: HH:MM ` message appears below the new check-in date and time, and details the total
181
+ hours and minutes previously logged for the day.
182
182
183
- To exit the screen before the preset time in the kiosk, tap the :guilabel: `OK ` button.
183
+ When checking out, :guilabel: `Goodbye (Employee) ` appears, as well as the date and time of check
184
+ out. Beneath the message is an :guilabel: `Hours Today: HH:MM ` field, with the total hours and
185
+ minutes logged for the day.
184
186
185
- When checking out, the screen displays a goodbye message, with the date and time of check out, and
186
- the total hours logged for the day. Beneath the message is a :guilabel: `Goodbye ` button. To exit the
187
- screen before the preset time, tap the :guilabel: `Goodbye ` button.
187
+ Beneath both the welcome and goobye messages is an :guilabel: `OK ` button. To exit the screen before
188
+ the preset time in the kiosk, tap the :guilabel: `OK ` button.
188
189
189
190
.. image :: kiosks/goodbye-message.png
190
- :align: center
191
191
:alt: The goodbye message with all the employee's check out information.
0 commit comments