Skip to content

[ADD] Time Off: Add reporting #14182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 18.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 3 additions & 87 deletions content/applications/hr/time_off.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ requests and time off balances. Managers can :doc:`allocate time off <time_off/a
individuals, teams, or the whole company, and :ref:`approve time off requests
<time_off/manage-time-off>`.

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

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

.. _time_off/reporting:

Reporting
=========

The reporting feature allows users to view time off for their team, either by employee or type of
time off. This allows users to see which employees are taking time off, how much time off they are
taking, and what time off types are being used.

Any report can be added to a spreadsheet, when in either the :icon:`fa-area-chart`
:guilabel:`(Graph)` or :icon:`oi-view-pivot` :guilabel:`(Pivot)` view, through the *Insert in
Spreadsheet* button that appears in the top-left of a report.

.. note::
If the **Documents** app is installed, an option to add the report to a spreadsheet appears. If
not, the report can be added to a *Dashboard*.

By employee
-----------

To view a list of employee time off requests, navigate to :menuselection:`Time Off app --> Reporting
--> by Employee`.

The default report presents the current year's data in a list view, displaying all the employees in
alphabetical order. Each employee's line is collapsed by default. To expand a line, click anywhere
on the line.

The view expands, and has the time off requests organized by time off type. Click anywhere on a time
off type line to expand it, and view all the individual time off requests that fall under that type.

The information shown in the list includes: the :guilabel:`Employee` name, :guilabel:`Number of
Days` off requested, the :guilabel:`Start Date`, :guilabel:`End Date`, :guilabel:`Status`, and
:guilabel:`Description`.

.. image:: time_off/employee-report.png
:alt: Report of time off, shown by each employee in a list view.

The report can be displayed in other ways, as well. Click the corresponding button option in the
top-right corner of the page to view the data in that specific way. The various options are a
:icon:`oi-view-list` :guilabel:`(List)`, or default view, :icon:`fa-area-chart` :guilabel:`(Graph)`,
:icon:`oi-view-pivot` :guilabel:`(Pivot)` table, or :icon:`fa-calendar` :guilabel:`(Calendar)` view.

When a selection has been made, additional options appear for that particular selection. For more
detailed information on the reports and their various options, refer to the :doc:`reporting
<../essentials/reporting>` documentation.

By type
-------

To view a graph of all time off, organized by time off type, navigate to :menuselection:`Time Off
app --> Reporting --> by Type`. This shows all time off requests in a default bar chart.

Hover over a bar to view the :guilabel:`Duration (Days)` of that specific time off type.

.. image:: time_off/bar-chart.png
:alt: The various time off types, and how many days requested, in a bar chart. Details are
highlighted in a red box.

Click on a bar to go to a detailed list view of all the time off requests for that time off type.

Each request is listed, with the following information displayed: the :guilabel:`Employee`,
:guilabel:`Number of Days`, :guilabel:`Request Type`, :guilabel:`Start Date`, :guilabel:`End Date`,
:guilabel:`Status`, and the :guilabel:`Description`.

The report can be displayed in other ways, as well. Click the corresponding button option in the
top-right corner of the page to view the data in that way. The various options are a
:icon:`fa-area-chart` :guilabel:`(Graph)` (the default view), :icon:`oi-view-list`
:guilabel:`(List)`, or :icon:`oi-view-pivot` :guilabel:`(Pivot)` table.

When a selection has been made, additional options appear for that particular selection. For more
detailed information on the reports, and their various options, refer to the :doc:`reporting
<../essentials/reporting>` documentation.

Balance
-------

To view a pivot table of all time off balances, organized by time off type, then further organized
by how many days and hours are :guilabel:`Left` and :guilabel:`Planned`, navigate to
:menuselection:`Time Off app --> Reporting --> Balance`.

This shows all time off balances in a default pivot table. The employees populate the rows, while
the various time off types and balances populate the columns.

.. image:: time_off/balance.png
:alt: The various time off balances, in a pivot table.

.. seealso::
- :doc:`time_off/allocations`
- :doc:`time_off/request_time_off`
- :doc:`time_off/my_time`
- :doc:`time_off/management`
- :doc:`time_off/reporting`

