[ADD] Attendances: Overview

Author: larm-odoo

content/applications/hr/attendances.rst

@@ -78,6 +78,8 @@ to access the configuration menu.
    company-specific configuration. Items without an :icon:`fa-building-o` :guilabel:`(building)`
    icon apply to all companies within the database.
 
+.. _attendances/modes:
+
 Modes
 -----
 
@@ -137,165 +139,6 @@ when extra time is counted and what time is not logged.
    Approved extra hours can be :ref:`deducted from an approved time off request
    <time_off/deduct-extra-hours>`.
 
-Overview
-========
-
-When entering the **Attendances** application, the :guilabel:`Overview` dashboard is presented,
-containing all the check in and check out information for the signed in user. If the user has
-specific :ref:`access rights <attendances/access-rights>` and/or are :ref:`approvers
-<attendances/approvers>` for specific employees, then those additional employee's check in and check
-out information is also visible on the :guilabel:`Overview` dashboard.
-
-Views
------
-
-To change the view from the default Gantt chart to a list view, click the :guilabel:`List` icon in
-the top-right of the dashboard, beneath the user's photo. To switch back to the Gantt chart, click
-the :guilabel:`Gantt` button, located next to the :guilabel:`List` button.
-
-The default view presents the current day's information. To present the information for the
-:guilabel:`Week`, :guilabel:`Month`, or :guilabel:`Year`, click on the :guilabel:`Day` button to
-reveal a drop-down, displaying those other options. Select the desired view, and the dashboard
-updates, presenting the selected information. To change the :guilabel:`Day`, :guilabel:`Week`,
-:guilabel:`Month`, or :guilabel:`Year` presented, click the :icon:`oi-arrow-left` :guilabel:`(left
-arrow)` or :icon:`oi-arrow-right` :guilabel:`(right arrow)` buttons on either side of the drop-down
-menu. To jump back to a view containing the current day, click the :guilabel:`Today` button. This
-refreshes the dashboard, presenting information containing the current day's information.
-
-In the :guilabel:`Day` view, the column for the current hour is highlighted in yellow. If the
-:guilabel:`Week` or :guilabel:`Month` view is selected, the column for the current day is
-highlighted. If the :guilabel:`Year` view is selected, the current month is highlighted.
-
-.. image:: attendances/overview.png
-   :alt: The overview dashboard presenting the information for the week, with the current day
-         highlighted.
-
-Any entries that have errors appear in red, indicating they need to be resolved by a user with the
-proper :ref:`access rights <attendances/access-rights>` and/or are :ref:`approvers
-<attendances/approvers>` for the employees with the errors.
-
-.. _attendances/filters-groups:
-
-Filters and groups
-------------------
-
-To filter the results in the overview dashboard, or to present different groups of information,
-click the :icon:`fa-caret-down` :guilabel:`(Toggle Search Panel)` button in the right side of the
-:guilabel:`Search` bar above the dashboard, and select one of the available :guilabel:`Filters` or
-:guilabel:`Group By` options. Several preconfigured filters and groups are available to choose from,
-as well as an option to create custom ones.
-
-Filters
-~~~~~~~
-
-The default filters that can be selected are:
-
-- :guilabel:`My Attendances`: this filter only presents the user's attendance data.
-- :guilabel:`My Team`: this filter presents the attendance data for the user's team.
-- :guilabel:`At Work`: this filter displays the attendance data for everyone currently checked in.
-- :guilabel:`Errors`: this filter displays any entries with :ref:`errors <attendances/errors>` that
-  need to be resolved.
-- :guilabel:`Check In`: this filter has a drop-down to further select a specific time period. Select
-  the desired time period from the options presented, a specific month, quarter, or year.
-- :guilabel:`Last 7 days`: this filter presents the attendance data for the last seven days.
-- :guilabel:`Add Custom Filter`: create a custom filter using the pop-up that appears when this is
-  selected.
-
-Groups
-~~~~~~
-
-The default groups that can be selected are:
-
-- :guilabel:`Check In`: this grouping presents a drop-down menu containing the following time period
-  options: :guilabel:`Year`, :guilabel:`Quarter`, :guilabel:`Month`, :guilabel:`Week`, and
-  :guilabel:`Day`. Selected the time period to display all the check-in information, grouped by the
-  selected time period.
-- :guilabel:`Employee`: this group presents the attendance data organized by employee.
-- :guilabel:`Check Out`: this grouping presents a drop-down menu containing the following time
-  period options: :guilabel:`Year`, :guilabel:`Quarter`, :guilabel:`Month`, :guilabel:`Week`, and
-  :guilabel:`Day`. Selected the time period to display all the check-out information, grouped by the
-  selected time period.
-- :guilabel:`Add Custom Group`: this option displays a drop-down menu with a variety of options to
-  group the attendance data by, including :guilabel:`City`, :guilabel:`Country`, :guilabel:`Mode`,
-  and :guilabel:`IP Address`.
-
-.. _attendances/errors:
-
-Attendance log details
-----------------------
-
-Odoo captures various time and location details when a user checks in and out. The specific details
-provided are determined by the method the user checked in and out.
-
-To view the specific check in and/or check out details for an employee, click on an individual entry
-in the overview dashboard.
-
-A detailed attendance log for the user appears in a pop-up window. To close the detailed attendance
-log, click the :guilabel:`Save & Close` button in the bottom-left corner of the form.
-
-The detailed attendance log contains the following information:
-
-Main details
-~~~~~~~~~~~~
-
-- :guilabel:`Employee`: the name of the employee.
-- :guilabel:`Check In`: the date and time the employee checked in.
-- :guilabel:`Check Out`: the date and time the employee checked out. This only appears if the
-  employee has checked out.
-- :guilabel:`Worked Hours`: the total amount of time the employee logged for the day, in an hour and
-  minute format (HH:MM). This value calculates all the checks in and check outs for the day, if the
-  employee checked in and out multiple times.
-- :guilabel:`Extra Hours`: any extra hours the employee logged that is beyond their expected working
-  hours.
-
-Check in/check out details
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The following information appears for both the :guilabel:`Check In` and :guilabel:`Check Out`
-sections.
-
-- :guilabel:`Mode`: the method with which the attendance information was gathered.
-  :guilabel:`Systray` is displayed if the employee logged in and out :ref:`directly from the
-  database <attendances/check-in>`, :guilabel:`Manual` is displayed if the employee logged in and
-  out :ref:`using an attendance kiosk <attendances/kiosk-mode-entry>`.
-- :guilabel:`IP Address`: the IP address for the computer the employee used to log in or out.
-- :guilabel:`Browser`: the web browser the employee used to log in or out.
-- :guilabel:`Localization`: the city and country associated with the computer's IP address.
-- :guilabel:`GPS Coordinates`: the specific coordinates when the user logged in or out. To view the
-  specific coordinates on a map, click the :guilabel:`→ View on Maps` button beneath the
-  :guilabel:`GPS Coordinates`. This opens a map in a new browser tab, with the specific location
-  pointed out.
-
-.. image:: attendances/details.png
-   :alt: The detailed information for an attendance entry.
-
-Errors
-------
-
-Entries that contain an error appear on the overview dashboard in red. In the :guilabel:`Gantt
-view`, the entry appears with a red background. If in the :guilabel:`List view`, the entry text
-appears in red.
-
-An error typically occurs when an employee has checked in but has not checked out within the last 24
-hours, or when an employee has a check in and check out period spanning over 16 hours.
-
-To fix the error, the attendance entry must be modified or deleted. Click on the entry to reveal a
-pop-up containing the details for that particular entry. To modify the :guilabel:`Check In` and/or
-:guilabel:`Check Out` information, click on the :guilabel:`Check In` or :guilabel:`Check Out` field
-and a calendar selector appears. Click on the desired date, then use the time selector beneath the
-calendar to select the specific time for the entry. When the information is correct, click
-:guilabel:`Apply.`
-
-.. image:: attendances/errors.png
-   :alt: The pop-up that allows for modifications to an attendance entry with an error. The calendar
-         selector is shown, and the time selector is highlighted.
-
-When all the information on the pop-up is correct, click :guilabel:`Save & Close`. When the entry no
-longer has an error, the entry appears in gray instead of red.
-
-To delete an entry, click :guilabel:`Remove` on the pop-up instead of making modifications to the
-entry.
-
 Reporting
 =========
 
@@ -323,6 +166,7 @@ button and a pop-up appears. Select the desired spreadsheet, and click :guilabel
    :alt: The default report view, with all the optional view buttons highlighted.
 
 .. seealso::
+   - :doc:`attendances/overview`
    - :doc:`attendances/check_in_check_out`
    - :doc:`attendances/kiosks`
    - :doc:`attendances/management`
@@ -331,6 +175,7 @@ button and a pop-up appears. Select the desired spreadsheet, and click :guilabel
 .. toctree::
    :titlesonly:
 
+   attendances/overview
    attendances/check_in_check_out
    attendances/kiosks
    attendances/management

content/applications/hr/attendances/details.png

@@ -0,0 +1,170 @@
+========
+Overview
+========
+
+When entering the **Attendances** application, the :guilabel:`Overview` dashboard is presented,
+containing all the check in and check out information for the signed in user. If the user has
+specific :ref:`access rights <attendances/access-rights>` and/or are :ref:`approvers
+<attendances/approvers>` for specific employees, then those additional employee's check in and check
+out information is also visible on the :guilabel:`Overview` dashboard.
+
+Views
+=====
+
+To change the view from the default Gantt chart to a list view, click the :icon:`oi-view-list`
+:guilabel:`(List)` icon in the top-right of the dashboard, beneath the user's photo. To switch back
+to the Gantt chart, click the :icon:`fa-tasks` :guilabel:`(Gantt)` icon, located next to the
+:icon:`oi-view-list` :guilabel:`(List)` button.
+
+The default view presents the attendance information for the current day, grouped by employee. To
+present the information for the :guilabel:`This week`, :guilabel:`This month`, :guilabel:`This
+quarter`, or :guilabel:`This year`, click on the :icon:`fa-calendar` :guilabel:`(date)` button to
+reveal a drop-down menu, displaying those other view options. Select the desired view, and the
+dashboard updates, presenting the selected information. Additionally, a specific date range can be
+presented by clicking the last option in the drop-down list, entering the dates and click the
+:guilabel:`Apply` button.
+
+To change the date range presented, click the :icon:`oi-arrow-left` :guilabel:`(left arrow)` or
+:icon:`oi-arrow-right` :guilabel:`(right arrow)` buttons to the left of the date. To jump back to
+a view containing the current day, click the :icon:`fa-crosshairs` :guilabel:`(Focus Today)` button.
+This refreshes the dashboard, presenting information containing the current day's information.
+
+In the :guilabel:`Today` view, the column for the current *hour* is highlighted in yellow. If
+:guilabel:`This week`, :guilabel:`This month`, or :guilabel:`This quarter` is selected, the column
+for the current *day* is highlighted. If  :guilabel:`This year`  is selected, the current *month* is
+highlighted.
+
+.. image:: overview/overview.png
+   :alt: The overview dashboard presenting the information for the week, with the current day
+         highlighted.
+
+.. note::
+   Any entries that have errors appear in red, indicating they need to be resolved by a user with
+   the proper :ref:`access rights <attendances/access-rights>` and/or are :ref:`approvers
+   <attendances/approvers>` for the employees with the errors.
+
+.. _attendances/filters-groups:
+
+Filters and groups
+==================
+
+To filter the results in the overview dashboard, or to present different groups of information,
+click the :icon:`fa-caret-down` :guilabel:`(Toggle Search Panel)` button in the right side of the
+search bar, and select one of the available :icon:`fa-filter` :guilabel:`Filters` or
+:icon:`oi-group` :guilabel:`Group By` options. Several preconfigured filters and groups are
+available to choose from, as well as an option to create custom ones.
+
+Filters
+-------
+
+The default filters that can be selected are:
+
+- :guilabel:`My Attendances`: this filter only presents the user's attendance data.
+- :guilabel:`My Team`: this filter presents the attendance data for the user's team.
+- :guilabel:`At Work`: this filter displays the attendance data for everyone currently checked in.
+- :guilabel:`Errors`: this filter displays any entries with :ref:`errors <attendances/errors>` that
+  need to be resolved.
+- :guilabel:`Automatically Checked-Out`: this filter displays the attendance data for all employees
+  who were automatically checked out of the database. This only appears if the :guilabel:`Automatic
+  Check-Out` :icon:`fa-building-o` feature is enabled in the :ref:`settings menu
+  <attendances/modes>`.
+- :guilabel:`Date` :icon:`fa-caret-down`: this filter allows the modification of the dates
+  presented. Select the date range, and attendance records for that period are presented.
+- :guilabel:`Active Employees`: this filter only presents the attendance data for current employees.
+- :guilabel:`Archived Employees`: this filter only presents the attendance data for archived
+  employees.
+- :guilabel:`Add Custom Filter`: create a custom filter using the pop-up that appears when this is
+  selected.
+
+Groups
+------
+
+The default groups that can be selected are:
+
+- :guilabel:`Employee`: this group presents the attendance data organized by employee.
+- :guilabel:`Department`: this group presents the attendance data organized by department.
+- :guilabel:`Manager`: this group presents the attendance data organized by manger.
+- :guilabel:`Method`: this group presents the attendance data organized by the way the employee
+  checked-in.
+- :guilabel:`Date` :icon:`fa-caret-down`: select the date range to group by, either :guilabel:`Year`,
+  :guilabel:`Quarter`, :guilabel:`Month`, :guilabel:`Week`, or :guilabel:`Day`.
+- :guilabel:`Add Custom Group` :icon:`fa-caret-down`: this option displays a drop-down menu with a
+  variety of other options to group the attendance data by.
+
+.. _attendances/errors:
+
+Attendance log details
+======================
+
+Odoo captures various time and location details when a user checks in and out. The specific details
+provided are determined by the method the user checked in and out.
+
+To view the specific check in or check out details for an employee, click on an individual entry in
+the overview dashboard.
+
+A detailed attendance log for the user appears in a pop-up window. To close the detailed attendance
+log, click the :guilabel:`Save & Close` button in the bottom-left corner of the form.
+
+The detailed attendance log contains the following information:
+
+Main details
+------------
+
+- :guilabel:`Employee`: the name of the employee.
+- :guilabel:`Check In`: the date and time the employee checked in.
+- :guilabel:`Check Out`: the date and time the employee checked out. This only appears if the
+  employee has checked out.
+- :guilabel:`Worked Time`: the total amount of time the employee logged for the day, in an hour and
+  minute format (HH:MM). This value calculates all the checks in and check outs for the day, if the
+  employee checked in and out multiple times.
+- :guilabel:`Worked Extra Hours`: the total amount of overtime that was approved. This field
+  **only** appears if there is approved overtime for the employee.
+- :guilabel:`Extra Hours`: any extra hours the employee logged that is beyond their expected working
+  hours. If overtime has been approved, this field is the difference between the :guilabel:`Worked
+  Time` and :guilabel:`Worked Extra Hours`.
+
+Check in/check out details
+--------------------------
+
+The following information appears for both the :guilabel:`Check In` and :guilabel:`Check Out`
+sections.
+
+- :guilabel:`Mode`: the method with which the attendance information was gathered.
+  :guilabel:`Systray` is displayed if the employee logged in and out :ref:`directly from the
+  database <attendances/check-in>`, :guilabel:`Kiosk` is displayed if the employee logged in and out
+  :ref:`using an attendance kiosk <attendances/kiosk-mode-entry>`, and :guilabel:`Manual` is
+  displayed if the record was created manually in the **Attendances** app, typically by the
+  employee's manager.
+- :guilabel:`IP Address`: the IP address for the computer the employee used to log in or out.
+- :guilabel:`Browser`: the web browser the employee used to log in or out.
+- :guilabel:`Localisation`: the city and country associated with the computer's IP address.
+- :guilabel:`GPS Coordinates`: the specific coordinates when the user logged in or out. To view the
+  specific coordinates on a map, click the :icon:`oi-arrow-right` :guilabel:`View on Maps` button
+  beneath the :guilabel:`GPS Coordinates`. This opens a map in a new browser tab, with the specific
+  location pointed out.
+
+.. image:: overview/details.png
+   :alt: The detailed information for an attendance entry.
+
+Errors
+======
+
+Entries that contain an error appear on the overview dashboard in red. In the :guilabel:`Gantt
+view`, the entry appears with a red background. If in the :guilabel:`List view`, the entry text
+appears in red.
+
+An error typically occurs when an employee has checked in but has not checked out within the last 24
+hours, or when an employee has a check in and check out period spanning over 16 hours.
+
+To fix the error, the attendance entry must be modified or deleted. Click on the entry to reveal a
+pop-up containing the details for that particular entry. To modify the :guilabel:`Check In` and/or
+:guilabel:`Check Out` information, click on the :guilabel:`Check In` or :guilabel:`Check Out` field
+and a calendar selector appears. Click on the desired date, then use the time selector beneath the
+calendar to select the specific time for the entry. When the information is correct, click
+:guilabel:`Apply.`
+
+When all the information on the pop-up is correct, click :guilabel:`Save & Close`. When the entry no
+longer has an error, the entry appears in gray instead of red.
+
+To delete an entry, click the red :guilabel:`Delete` button on the pop-up window instead of making
+modifications to the entry.