[ADD] Payroll: Work entry analysis report

closes #11063

Signed-off-by: Lara Martini (larm) <[email protected]>

content/applications/hr/payroll.rst

@@ -963,6 +963,7 @@ form.
    - :doc:`payroll/payslips`
    - :doc:`payroll/work_entries`
    - :doc:`payroll/reporting`
+   - :doc:`payroll/work_entry_analysis`
 
 .. toctree::
    :titlesonly:
@@ -971,3 +972,4 @@ form.
    payroll/work_entries
    payroll/payslips
    payroll/reporting
+   payroll/work_entry_analysis

content/applications/hr/payroll/reporting.rst

@@ -178,63 +178,11 @@ spreadsheet view with the report added to it.
 .. _payroll/doc-storage:
 
 .. note::
-   If the *Documents* app is **not** installed, the :guilabel:`Insert in Spreadsheet` option places
-   the newly-created spreadsheet in the *Dashboards* app.
+   If the **Documents** app is **not** installed, the :guilabel:`Insert in Spreadsheet` option
+   places the newly-created spreadsheet in the **Dashboards** app.
 
-   If the *Documents* application **is** installed, the spreadsheet has the option to be stored in
-   either the *Dashboards* app or *Documents* app.
-
-Work entry analysis
--------------------
-
-The default :guilabel:`Work entry analysis` report provides an overview of the validated work
-entries for the current month. To view this report, navigate to :menuselection:`Payroll app -->
-Reporting --> Work Entry Analysis`.
-
-The work entries appear in a pivot table, with the default filters of `Current month: (Month)(Year)`
-and `Validated`. The various types of :doc:`work_entries` are listed on the left-hand side (x-axis),
-while the :guilabel:`Total` values appear along the top (the y-axis).
-
-To change the displayed view, click the :guilabel:`➕ (plus)` icon next to the word
-:guilabel:`Total`, then click on one of the grouping options. The available options are
-:guilabel:`Work Entry Type`, :guilabel:`Employee`, and :guilabel:`Department`. If in a multi-company
-database, a :guilabel:`Company` option also appears.
-
-To add a new group to sort the data, click :guilabel:`Add Custom Group`, then click one of the
-presented options.
-
-.. tip::
-   Wherever a :guilabel:`➕ (plus)` icon appears on a pivot table, the information can be further
-   grouped. Click on a :guilabel:`➕ (plus)` icon to reveal the available grouping options.
-
-   Click on a :guilabel:`➖ (minus)` icon anywhere on the pivot table to remove that respective
-   grouping.
-
-It is possible to compare the current :guilabel:`Work entry analysis` report to the previous month
-or the previous year. To view these comparisons, click the :guilabel:`⬇️ (down arrow)` icon in the
-search bar to reveal the various :ref:`filter <payroll/filters>` and grouping options.
-
-In the section titled :guilabel:`Comparison`, click on either :guilabel:`Current Month: Previous
-Period` or :guilabel:`Current Month: Previous Year`. The report updates and displays the previous
-time period values, as well as the :guilabel:`Variation` between the two.
-
-.. image:: reporting/work-entry-comparison.png
-   :align: center
-   :alt: A pivot table comparing the work entries of the current month and the previous month.
-
-To export the data in an XLSX format, click the :guilabel:`Download xlsx` button, represented by a
-:guilabel:`⬇️ (down arrow above a horizontal bar)` icon, located at the far-right of the available
-icons. The information is then downloaded into a spreadsheet.
-
-The data can also be inserted into a spreadsheet. Click the :guilabel:`Insert in Spreadsheet` button
-and a :guilabel:`Select a spreadsheet to insert your (type of report)` pop-up window appears, asking
-which spreadsheet to place the information in. Select an existing spreadsheet or dashboard, or
-select a new :guilabel:`Blank spreadsheet`. Click the :guilabel:`Confirm` button to move to a
-spreadsheet view with the report added to it.
-
-.. note::
-   The work entry analysis spreadsheet is :ref:`stored in the same locations <payroll/doc-storage>`
-   as a pivot table.
+   If the **Documents** application *is* installed, the spreadsheet has the option to be stored in
+   either the **Dashboards** app or **Documents** app.
 
 Salary attachment report
 ------------------------

content/applications/hr/payroll/work_entries.rst

@@ -59,8 +59,8 @@ Enter the following information on the form:
   this field is left blank, it automatically populates once an employee is selected. The default
   entry is `Attendance: (Employee)`.
 - :guilabel:`Employee`: select the employee the work entry is for, using the drop-down menu.
-- :guilabel:`Work Entry Type`: select the :ref:`work entry type <payroll/work-entries-config>` using
-  the drop-down menu.
+- :guilabel:`Work Entry Type`: select the :ref:`work entry type <payroll/work-entries>` using the
+  drop-down menu.
 - :guilabel:`From` and :guilabel:`To`: enter the start (:guilabel:`From`) and end (:guilabel:`To`)
   dates and times for the work entry.
 