.. toctree::
:titlesonly:
Expand All @@ -665,3 +580,4 @@ the various time off types and balances populate the columns.
time_off/request_time_off
time_off/my_time
time_off/management
time_off/reporting
92 changes: 92 additions & 0 deletions content/applications/hr/time_off/reporting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
=========
Reporting
=========

The **Time Off** app's reporting feature allows managers to view time off for their team, either by
employee, type of time off, or by time off balances. This allows managers to see :ref:`which
employees are taking time off and how much <time_off/by_employee>`, :ref:`what time off types are
being used <time_off/by_type>`, and :ref:`how much time each employee has used, and still has
available <time_off/balance>`.

Any report can be added to a spreadsheet, when in either the :icon:`fa-area-chart`
:guilabel:`(Graph)` or :icon:`oi-view-pivot` :guilabel:`(Pivot)` view, through the *Insert in
Spreadsheet* button that appears in the top-left of a report.

.. note::
If the **Documents** app is installed, an option to add the report to a spreadsheet appears. If
not, the report can be added to a *Dashboard*.

.. _time_off/by_employee:

By employee
===========

To view a list of employee time off requests, navigate to :menuselection:`Time Off app --> Reporting
--> by Employee`.

The default report presents the current year's data in a list view, displaying all the employees in
alphabetical order. Each employee's line is collapsed by default. To expand a line, click anywhere
on the line.

The view expands, and has the time off requests organized by time off type. Click anywhere on a time
off type line to expand it, and view all the individual time off requests that fall under that type.

The information shown in the list includes: the :guilabel:`Employee` name, :guilabel:`Number of
Days` off requested, the :guilabel:`Start Date`, :guilabel:`End Date`, :guilabel:`Status`, and
:guilabel:`Description`.

.. image:: reporting/employee-report.png
:alt: Report of time off, shown by each employee in a list view.

The report can be displayed in other ways, as well. Click the corresponding button option in the
top-right corner of the page to view the data in that specific way. The various options are a
:icon:`oi-view-list` :guilabel:`(List)`, or default view, :icon:`fa-area-chart` :guilabel:`(Graph)`,
:icon:`oi-view-pivot` :guilabel:`(Pivot)` table, or :icon:`fa-calendar` :guilabel:`(Calendar)` view.

When a selection has been made, additional options appear for that particular selection. For more
detailed information on the reports and their various options, refer to the :doc:`reporting
<../../essentials/reporting>` documentation.

.. _time_off/by_type:

By type
=======

To view a graph of all time off, organized by time off type, navigate to :menuselection:`Time Off
app --> Reporting --> by Type`. This shows all time off requests in a default bar chart.

Hover over a bar to view the :guilabel:`Duration (Days)` of that specific time off type.

.. image:: reporting/bar-chart.png
:alt: The various time off types, and how many days requested, in a bar chart. Details are
highlighted in a red box.

Click on a bar to go to a detailed list view of all the time off requests for that time off type.

Each request is listed, with the following information displayed: the :guilabel:`Employee`,
:guilabel:`Number of Days`, :guilabel:`Request Type`, :guilabel:`Start Date`, :guilabel:`End Date`,
:guilabel:`Status`, and the :guilabel:`Description`.

The report can be displayed in other ways, as well. Click the corresponding button option in the
top-right corner of the page to view the data in that way. The various options are a
:icon:`fa-area-chart` :guilabel:`(Graph)` (the default view), :icon:`oi-view-list`
:guilabel:`(List)`, or :icon:`oi-view-pivot` :guilabel:`(Pivot)` table.

When a selection has been made, additional options appear for that particular selection. For more
detailed information on the reports, and their various options, refer to the :doc:`reporting
<../../essentials/reporting>` documentation.

.. _time_off/balance:

Balance
=======

To view a pivot table of all time off balances, organized by time off type, then further organized
by how many days and hours are :guilabel:`Left` and :guilabel:`Planned`, navigate to
:menuselection:`Time Off app --> Reporting --> Balance`.

This shows all time off balances in a default pivot table. The employees populate the rows, while
the various time off types and balances populate the columns.

.. image:: reporting/balance.png
:alt: The various time off balances, in a pivot table.