Skip to content

Commit dc7ed1a

Browse files
committed
[ADD] Time Off: Add reporting
1 parent 165b0ea commit dc7ed1a

File tree

5 files changed

+95
-87
lines changed

5 files changed

+95
-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

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

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

661576
.. toctree::
662577
:titlesonly:
@@ -665,3 +580,4 @@ the various time off types and balances populate the columns.
665580
time_off/request_time_off
666581
time_off/my_time
667582
time_off/management
583+
time_off/reporting
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
=========
2+
Reporting
3+
=========
4+
5+
The **Time Off** app's reporting feature allows managers to view time off for their team, either by
6+
employee, type of time off, or by time off balances. This allows managers to see :ref:`which
7+
employees are taking time off and how much <time_off/by_employee>`, :ref:`what time off types are
8+
being used <time_off/by_type>`, and :ref:`how much time each employee has used, and still has
9+
available <time_off/balance>`.
10+
11+
Any report can be added to a spreadsheet, when in either the :icon:`fa-area-chart`
12+
:guilabel:`(Graph)` or :icon:`oi-view-pivot` :guilabel:`(Pivot)` view, through the *Insert in
13+
Spreadsheet* button that appears in the top-left of a report.
14+
15+
.. note::
16+
If the **Documents** app is installed, an option to add the report to a spreadsheet appears. If
17+
not, the report can be added to a *Dashboard*.
18+
19+
.. _time_off/by_employee:
20+
21+
By employee
22+
===========
23+
24+
To view a list of employee time off requests, navigate to :menuselection:`Time Off app --> Reporting
25+
--> 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+
To view a graph of all time off, organized by time off type, navigate to :menuselection:`Time Off
56+
app --> Reporting --> by Type`. This shows all time off requests in a default bar chart.
57+
58+
Hover over a bar to view the :guilabel:`Duration (Days)` of that specific time off type.
59+
60+
.. image:: reporting/bar-chart.png
61+
:alt: The various time off types, and how many days requested, in a bar chart. Details are
62+
highlighted in a red box.
63+
64+
Click on a bar to go to a detailed list view of all the time off requests for that time off type.
65+
66+
Each request is listed, with the following information displayed: the :guilabel:`Employee`,
67+
:guilabel:`Number of Days`, :guilabel:`Request Type`, :guilabel:`Start Date`, :guilabel:`End Date`,
68+
:guilabel:`Status`, and the :guilabel:`Description`.
69+
70+
The report can be displayed in other ways, as well. Click the corresponding button option in the
71+
top-right corner of the page to view the data in that way. The various options are a
72+
:icon:`fa-area-chart` :guilabel:`(Graph)` (the default view), :icon:`oi-view-list`
73+
:guilabel:`(List)`, or :icon:`oi-view-pivot` :guilabel:`(Pivot)` table.
74+
75+
When a selection has been made, additional options appear for that particular selection. For more
76+
detailed information on the reports, and their various options, refer to the :doc:`reporting
77+
<../../essentials/reporting>` documentation.
78+
79+
.. _time_off/balance:
80+
81+
Balance
82+
=======
83+
84+
To view a pivot table of all time off balances, organized by time off type, then further organized
85+
by how many days and hours are :guilabel:`Left` and :guilabel:`Planned`, navigate to
86+
:menuselection:`Time Off app --> Reporting --> Balance`.
87+
88+
This shows all time off balances in a default pivot table. The employees populate the rows, while
89+
the various time off types and balances populate the columns.
90+
91+
.. image:: reporting/balance.png
92+
:alt: The various time off balances, in a pivot table.

0 commit comments

Comments
 (0)