[ADD] Referrals: reporting doc with use case

closes odoo/documentation#10993

Signed-off-by: Lara Martini (larm) <larm@odoo.com>
This commit is contained in:
larm-odoo 2024-09-11 17:45:55 -04:00
parent b752040eb0
commit db78ddcdf9
4 changed files with 90 additions and 33 deletions

View File

@ -18,7 +18,7 @@ related to the :doc:`rewards <referrals/rewards>`; everything else is pre-config
Users with either :guilabel:`Referral User`, :guilabel:`Officer`, or :guilabel:`Administrator`
access rights for the *Recruitment* application have access to the *Referrals* application. Only
users with :guilabel:`Administrator` access rights for the *Recruitment* application have access to
the :ref:`reporting <referrals/reporting>` and configurations menus. For more information on users
the :doc:`reporting <referrals/reporting>` and configurations menus. For more information on users
and access rights, refer to these documents: :doc:`../general/users` and
:doc:`../general/users/access_rights`.
@ -255,46 +255,16 @@ points required.
can be redeemed for rewards, but they are no longer able to level up. The ring around their photo
remains solid cyan.
.. _referrals/reporting:
Reporting
=========
Only users with :guilabel:`Administrator` rights for the *Recruitment* application have access to
the Reporting feature in *Referrals*. To access the reports, click :menuselection:`Referrals
application --> Reporting`. The main view is the Reporting Dashboard view, which contains three
sections.
In the top portion of the window, the report displays a bar chart of how many referred candidates
are hired, and how many are still in the hiring pipeline. The candidates are further divided by
channel, showing specifically where the referral came from, such as a direct referral, Facebook,
etc. If a channel does not appear on the report, that indicates there are no referrals from that
particular channel.
The middle third provides all the specific data that has been tracked. This includes how many total
points have been earned across all referrals, how many applicants were referred, hired, or refused,
how many applicants the current logged-in user referred, how many total points were earned, and how
many points were given for refused applicants.
The bottom third displays a pivot table. This table can be inserted into a new or existing
spreadsheet. To do so, click the :guilabel:`Insert in Spreadsheet` button right above the chart. A
pop-up appears, asking which spreadsheet to insert the pivot chart into. Select the desired
spreadsheet from the drop-down menu, or select :guilabel:`New Spreadsheet`. Click
:guilabel:`Confirm` and the selected spreadsheet loads, with the new table in it.
.. note::
The spreadsheet is stored in the *Documents* application. This application needs to be installed
to use the :guilabel:`Insert in Spreadsheet` option.
.. seealso::
- :doc:`referrals/share_jobs`
- :doc:`referrals/points`
- :doc:`referrals/rewards`
- :doc:`referrals/alerts`
- :doc:`referrals/reporting`
.. toctree::
referrals/share_jobs
referrals/points
referrals/rewards
referrals/alerts
referrals/reporting

View File

@ -0,0 +1,87 @@
=========
Reporting
=========
The reporting function in the **Referrals** app helps recruiters and managers learn where applicants
are applying from, when referred by a current employee. Additionally, the reporting feature shows
the number of applicants hired, refused, and still in the recruitment pipeline, for each medium.
.. important::
Only users with *Administrator* rights for the **Recruitment** app have access to the reporting
feature in the **Referrals** app.
Employees referral analysis report
==================================
To access the *Employees Referral Analysis* report, navigate to :menuselection:`Referrals app -->
Reporting`. This loads the :guilabel:`Employees Referral Analysis` report, in a default
:icon:`fa-bar-chart` :guilabel:`Bar Chart`.
The graph is presented in a :icon:`fa-database` :guilabel:`Stacked` view, with the number of
referrals on the y-axis, and the source, referred to as the :guilabel:`Medium`, of the applicant
(e.g.: *Facebook*, *LinkedIn*, *Email*, etc.) on the x-axis. If a medium does **not** appear on the
report, that indicates there are no referrals from that particular medium.
Referral amounts for all stages are displayed, including :guilabel:`Not Hired` (refused),
:guilabel:`In Progress`, and :guilabel:`Hired`. The default filter is set to the current month.
Hover over any bar to view a popover containing specific data for that particular bar.
In this view, it is easy to see which :guilabel:`Medium` is the most successful.
.. example::
In this example, both :guilabel:`Email` and :guilabel:`LinkedIn` are the mediums with the most
referrals, but :guilabel:`Email` has the most referrals that were hired.
.. image:: reporting/employee-report.png
:align: center
:alt: The default report in the Referrals app.
Use case: hired referrals
-------------------------
One way to use the reporting feature is to assess which employees are referring the highest quality
applicants. This is done by examining how many of their referrals go on to become employees.
In this example, data is examined to determined which employee has the highest number of hired
referrals for the current year.
To view this information, first click the :icon:`oi-view-pivot` :guilabel:`(Pivot)` icon in the
upper-right corner. Next, remove the current filter in the search bar.
Click the :icon:`fa-caret-down` :guilabel:`(down arrow)` in the search bar to reveal a drop-down
menu. Click :guilabel:`Date` in the :icon:`fa-filter` :guilabel:`Filters` column, revealing a
drop-down menu of available time periods, and click the current year (in this example,
:guilabel:`2024`).
Next, click :guilabel:`Measures` :icon:`fa-caret-down`, then deselect :guilabel:`Earned Points` and
:guilabel:`Employee Referral Refused` to hide those metrics. Click anywhere on the screen to close
the drop-down menu.
The information displayed shows how many total applicants each employee referred, and how many of
those applicants were hired, for the current year.
In this example, it can be determined that :guilabel:`Bob Wilson` is the most successful referrer,
with three hired referrals, and nine total referred applicants. Additionally, :guilabel:`Mitchell
Admin` has the lowest performance in terms of referrals, as he has only one applicant, and no hires.
This information can be helpful to the recruitment team, so they can determine the most active
referrers in the company, and who is the most successful in terms of hires.
.. image:: reporting/employee-counts.png
:align: center
:alt: The customized report showing which employees have the most referrals and hires.
.. tip::
The pivot table can be inserted into a new or existing :doc:`spreadsheet
<../../productivity/spreadsheet/insert>`, if desired.
To do so, click the :guilabel:`Insert in Spreadsheet` button right above the chart. A pop-up
window appears, asking which spreadsheet to insert the pivot chart into. Select the desired
spreadsheet or dashboard from the presented options. Alternatively, select :guilabel:`Blank
Spreadsheet` to create a new one.
Click :guilabel:`Confirm`, and the selected spreadsheet loads, with the new table in it.
The spreadsheet is stored in the *Documents* application. This application **must** be installed
to use the :guilabel:`Insert in Spreadsheet` option.

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB