Skip to content

[ADD] Employees: Badges #13348

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
6 changes: 6 additions & 0 deletions content/applications/hr/employees.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ reporting.

Certify employees as subject matter experts with certifications.

.. card:: Badges
:target: employees/badges

Grant badges to employees for performance and achievements.

.. card:: Equipment
:target: employees/equipment

Expand Down Expand Up @@ -114,6 +119,7 @@ employee record.
employees/onboarding
employees/departments
employees/certifications
employees/badges
employees/equipment
employees/offboarding
employees/retention_report
88 changes: 88 additions & 0 deletions content/applications/hr/employees/badges.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
======
Badges
======

In Odoo, employees can earn badges, either automatically through :doc:`challenges created in the CRM
app <../../sales/crm/optimize/gamification>`, through **eLearning** courses, or manually, as
managers decide to award them.

Badges are a way to gamify the work day, and can be created for any reason, and can be granted to
any user.

.. important::
Badges can **only** be awarded to :doc:`users of the database <../../general/users>`, *and* if
the **eLearning** app is installed.

View available badges
=====================

To view the available badges that are configured by default, navigate to :menuselection:`Employees
app --> Configuration --> Badges`.

All badges appear in a default Kanban view, with the badge's :guilabel:`Name` and image displayed.
Additionally, the number of users awarded the badge for both the current month, and in total,
appears, along with the badge description, and the avatar for each user who received the badge.

Each badge has a :guilabel:`Grant` button to :ref:`award the badge <employees/grant_badge>` from the
:guilabel:`Badges` dashboard.

.. image:: badges/badges.png
:alt: All the available badges, on the Badges dashboard.

Create badges
=============

Badges can be created in the database when the default badges are not sufficient. This can be done
from the :guilabel:`Badges` dashboard in the **Employees** app, or from the **CRM** app.

To add a badge in the **Employees** app, first navigate to :menuselection:`Employees app -->
Configuration --> Badges`, then click the :guilabel:`New` button in the upper-left corner.

Fill out the badge form as outlined in the :ref:`CRM documentation <crm/create-rewards>`.

View employee badges
====================

To view badges awarded to an employee, open the **Employees** app, and click on an employee record.
Click on the :guilabel:`Received Badges` tab to view any awarded badges.

.. note::
If this tab is not visible, it means there is no :guilabel:`Related User` in the
:guilabel:`Settings` tab. Once a user populates the :guilabel:`Related User` field, the
:guilabel:`Badges` tab appears.

If no badges have been awarded, the following text appears in the :guilabel:`Badges` tab:

`Grant this employee his first badge.`

`Badges are rewards of good work. Give them to people you believe deserve it.`

.. _employees/grant_badge:

Grant badges
============

To grant a badge to an employee, open the employee record, and click into the :guilabel:`Received
Badges` tab. Click the :guilabel:`Grant a Badge` button to load a :guilabel:`Reward Employee` pop-up
window.

Using the drop-down menu, select the badge being awarded in the :guilabel:`What are you thankful
for?` field. The default options are :guilabel:`Good Job`, :guilabel:`Problem Solver`, and
:guilabel:`Brilliant`.

.. note::
Additional options appear (e.g., :guilabel:`Get Started`, :guilabel:`Power user`,
:guilabel:`community Hero`) which are associated with challenges. These are automatically granted
through completed challenges. While these can be awarded at any time, it is advised to grant
badges manually that are *not* associated with a challenge.

Next, enter a brief summary why the badge is being granted in the field displaying
:guilabel:`Describe what they did and why it matters (will be public)` field. Last, click the
:guilabel:`Reward Employee` button, and the badge is awarded, and is visible in the
:guilabel:`Badges` tab.

.. note::
Users cannot grant themselves badges. An error message appears if attempted.

.. image:: badges/badge.png
:alt: The 'Reward Employee' field populated.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.