Skip to content

Commit 60b4cdc

Browse files
committed
[ADD] Time Off: Add reporting
closes #14182 Signed-off-by: Felicia Kuan (feku) <[email protected]>
1 parent fccb321 commit 60b4cdc

File tree

5 files changed

+104
-87
lines changed

5 files changed

+104
-87
lines changed

content/applications/hr/time_off.rst

Lines changed: 3 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ requests and time off balances. Managers can :doc:`allocate time off <time_off/a
1212
individuals, teams, or the whole company, and :ref:`approve time off requests
1313
<time_off/manage-time-off>`.
1414

15-
Detailed :ref:`reports <time_off/reporting>` can be run to see how much time off (and what kinds of
15+
Detailed :doc:`reports <time_off/reporting>` can be run to see how much time off (and what kinds of
1616
time off) are being used, :ref:`accrual plans <time_off/accrual-plans>` can be created, and
1717
:ref:`public holidays <time_off/public-holidays>` can be set.
1818

@@ -567,97 +567,12 @@ the time off request in a modal, click the :guilabel:`View` button.
567567
.. image:: time_off/overview.png
568568
:alt: Overview of the user's team, with time off requests shown.
569569

570-
.. _time_off/reporting:
571-
572-
Reporting
573-
=========
574-
575-
The reporting feature allows users to view time off for their team, either by employee or type of
576-
time off. This allows users to see which employees are taking time off, how much time off they are
577-
taking, and what time off types are being used.
578-
579-
Any report can be added to a spreadsheet, when in either the :icon:`fa-area-chart`
580-
:guilabel:`(Graph)` or :icon:`oi-view-pivot` :guilabel:`(Pivot)` view, through the *Insert in
581-
Spreadsheet* button that appears in the top-left of a report.
582-
583-
.. note::
584-
If the **Documents** app is installed, an option to add the report to a spreadsheet appears. If
585-
not, the report can be added to a *Dashboard*.
586-
587-
By employee
588-
-----------
589-
590-
To view a list of employee time off requests, navigate to :menuselection:`Time Off app --> Reporting
591-
--> by Employee`.
592-
593-
The default report presents the current year's data in a list view, displaying all the employees in
594-
alphabetical order. Each employee's line is collapsed by default. To expand a line, click anywhere
595-
on the line.
596-
597-
The view expands, and has the time off requests organized by time off type. Click anywhere on a time
598-
off type line to expand it, and view all the individual time off requests that fall under that type.
599-
600-
The information shown in the list includes: the :guilabel:`Employee` name, :guilabel:`Number of
601-
Days` off requested, the :guilabel:`Start Date`, :guilabel:`End Date`, :guilabel:`Status`, and
602-
:guilabel:`Description`.
603-
604-
.. image:: time_off/employee-report.png
605-
:alt: Report of time off, shown by each employee in a list view.
606-
607-
The report can be displayed in other ways, as well. Click the corresponding button option in the
608-
top-right corner of the page to view the data in that specific way. The various options are a
609-
:icon:`oi-view-list` :guilabel:`(List)`, or default view, :icon:`fa-area-chart` :guilabel:`(Graph)`,
610-
:icon:`oi-view-pivot` :guilabel:`(Pivot)` table, or :icon:`fa-calendar` :guilabel:`(Calendar)` view.
611-
612-
When a selection has been made, additional options appear for that particular selection. For more
613-
detailed information on the reports and their various options, refer to the :doc:`reporting
614-
<../essentials/reporting>` documentation.
615-
616-
By type
617-
-------
618-
619-
To view a graph of all time off, organized by time off type, navigate to :menuselection:`Time Off
620-
app --> Reporting --> by Type`. This shows all time off requests in a default bar chart.
621-
622-
Hover over a bar to view the :guilabel:`Duration (Days)` of that specific time off type.
623-
624-
.. image:: time_off/bar-chart.png
625-
:alt: The various time off types, and how many days requested, in a bar chart. Details are
626-
highlighted in a red box.
627-
628-
Click on a bar to go to a detailed list view of all the time off requests for that time off type.
629-
630-
Each request is listed, with the following information displayed: the :guilabel:`Employee`,
631-
:guilabel:`Number of Days`, :guilabel:`Request Type`, :guilabel:`Start Date`, :guilabel:`End Date`,
632-
:guilabel:`Status`, and the :guilabel:`Description`.
633-
634-
The report can be displayed in other ways, as well. Click the corresponding button option in the
635-
top-right corner of the page to view the data in that way. The various options are a
636-
:icon:`fa-area-chart` :guilabel:`(Graph)` (the default view), :icon:`oi-view-list`
637-
:guilabel:`(List)`, or :icon:`oi-view-pivot` :guilabel:`(Pivot)` table.
638-
639-
When a selection has been made, additional options appear for that particular selection. For more
640-
detailed information on the reports, and their various options, refer to the :doc:`reporting
641-
<../essentials/reporting>` documentation.
642-
643-
Balance
644-
-------
645-
646-
To view a pivot table of all time off balances, organized by time off type, then further organized
647-
by how many days and hours are :guilabel:`Left` and :guilabel:`Planned`, navigate to
648-
:menuselection:`Time Off app --> Reporting --> Balance`.
649-
650-
This shows all time off balances in a default pivot table. The employees populate the rows, while
651-
the various time off types and balances populate the columns.
652-
653-
.. image:: time_off/balance.png
654-
:alt: The various time off balances, in a pivot table.
655-
656570
.. seealso::
657571
- :doc:`time_off/allocations`
658572
- :doc:`time_off/request_time_off`
659573
- :doc:`time_off/my_time`
660574
- :doc:`time_off/management`
575+
- :doc:`time_off/reporting`
661576

662577
.. toctree::
663578
:titlesonly:
@@ -666,3 +581,4 @@ the various time off types and balances populate the columns.
666581
time_off/request_time_off
667582
time_off/my_time
668583
time_off/management
584+
time_off/reporting
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
=========
2+
Reporting
3+
=========
4+
5+
The **Time Off** app's reporting feature lets managers view team time off by employee, type, or
6+
remaining balances. This allows managers to see :ref:`who is taking time off, how much they have
7+
used <time_off/by-employee>`, :ref:`which types are more commonly used <time_off/by_type>`, and
8+
:ref:`how much each employee still has available <time_off/balance>`.
9+
10+
Any report can be added to a spreadsheet, when in either the :icon:`fa-area-chart`
11+
:guilabel:`(Graph)` or :icon:`oi-view-pivot` :guilabel:`(Pivot)` view, through the *Insert in
12+
Spreadsheet* button that appears in the top-left of a report.
13+
14+
.. note::
15+
If the **Documents** app is installed, an option to add the report to a spreadsheet appears. If
16+
not, the report can be added to a *Dashboard*.
17+
18+
.. _time_off/by-employee:
19+
20+
By employee
21+
===========
22+
23+
Viewing time off by employee helps managers track usage patterns, monitor remaining balances, ensure
24+
policy compliance, and plan coverage for upcoming absences. To view a list of employee time off
25+
requests, navigate to :menuselection:`Time Off app --> Reporting --> by Employee`.
26+
27+
The default report presents the current year's data in a list view, displaying all the employees in
28+
alphabetical order. Each employee's line is collapsed by default. To expand a line, click anywhere
29+
on the line.
30+
31+
The view expands, and has the time off requests organized by time off type. Click anywhere on a time
32+
off type line to expand it, and view all the individual time off requests that fall under that type.
33+
34+
The information shown in the list includes: the :guilabel:`Employee` name, :guilabel:`Number of
35+
Days` off requested, the :guilabel:`Start Date`, :guilabel:`End Date`, :guilabel:`Status`, and
36+
:guilabel:`Description`.
37+
38+
.. image:: reporting/employee-report.png
39+
:alt: Report of time off, shown by each employee in a list view.
40+
41+
The report can be displayed in other ways, as well. Click the corresponding button option in the
42+
top-right corner of the page to view the data in that specific way. The various options are a
43+
:icon:`oi-view-list` :guilabel:`(List)`, or default view, :icon:`fa-area-chart` :guilabel:`(Graph)`,
44+
:icon:`oi-view-pivot` :guilabel:`(Pivot)` table, or :icon:`fa-calendar` :guilabel:`(Calendar)` view.
45+
46+
When a selection has been made, additional options appear for that particular selection. For more
47+
detailed information on the reports and their various options, refer to the :doc:`reporting
48+
<../../essentials/reporting>` documentation.
49+
50+
.. _time_off/by_type:
51+
52+
By type
53+
=======
54+
55+
Viewing company-wide time off by type can help managers determine if employees are using their time
56+
off, which types are used more than others, and can spot any trends. High totals in certain time off
57+
types, like sick time off, can indicate health or morale concerns.
58+
59+
To view a graph of all time off, organized by time off type, navigate to :menuselection:`Time Off
60+
app --> Reporting --> by Type`. This shows all time off requests in a default bar chart.
61+
62+
Hover over a bar to view the :guilabel:`Duration (Days)` of that specific time off type.
63+
64+
.. image:: reporting/bar-chart.png
65+
:alt: The various time off types, and how many days requested, in a bar chart. Details are
66+
highlighted in a red box.
67+
68+
Click on a bar to go to a detailed list view of all the time off requests for that time off type.
69+
70+
Each request is listed, with the following information displayed: the :guilabel:`Employee`,
71+
:guilabel:`Number of Days`, :guilabel:`Request Type`, :guilabel:`Start Date`, :guilabel:`End Date`,
72+
:guilabel:`Status`, and the :guilabel:`Description`.
73+
74+
The report can be displayed in other ways, as well. Click the corresponding button option in the
75+
top-right corner of the page to view the data in that way. The various options are a
76+
:icon:`fa-area-chart` :guilabel:`(Graph)` (the default view), :icon:`oi-view-list`
77+
:guilabel:`(List)`, or :icon:`oi-view-pivot` :guilabel:`(Pivot)` table.
78+
79+
When a selection has been made, additional options appear for that particular selection. For more
80+
detailed information on the reports, and their various options, refer to the :doc:`reporting
81+
<../../essentials/reporting>` documentation.
82+
83+
.. _time_off/balance:
84+
85+
Balance
86+
=======
87+
88+
When some time off types have restrictions, such as rollover rules and balance limits, viewing time
89+
off balances can help managers see a high-level overview of time off. If certain employees have a
90+
lot of time that will expire soon, they can inform their employees and adjust scheduled accordingly
91+
to be prepared for their absences.
92+
93+
To view a pivot table of all time off balances, organized by time off type, then further organized
94+
by how many days and hours are :guilabel:`Left` and :guilabel:`Planned`, navigate to
95+
:menuselection:`Time Off app --> Reporting --> Balance`.
96+
97+
This shows all time off balances in a default pivot table. The employees populate the rows, while
98+
the various time off types and balances populate the columns.
99+
100+
.. image:: reporting/balance.png
101+
:alt: The various time off balances, in a pivot table.

0 commit comments

Comments
 (0)