content/applications/hr/payroll/work_entry_analysis.rst

@@ -0,0 +1,80 @@
+===================
+Work entry analysis
+===================
+
+The default *Work Entries Analysis* report provides an overview of the validated work entries for
+the current month. To view this report, navigate to :menuselection:`Payroll app --> Reporting -->
+Work Entry Analysis`.
+
+The work entries appear in a pivot table, with the default filters of :guilabel:`Current month:
+(Month)(Year)` and :guilabel:`Validated`. The various types of :doc:`work_entries` populate the
+rows, while the :guilabel:`Total` values populate the only visible column.
+
+To change the displayed information, click :icon:`fa-plus-square` :guilabel:`Total` above the main
+column, revealing a drop-down menu of available metrics. Click on one of the available groupings,
+and the data is further organized by that selected metric. The default options are :guilabel:`Work
+Entry Type`, :guilabel:`Employee`, and :guilabel:`Department`. If in a multi-company database, a
+:guilabel:`Company` option also appears.
+
+Work entry analysis comparison
+==============================
+
+It is possible to compare the work entries from one time period to a previous time period. To view
+this comparison, first navigate to :menuselection:`Payroll app --> Reporting --> Work Entry
+Analysis`.
+
+Next, click the :icon:`fa-caret-down` :guilabel:`(down arrow)` icon in the search bar, revealing a
+drop-down menu. Under the :icon:`fa-adjust` :guilabel:`Comparison` section, click on either
+:guilabel:`Current Month: Previous Period` or :guilabel:`Current Month: Previous Year`.
+
+The report updates and displays the data for the current time period, data for the selected previous
+time period, as well as the :guilabel:`Variation` between the two, in a percentage.
+
+.. image:: work_entry_analysis/work-entry-comparison.png
+   :alt: A pivot table comparing the work entries of the current month and the previous month.
+
+.. note::
+   If no work entries for a specific :ref:`work entry type <payroll/work-entries>` are logged for
+   the time period, it does **not** appear on the report. That does **not** mean the work entry type
+   does not exist, or is not configured.
+
+   Additionally, if the default :guilabel:`Current month: (Month)(Year)` filter is removed from the
+   search bar, the :guilabel:`Comparison` column does **not** appear; there must be a time-frame
+   selected to view the :guilabel:`Comparison` column.
+
+Use case: overtime report comparison
+====================================
+
+It is possible to alter the *Work Entries Analysis* report to show a comparison of only overtime
+work entries, grouped by employee, for a specific time period. To view this data, first navigate to
+the default *Work entry analysis* report by going to :menuselection:`Payroll app --> Reporting -->
+Work Entry Analysis`.
+
+Next, click the :icon:`fa-caret-down` :guilabel:`(down arrow)` icon in the search bar, revealing a
+drop-down menu. Under the :icon:`fa-filter` :guilabel:`Filters` column, click :guilabel:`Add Custom
+Filter`, and a :guilabel:`Add Custom Filter` pop-up window appears.
+
+Using the drop-down menu, select :guilabel:`Work Entry Type` for the first field, leave the middle
+field as-is (with :guilabel:`is in` populating the field), and select :guilabel:`Overtime Hours` for
+the last field. Click :guilabel:`Add`, and all other work entry types disappear, and
+:guilabel:`Overtime Hours` appear in the sole row.
+
+To compare overtime from the current month to the previous month, to see which month had more
+overtime logged, click the :icon:`fa-caret-down` :guilabel:`(down arrow)` icon again in the search
+bar. Under the :icon:`fa-adjust` :guilabel:`Comparison` section, click :guilabel:`Current Month:
+Previous Period`. Click away from the drop-down menu to close it.
+
+Now, the report displays the :guilabel:`Overtime Hours` for the current month and the previous
+month, along with the :guilabel:`Variation`, in a percentage.
+
+To view which employees received the most overtime, click :icon:`fa-plus-square` :guilabel:`Overtime
+Hours`, revealing a drop-down menu of options. Click :guilabel:`Employee`, and all employees with
+overtime work entries for either the current or previous month appears.
+
+In this example, it can be determined that :guilabel:`Marc Demo` worked the most overtime in
+:guilabel:`August 2024`, whereas :guilabel:`Beth Evans` worked the most overtime hours in
+:guilabel:`September 2024`. Additionally, :guilabel:`Mitchell Admin` had the largest variation
+change, with a :guilabel:`-100%` change from :guilabel:`August 2024` to :guilabel:`September 2024`.
+
+.. image:: work_entry_analysis/variation.png
+   :alt: A pivot table comparing the overtime from September 2024 with August 2024.