[ADD] Appraisals: Appraisal Analysis reporting

closes odoo/documentation#11037

Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

content/applications/hr/appraisals.rst

@@ -173,11 +173,11 @@ document.
 .. seealso::
    - :doc:`appraisals/new_appraisals`
    - :doc:`appraisals/goals`
-   - :doc:`appraisals/reporting`
+   - :doc:`appraisals/appraisal_analysis`
 
 .. toctree::
    :titlesonly:
 
    appraisals/new_appraisals
    appraisals/goals
-   appraisals/reporting
+   appraisals/appraisal_analysis

content/applications/hr/appraisals/appraisal_analysis.rst

@@ -0,0 +1,115 @@
+==================
+Appraisal analysis
+==================
+
+The **Appraisals** app has the ability to report on all the appraisals in the system, including
+past, present, and future appraisals, and their respective statuses. This report helps managers
+track scheduled appraisals, and identify any overdue or unconfirmed ones.
+
+To access the *Appraisal Analysis* report, navigate to :menuselection:`Appraisals app --> Reporting
+--> Appraisal Analysis`.
+
+On the :guilabel:`Appraisal Analysis` page, a report loads, displaying all the appraisals in the
+database. Each entry is highlighted in a different color to represent their status:
+
++-----------+----------------------------+------------------------------------------------+
+| Color     | Status                     | Meaning                                        |
++===========+============================+================================================+
+| Yellow    |:guilabel:`Done`            | The appraisal was completed.                   |
++-----------+----------------------------+------------------------------------------------+
+| Orange    |:guilabel:`Appraisal Sent`  |The appraisal was confirmed, but not completed. |
++-----------+----------------------------+------------------------------------------------+
+| Red       |:guilabel:`Cancelled`       |The appraisal was cancelled.                    |
++-----------+----------------------------+------------------------------------------------+
+| Gray      |:guilabel:`To Start`        | The appraisal was scheduled, but not confirmed.|
++-----------+----------------------------+------------------------------------------------+
+
+.. note::
+   Appraisals are scheduled automatically (appear in gray), according to their respective
+   :ref:`appraisals/appraisal-plan`.
+
+The report displays the current year, in a default Gantt view, grouped by department, with the
+current month highlighted.
+
+To change the period of time that is presented, adjust the date settings in the top-left corner of
+the report by clicking the default :guilabel:`Year` to reveal a drop-down menu of options. The
+options to display are :guilabel:`Day`, :guilabel:`Week`, :guilabel:`Month`, and :guilabel:`Year`.
+Use the adjacent arrows to move forward or backward in time.
+
+At any point, click the :guilabel:`Today` button to have the Gantt view include today's date in the
+view.
+
+To view the details of any appraisal, click on any appraisal. A pop-over window appears, displaying
+the due date for the appraisal. To view more details, click the :guilabel:`View` button, and further
+details appear in a pop-up window.
+
+The report can have other :ref:`filters <search/filters>` and :ref:`groupings <search/group>` set in
+the search bar at the top.
+
+.. image:: appraisal_analysis/analysis.png
+   :align: center
+   :alt: A report showing all the appraisals for the Appraisal Analysis report.
+
+.. _appraisals/group-status:
+
+Group by status
+===============
+
+When a company has a large number of employees, the default :guilabel:`Appraisal Analysis` report
+may display too much information to view easily. In this scenario, viewing the data by status can be
+beneficial.
+
+First, remove the default :icon:`oi-group` :guilabel:`Department` grouping from the search bar.
+Next, click the :icon:`fa-caret-down` :guilabel:`(down arrow)` icon in the far-right of the search
+bar. Click :guilabel:`Status` in the :icon:`oi-group` :guilabel:`Group By` column. Click away from
+the drop-down menu to close it.
+
+All the appraisals are now organized by status, in the following order: :guilabel:`Cancelled`,
+:guilabel:`Done`, :guilabel:`To Start`, and :guilabel:`Appraisal Sent`.
+
+This view makes it easy to see which appraisals need to be completed, and when, as well as which
+appraisals still need to be confirmed.
+
+.. image:: appraisal_analysis/by-status.png
+   :align: center
+   :alt: A report showing all the appraisals, grouped by status.
+
+Use case: view only the user's appraisals
+=========================================
+
+When viewing the :guilabel:`Appraisal Analysis` report, it can save time to only view the appraisals
+the signed-in user is responsible for, and hide the rest.
+
+To only view this data, click the :icon:`fa-caret-down` :guilabel:`(down arrow)` icon in the
+far-right of the search bar, revealing a drop-down menu.
+
+.. note::
+   It is not necessary to remove the default :icon:`oi-group` :guilabel:`Department` grouping. If it
+   remains active, the results are grouped by department. If it is removed, the results appear in a
+   list, alphabetically.
+
+Click :guilabel:`Add Custom Filter` at the bottom of the :icon:`fa-filter` :guilabel:`Filters`
+column, and a :guilabel:`Add Custom Filter` pop-up window appears.
+
+Click into the first field, and a pop-over appears with a variety of options. Click the
+:icon:`fa-chevron-right` :guilabel:`(right arrow)` icon after the word :guilabel:`Employee`, then
+scroll down and click on :guilabel:`Manager`. Next, set the middle field to :guilabel:`=`
+:guilabel:`(equal)`. Last, click the third field and select the desired user from the list. When all
+the fields are set, click :guilabel:`Add`.
+
+.. image:: appraisal_analysis/custom.png
+   :align: center
+   :alt: A customized filter to show only the user's employees.
+
+Now, the only appraisals that appear are the appraisals that the selected user is responsible for,
+instead of viewing *all* the appraisals.
+
+This report can also be :ref:`grouped by status <appraisals/group-status>`.
+
+.. image:: appraisal_analysis/users-appraisals.png
+   :align: center
+   :alt: A report showing only the appraisals the user is responsible for, by status.
+
+.. seealso::
+   - :doc:`Odoo essentials reporting <../../essentials/reporting>`
+   - :doc:`../../essentials/search`

content/applications/hr/appraisals/new_appraisals.rst

@@ -278,4 +278,4 @@ Once the appraisal is marked as *Done*, the :guilabel:`Mark as Done` button disa
 
 .. seealso::
    - :doc:`../appraisals/goals`
-   - :doc:`../appraisals/reporting`
+   - :doc:`../appraisals/appraisal_analysis`

content/applications/hr/appraisals/reporting.rst

@@ -1,130 +0,0 @@
-=========
-Reporting
-=========
-
-In Odoo's *Appraisals* app, two metrics are tracked as appraisals are completed: an :ref:`appraisal
-analysis <appraisals/analysis-report>`, and a :ref:`skills evolution <appraisals/skills-report>`.
-
-.. _appraisals/analysis-report:
-
-Appraisal analysis
-------------------
-
-To access the *Appraisal Analysis* report, navigate to :menuselection:`Appraisals app --> Reporting
---> Appraisal Analysis`.
-
-On the :guilabel:`Appraisal Analysis` page, there is a report of all the appraisals in the database,
-highlighted in different colors to represent their status.
-
-Appraisals in yellow are *Done*, appraisals in orange are in progress (the *Appraisal Sent*, but not
-completed), appraisals in red have been *Cancelled*, and appraisals in gray are scheduled *To Start*
-(according to the :ref:`appraisals/appraisal-plan`), but have not been confirmed yet.
-
-The report displays the current year, in a default Gantt view, and is grouped by department.
-
-To change the period of time that is presented by default, adjust the date settings in the top-left
-of the report. The options to display are :guilabel:`Day`, :guilabel:`Week`, :guilabel:`Month`, and
-:guilabel:`Year`. Use the arrows to move forward or backward in time.
-
-At any point, click the :guilabel:`Today` button to have the Gantt view include today's date in the
-view.
-
-The report can have other :ref:`filters <search/filters>` and :ref:`groupings <search/group>` set in
-the :guilabel:`Search...` bar at the top.
-
-.. image:: reporting/analysis.png
-   :align: center
-   :alt: A report showing all the appraisals for the Appraisal Analysis report.
-
-.. example::
-   Appraisals that have been cancelled appear in red on the :guilabel:`Appraisal Analysis` report,
-   but there is no preconfigured filter to show only cancelled appraisals.
-
-   To view only cancelled appraisals, click the :icon:`fa-caret-down` :guilabel:`(caret down)` icon
-   in the :guilabel:`Search...` bar.
-
-   Next, click :guilabel:`Add Custom Filter` in the :guilabel:`Filters` section, and a
-   :guilabel:`Add Custom Filter` pop up window loads.
-
-   Using the drop-down menu, select :guilabel:`Status` for the first drop-down, then select
-   :guilabel:`Cancelled` for the third drop-down field. Click the :guilabel:`Add` button, and only
-   appraisals that have been cancelled appear.
-
-   .. image:: reporting/custom-filter.png
-      :align: center
-      :alt: The Custom Filter pop-up with the parameters set to only show cancelled appraisals.
-
-.. _appraisals/skills-report:
-
-Skills evolution
-----------------
-
-To access the *Skills Evolution* report, navigate to :menuselection:`Appraisals app --> Reporting
---> Skills Evolution`. The :guilabel:`Appraisal Skills Report` page displays a report of all skills,
-grouped by employee.
-
-Skill levels are **only** updated after an appraisal is marked as done. Any skill level changes from
-any ongoing appraisals that have **not** been finalized are **not** included in this report.
-
-All the lines of the report are collapsed, by default. To view the details of a line, click anywhere
-on a line to expand the data.
-
-Each skill has the following information listed:
-
-- :guilabel:`Employee`: name of the employee.
-- :guilabel:`Skill Type`: the category the skill falls under.
-- :guilabel:`Skill`: the specific, individual skill.
-- :guilabel:`Previous Skill Level`: the level the employee had previously achieved for the skill.
-- :guilabel:`Previous Skill Progress`: the previous percentage of competency achieved for the skill
-  (based on the :guilabel:`Skill Level`).
-- :guilabel:`Current Skill Level`: the current level the employee has achieved for the skill.
-- :guilabel:`Current Skill Progress`: the current percentage of competency achieved for the skill.
-- :guilabel:`Justification`: any notes entered on the skill, explaining the progress.
-
-The color of the skill text indicates any changes from the previous appraisal. Skill levels that
-have increased since the last appraisal appear in green as an *Improvement*, skill levels that have
-not changed appear in black as *No Change*, and skills that have regressed appear in red as
-*Regression*.
-
-.. image:: reporting/skills-report.png
-   :align: center
-   :alt: A report showing all the skills grouped by employee.
-
-The report can have other :ref:`filters <search/filters>` and :ref:`groupings <search/group>` set in
-the :guilabel:`Search...` bar at the top.
-
-.. example::
-   Since the :guilabel:`Appraisal Skills Report` organizes all skills by employee, it can be
-   difficult to find employees with a specific skill at a specific level. To find these employees,
-   a custom filter must be used.
-
-   To view only employees with an :guilabel:`Expert` level of the :guilabel:`Javascript` skill,
-   first remove any active filters in the :guilabel:`Search...` bar.
-
-   Next, click the :icon:`fa-caret-down` :guilabel:`(caret down)` icon in the :guilabel:`Search...`
-   bar, then click :guilabel:`Add Custom Filter` in the :guilabel:`Filters` section to load an
-   :guilabel:`Add Custom Filter` pop up window.
-
-   Using the drop-down menu, select :guilabel:`Skill` for the first drop-down, then select
-   :guilabel:`Javascript` for the third drop-down field.
-
-   Next, click the :guilabel:`New Rule` button, and another line appears. In this second line,
-   select :guilabel:`Current Skill Level` for the first drop-down, then select :guilabel:`Expert`
-   for the third drop-down field.
-
-   After the :guilabel:`New Rule` button is clicked, the word :guilabel:`any` in the sentence
-   :guilabel:`Match any of the following rules:` changes from plain text into a drop-down menu.
-   Click the :icon:`fa-caret-down` :guilabel:`(caret down)` icon after the word :guilabel:`any`, and
-   select :guilabel:`all`.
-
-   Finally, click the :guilabel:`Add` button, and only employees that have an :guilabel:`Expert`
-   level for the skill :guilabel:`Javascript` appear.
-
-   .. image:: reporting/javascript.png
-      :align: center
-      :alt: The Custom Filter pop-up with the parameters set to only show employees with expert
-            level for the skill javascript.
-
-.. seealso::
-   - :doc:`Odoo essentials reporting <../../essentials/reporting>`
-   - :doc:`../../essentials/search`

redirects/17.0.txt

@@ -27,6 +27,10 @@ developer/tutorials/getting_started/16_final_word.rst developer/tutorials/server
 
 applications/general/email_communication/email_servers.rst applications/general/email_communication.rst
 
+# applications/hr
+
+applications/hr/appraisals/reporting.rst applications/hr/appraisals/appraisal_analysis.rst                                                                                                               # appraisals/reporting --> appraisals/appraisal_analysis
+
 # applications/inventory_and_mrp
 
 applications/inventory_and_mrp/inventory/product_management/product_tracking/type.rst applications/inventory_and_mrp/inventory/product_management/configure/type.rst                                        # product_tracking/type --> configure/type