10000 [IMP] Attendances: Update overview section · odoo/documentation@86cc861 · GitHub
[go: up one dir, main page]

Skip to content

Commit 86cc861

Browse files
committed
[IMP] Attendances: Update overview section
closes #13195 X-original-commit: c9d3d22 Signed-off-by: Lara Martini (larm) <larm@odoo.com>
1 parent f729999 commit 86cc861

File tree

4 files changed

+96
-104
lines changed

4 files changed

+96
-104
lines changed

content/applications/hr/attendances.rst

Lines changed: 96 additions & 104 deletions
2851
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ to access the configuration menu.
7878
company-specific configuration. Items without an :icon:`fa-building-o` :guilabel:`(building)`
7979
icon apply to all companies within the database.
8080

81+
.. _attendances/modes:
82+
8183
Modes
8284
-----
8385

@@ -141,143 +143,137 @@ Overview
141143
========
142144

143145
When entering the **Attendances** application, the :guilabel:`Overview` dashboard is presented,
144-
containing all the check in and check out information for the signed in user. If the user has
145-
specific :ref:`access rights <attendances/access-rights>` and/or are :ref:`approvers
146-
<attendances/approvers>` for specific employees, then those additional employee's check in and check
147-
out information is also visible on the :guilabel:`Overview` dashboard.
148-
149-
Views
150-
-----
151-
152-
To change the view from the default Gantt chart to a list view, click the :guilabel:`List` icon in
153-
the top-right of the dashboard, beneath the user's photo. To switch back to the Gantt chart, click
154-
the :guilabel:`Gantt` button, located next to the :guilabel:`List` button.
146+
containing all the user's check in and check out information. If the user has the required
147+
:ref:`access rights <attendances/access-rights>` or is an :ref:`approver <attendances/approvers>`
148+
for specific employees, those employeess' check-in and check-out information also appears on the
149+
:guilabel:`Overview` dashboard.
155150

156-
The default view presents the current day's information. To present the information for the
157-
:guilabel:`Week`, :guilabel:`Month`, or :guilabel:`Year`, click on the :guilabel:`Day` button to
158-
reveal a drop-down, displaying those other options. Select the desired view, and the dashboard
159-
updates, presenting the selected information. To change the :guilabel:`Day`, :guilabel:`Week`,
160-
:guilabel:`Month`, or :guilabel:`Year` presented, click the :icon:`oi-arrow-left` :guilabel:`(left
161-
arrow)` or :icon:`oi-arrow-right` :guilabel:`(right arrow)` buttons on either side of the drop-down
162-
menu. To jump back to a view containing the current day, click the :guilabel:`Today` button. This
163-
refreshes the dashboard, presenting information containing the current day's information.
164-
165-
In the :guilabel:`Day` view, the column for the current hour is highlighted in yellow. If the
166-
:guilabel:`Week` or :guilabel:`Month` view is selected, the column for the current day is
167-
highlighted. If the :guilabel:`Year` view is selected, the current month is highlighted.
151+
The **Attendance** dashboard allows switching between :icon:`fa-tasks` :guilabel:`(Gantt)` and
152+
:icon:`oi-view-list` :guilabel:`(List)` views, and selecting a period to analyze. The current period
153+
is automatically highlighted in yellow for real-time attendance records, while the
154+
:icon:`fa-crosshairs` :guilabel:`(Focus Today)` button instantly returns the dashboard to the
155+
present date.
168156

169157
.. image:: attendances/overview.png
170158
:alt: The overview dashboard presenting the information for the week, with the current day
171159
highlighted.
172160

173-
Any entries that have errors appear in red, indicating they need to be resolved by a user with the
174-
proper :ref:`access rights <attendances/access-rights>` and/or are :ref:`approvers
175-
<attendances/approvers>` for the employees with the errors.
161+
.. note::
162+
Any entries that have errors appear in red, indicating they need to be resolved by a user with
163+
the proper :ref:`access rights <attendances/access-rights>` and/or are :ref:`approvers
164+
<attendances/approvers>` for the employees with the errors.
176165

177166
.. _attendances/filters-groups:
178167

179168
Filters and groups
169+
==================
170+
171+
Sometimes, attendance officers and managers need to view specific records, such as all automatic
172+
checkouts to determine which employees chronically forget to check-out, or by department, to
173+
determine which team is working the most overtime.
174+
175+
For these cases, use the search bar to select a :icon:`fa-filter` :guilabel:`Filters` or
176+
:icon:`oi-group` :guilabel:`Group By`, or combine these both to present the desired information.
177+
178+
.. seealso::
179+
:doc:`../essentials/search`
180+
181+
High-value filters
180182
------------------
181183

