Skip to content

Commit bb42fd6

Browse files
committed
[ADD] Employees: New badges doc
1 parent dc57d7a commit bb42fd6

File tree

4 files changed

+94
-0
lines changed

4 files changed

+94
-0
lines changed

content/applications/hr/employees.rst

+6
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ reporting.
2727

2828
Certify employees as subject matter experts with certifications.
2929

30+
.. card:: Badges
31+
:target: employees/badges
32+
33+
Grant badges to employees for performance and achievements.
34+
3035
.. card:: Equipment
3136
:target: employees/equipment
3237

@@ -114,6 +119,7 @@ employee record.
114119
employees/onboarding
115120
employees/departments
116121
employees/certifications
122+
employees/badges
117123
employees/equipment
118124
employees/offboarding
119125
employees/retention_report
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
======
2+
Badges
3+
======
4+
5+
In Odoo, employees can earn badges, either automatically through :doc:`challenges created in the CRM
6+
app <../../sales/crm/optimize/gamification>`, through **eLearning** courses, or manually, as
7+
managers decide to award them.
8+
9+
Badges are a way to gamify the work day, and can be created for any reason, and can be granted to
10+
any user.
11+
12+
.. important::
13+
Badges can **only** be awarded to :doc:`users of the database <../../general/users>`, *and* if
14+
the **eLearning** app is installed.
15+
16+
View available badges
17+
=====================
18+
19+
To view the available badges that are configured by default, navigate to :menuselection:`Employees
20+
app --> Configuration --> Badges`.
21+
22+
All badges appear in a default Kanban view, with the badge's :guilabel:`Name` and image displayed.
23+
Additionally, the number of users awarded the badge for both the current month, and in total,
24+
appears, along with the badge description, and the avatar for each user who received the badge.
25+
26+
Each badge has a :guilabel:`Grant` button to :ref:`award the badge <employees/grant_badge>` from the
27+
:guilabel:`Badges` dashboard.
28+
29+
.. image:: badges/badges.png
30+
:alt: All the available badges, on the Badges dashboard.
31+
32+
Create badges
33+
=============
34+
35+
Badges can be created in the database when the default badges are not sufficient. This can be done
36+
from the :guilabel:`Badges` dashboard in the **Employees** app, or from the **CRM** app.
37+
38+
To add a badge in the **Employees** app, first navigate to :menuselection:`Employees app -->
39+
Configuration --> Badges`, then click the :guilabel:`New` button in the upper-left corner.
40+
41+
Fill out the badge form as outlined in the :ref:`CRM documentation <crm/create-rewards>`.
42+
43+
View employee badges
44+
====================
45+
46+
To view badges awarded to an employee, open the **Employees** app, and click on an employee record.
47+
Click on the :guilabel:`Received Badges` tab to view any awarded badges.
48+
49+
.. note::
50+
If this tab is not visible, it means there is no :guilabel:`Related User` in the
51+
:guilabel:`Settings` tab. Once a user populates the :guilabel:`Related User` field, the
52+
:guilabel:`Badges` tab appears.
53+
54+
If no badges have been awarded, the following text appears in the :guilabel:`Badges` tab:
55+
56+
`Grant this employee his first badge.`
57+
58+
`Badges are rewards of good work. Give them to people you believe deserve it.`
59+
60+
.. _employees/grant_badge:
61+
62+
Grant badges
63+
============
64+
65+
To grant a badge to an employee, open the employee record, and click into the :guilabel:`Received
66+
Badges` tab. Click the :guilabel:`Grant a Badge` button to load a :guilabel:`Reward Employee` pop-up
67+
window.
68+
69+
Using the drop-down menu, select the badge being awarded in the :guilabel:`What are you thankful
70+
for?` field. The default options are :guilabel:`Good Job`, :guilabel:`Problem Solver`, and
71+
:guilabel:`Brilliant`.
72+
73+
.. note::
74+
Additional options appear (e.g., :guilabel:`Get Started`, :guilabel:`Power user`,
75+
:guilabel:`community Hero`) which are associated with challenges. These are automatically granted
76+
through completed challenges. While these can be awarded at any time, it is advised to grant
77+
badges manually that are *not* associated with a challenge.
78+
79+
Next, enter a brief summary why the badge is being granted in the field displaying
80+
:guilabel:`Describe what they did and why it matters (will be public)` field. Last, click the
81+
:guilabel:`Reward Employee` button, and the badge is awarded, and is visible in the
82+
:guilabel:`Badges` tab.
83+
84+
.. note::
85+
Users cannot grant themselves badges. An error message appears if attempted.
86+
87+
.. image:: badges/badge.png
88+
:alt: The 'Reward Employee' field populated.
Loading
Loading

0 commit comments

Comments
 (0)