182-
To filter the results in the overview dashboard, or to present different groups of information,
183-
click the :icon:`fa-caret-down` :guilabel:`(Toggle Search Panel)` button in the right side of the
184-
:guilabel:`Search` bar above the dashboard, and select one of the available :guilabel:`Filters` or
185-
:guilabel:`Group By` options. Several preconfigured filters and groups are available to choose from,
186-
as well as an option to create custom ones.
187-
188-
Filters
189-
~~~~~~~
190-
191-
The default filters that can be selected are:
192-
193-
- :guilabel:`My Attendances`: this filter only presents the user's attendance data.
194-
- :guilabel:`My Team`: this filter presents the attendance data for the user's team.
195-
- :guilabel:`At Work`: this filter displays the attendance data for everyone currently checked in.
196-
- :guilabel:`Errors`: this filter displays any entries with :ref:`errors <attendances/errors>` that
197-
need to be resolved.
198-
- :guilabel:`Check In`: this filter has a drop-down to further select a specific time period. Select
199-
the desired time period from the options presented, a specific month, quarter, or year.
200-
- :guilabel:`Last 7 days`: this filter presents the attendance data for the last seven days.
201-
- :guilabel:`Add Custom Filter`: create a custom filter using the pop-up that appears when this is
202-
selected.
203-
204-
Groups
205-
~~~~~~
206-
207-
The default groups that can be selected are:
208-
209-
- :guilabel:`Check In`: this grouping presents a drop-down menu containing the following time period
210-
options: :guilabel:`Year`, :guilabel:`Quarter`, :guilabel:`Month`, :guilabel:`Week`, and
211-
:guilabel:`Day`. Selected the time period to display all the check-in information, grouped by the
212-
selected time period.
213-
- :guilabel:`Employee`: this group presents the attendance data organized by employee.
214-
- :guilabel:`Check Out`: this grouping presents a drop-down menu containing the following time
215-
period options: :guilabel:`Year`, :guilabel:`Quarter`, :guilabel:`Month`, :guilabel:`Week`, and
216-
:guilabel:`Day`. Selected the time period to display all the check-out information, grouped by the
217-
selected time period.
218-
- :guilabel:`Add Custom Group`: this option displays a drop-down menu with a variety of options to
219-
group the attendance data by, including :guilabel:`City`, :guilabel:`Country`, :guilabel:`Mode`,
220-
and :guilabel:`IP Address`.
184+
.. list-table::
185+
:header-rows: 1
186+
:stub-columns: 1
187+
:widths: 40 60
188+
189+
* - Filter
190+
- Common use case
191+
* - At Work
192+
- Verify employees still on-site before shutting down the building for the night, or to perform
193+
a head count.
194+
* - Errors
195+
- View all errors to correct them prior to payroll processing.
196+
* - Automatically Checked-Out
197+
- Perform an audit to determine employees who chronically forget to check-out of work.
198+
* - Date
199+
- Limit results to a specific pay-period or audit window.
200+
* - Active/Archived Employees
201+
- Switch between current staff and former employees when auditing historical data.
202+
203+
Insightful groupings
204+
--------------------
205+
206+
.. list-table::
207+
:header-rows: 1
208+
:stub-columns: 1
209+
:widths: 40 60
210+
211+
* - Group by
212+
- When it helps
213+
* - Employee
214+
- Review individual attendance records during a 1:1 meeting.
215+
* - Department
216+
- Compare staffing levels and working hours to determine over-working and under-working teams.
217+
* - Manager
218+
- Determine where attendance follow-up questions can be directed to for an employee.
219+
* - Method
220+
- Spot trends in attendance methods to potentially resolve hardware issues.
221+
* - Date (Day/Week/Month)
222+
- Identify absenteeism spikes or seasonal patterns.
221223

222224
.. _attendances/errors:
< 10000 /code>
223225

224226
Attendance log details
225-
----------------------
227+
======================
226228

227-
Odoo captures various time and location details when a user checks in and out. The specific details
228-
provided are determined by the method the user checked in and out.
229-
230-
To view the specific check in and/or check out details for an employee, click on an individual entry
231-
in the overview dashboard.
232-
233-
A detailed attendance log for the user appears in a pop-up window. To close the detailed attendance
234-
log, click the :guilabel:`Save & Close` button in the bottom-left corner of the form.
229+
Odoo records both the time and location for every check-in and check-out, with fields varying by the
230+
method used. These detailed attendance logs can confirm where an employee was on any given work day.
231+
This can be useful for companies with hybrid working schedules, who may need to perform audits to
232+
ensure proper compliance.
235233

236234
The detailed attendance log contains the following information:
237235

238236
Main details
239-
~~~~~~~~~~~~
237+
------------
240238

241239
- :guilabel:`Employee`: the name of the employee.
242240
- :guilabel:`Check In`: the date and time the employee checked in.
243-
- :guilabel:`Check Out`: the date and time the employee checked out. This only appears if the
241+
- :guilabel:`Check Out`: the date and time the employee checked out. This **only** appears if the
244242
employee has checked out.
245-
- :guilabel:`Worked Hours`: the total amount of time the employee logged for the day, in an hour and
246-
minute format (HH:MM). This value calculates all the checks in and check outs for the day, if the
247-
employee checked in and out multiple times.
248-
- :guilabel:`Extra Hours`: any extra hours the employee logged that is beyond their expected working
249-
hours.
243+
- :guilabel:`Worked Time`: the total amount of time the employee logged for the day, across multiple
244+
check-ins and outs. In an hour and minute format (HH:MM).
245+
- :guilabel:`Worked Extra Hours`: approved overtime (shows **only** when present for the employee).
246+
- :guilabel:`Extra Hours`: unpaid overtime hours worked beyond the expected working schedule (the
247+
:guilabel:`Worked Time` minus the approved :guilabel:`Worked Extra Hours`.
250248

251249
Check in/check out details
252-
~~~~~~~~~~~~~~~~~~~~~~~~~~
250+
--------------------------
253251

254252
The following information appears for both the :guilabel:`Check In` and :guilabel:`Check Out`
255253
sections.
256254

257-
- :guilabel:`Mode`: the method with which the attendance information was gathered.
258-
:guilabel:`Systray` is displayed if the employee logged in and out :ref:`directly from the
259-
database <attendances/check-in>`, :guilabel:`Manual` is displayed if the employee logged in and
260-
out :ref:`using an attendance kiosk <attendances/kiosk-mode-entry>`.
261-
- :guilabel:`IP Address`: the IP address for the computer the employee used to log in or out.
255+
- :guilabel:`Mode`: attendance submission method. Can be :ref:`Systray <attendances/check-in>`,
256+
:ref:`Kiosk <attendances/kiosk-mode-entry>`, or :guilabel:`Manual` entry.
257+
- :guilabel:`IP Address`: the device's IP address used to log in or out.
262258
- :guilabel:`Browser`: the web browser the employee used to log in or out.
263-
- :guilabel:`Localization`: the city and country associated with the computer's IP address.
259+
- :guilabel:`Localisation`: the city and country associated with the computer's IP address.
264260
- :guilabel:`GPS Coordinates`: the specific coordinates when the user logged in or out. To view the
265-
specific coordinates on a map, click the :guilabel:`View on Maps` button beneath the
266-
:guilabel:`GPS Coordinates`. This opens a map in a new browser tab, with the specific location
267-
pointed out.
261+
specific coordinates on a map, click the :icon:`oi-arrow-right` :guilabel:`View on Maps` button
262+
beneath the :guilabel:`GPS Coordinates`. This opens a map in a new browser tab, with the specific
263+
location pointed out.
268264

269265
.. image:: attendances/details.png
270266
:alt: The detailed information for an attendance entry.
271267

272-
Errors
273-
------
268+
Attendance errors
269+
=================
274270

275-
Entries that contain an error appear on the overview dashboard in red. In the :guilabel:`Gantt
276-
view`, the entry appears with a red background. If in the :guilabel:`List view`, the entry text
277-
appears in red.
271+
Entries that contain an error appear on the overview dashboard in red. In the :icon:`fa-tasks`
272+
:guilabel:`(Gantt)` view, the entry appears with a red background. If in the :icon:`oi-view-list`
273+
:guilabel:`(List)` view, the entry text appears in red.
278274

279-
An error typically occurs when an employee has checked in but has not checked out within the last 24
280-
hours, or when an employee has a check in and check out period spanning over 16 hours.
275+
An error occurs when an employee has checked in but not checked out within 24 hours, or when a
276+
single check-in period exceeds 16 hours.
281277

282278
To fix the error, the attendance entry must be modified or deleted. Click on the entry to reveal a
283279
pop-up containing the details for that particular entry. To modify the :guilabel:`Check In` and/or
@@ -286,15 +282,11 @@ and a calendar selector appears. Click on the desired date, then use the time se
286282
calendar to select the specific time for the entry. When the information is correct, click
287283
:guilabel:`Apply.`
288284

289-
.. image:: attendances/errors.png
290-
:alt: The pop-up that allows for modifications to an attendance entry with an error. The calendar
291-
selector is shown, and the time selector is highlighted.
292-
293285
When all the information on the pop-up is correct, click :guilabel:`Save & Close`. When the entry no
294286
longer has an error, the entry appears in gray instead of red.
295287

296-
To delete an entry, click :guilabel:`Remove` on the pop-up instead of making modifications to the
297-
entry.
288+
To delete an entry, click the red :guilabel:`Delete` button on the pop-up window instead of making
289+
modifications to the entry.
298290

299291
Reporting
300292
=========
-3.96 KB
Loading
-21.5 KB
Binary file not shown.
-3.93 KB
Loading

0 commit comments

Comments
 (0)
0