[IMP] CRM: rewrite gamification

closes #8908

Signed-off-by: Zachary Straub (zst) <[email protected]>
Co-authored-by: hojo-odoo <[email protected]>
Co-authored-by: StraubCreative <[email protected]>

Author: 3 people

content/applications/sales/crm/optimize/gamification.rst

@@ -1,86 +1,159 @@
-==========================================
-How to motivate and reward my salespeople?
-==========================================
+================
+CRM Gamification
+================
 
-Challenging your employees to reach specific targets with goals and rewards is an excellent way to
-reinforce good habits and improve your salespeople productivity. The Gamification module gives you
-simple and creative ways to motivate and evaluate your employees with real-time recognition and
-badges inspired by game mechanics.
+In Odoo's *CRM* app, *gamification tools* provide the opportunity to evaluate and motivate users
+through customizable challenges, goals, and rewards. Goals are created to target actions within the
+*CRM* app, and can be tracked and rewarded automatically to participating sales teams.
 
 Configuration
 =============
 
-Install the *Gamification* module, or the *CRM gamification* one, which adds some useful data
-(goals and challenges) that can be used on *CRM/Sale*.
+To install the *Gamification* module, navigate to the :menuselection:`Apps` application. Click into
+the :guilabel:`Search...` bar at the top of the page and remove the :guilabel:`Apps` filter. Type
+`Gamification` to search.
 
-.. image:: gamification/gamification_module_install.png
-   :align: center
-   :alt: View of the gamification module being installed in Odoo
+If the :guilabel:`Gamification` module is **not** already installed, click :guilabel:`Install`.
+After completing the installation, return to the :menuselection:`Apps` application and search for
+`Gamification` again.
 
-Create a challenge
-==================
+On the :guilabel:`CRM Gamification` module, click :guilabel:`Install`. This module features goals
+and challenges related to the *CRM* and *Sales* applications.
 
-Now, create your first challenge by going to :menuselection:`Settings --> Gamification Tools
---> Challenges`.
+.. image:: gamification/gamification-module-install.png
+   :align: center
+   :alt: View of the gamification module being installed in Odoo.
 
 .. note::
-   As the gamification tool is a one-time technical setup, you need to activate the technical
-   features in order to access the configuration. To do so, go to *Settings* and *Activate the
-   developer mode*.
+   If both the *CRM* and *Sales* apps are installed, the *CRM Gamification* module is automatically
+   installed on the database.
+
+To access the *Gamification Tools* menu, first enable :ref:`developer-mode`.
 
-.. image:: gamification/gamification_tools_menu.png
+Next, navigate to :menuselection:`Settings app --> Gamification Tools`.
+
+.. image:: gamification/gamification-tools-menu.png
    :align: center
    :alt: View if the gamification tools menu in Odoo Settings
 
-A challenge is a mission that you send to your sales team. It can include one or several goals, set
-for a specific period of time. Configure your challenge as follows:
+.. _crm/create-rewards:
 
-#. Assign the salespeople to be challenged;
-#. Assign a responsible;
-#. Set up the periodicity along with the start and the end date;
-#. Select your goals;
-#. Set up your rewards (badges).
+Create badges
+=============
 
-.. note::
-   Badges are granted when a challenge is finished. This is either at the end of a running period
-   (eg: end of the month for a monthly challenge), at the end date of a challenge (if no periodicity
-   is set), or when the challenge is manually closed.
+*Badges* are awarded to users when they have completed a challenge. Different badges can be awarded
+based on the type of task completed, and can be issued to more than one user, depending on the time
+they accomplish the goal.
 
-In the example below, 2 employees are being challenged with a *Monthly Sales Target*. The challenge
-is based on 2 goals: the total amount invoiced and number of new leads generated. At the end of the
-month, the winner will be granted with a badge.
+To view the existing badges, or create a new one, navigate to :menuselection:`Settings -->
+Gamification Tools --> Badges`.
 
-.. image:: gamification/challenges.png
+.. image:: gamification/badges.png
    :align: center
-   :alt: View of the challenge form and a challenge being created for Odoo Sales
+   :alt: View of the badges page in Odoo.
 
-Set up goals
-------------
+.. note::
+   Some badges can be awarded outside of challenges, as well. Select the Kanban card for the desired
+   badge, then click :guilabel:`Grant`. This opens a :guilabel:`Grant Badge` pop-up window. Select
+   a user from the :guilabel:`Who would you like to reward?` field.
+
+   Add any additional information regarding why the user is receiving the reward in the field below,
+   then click :guilabel:`Grant Badge`.
+
+To create a new badge, click :guilabel:`New` at the top-left of the page to open a blank form.
+Enter a name for the :guilabel:`Badge`, followed by a description.
+
+The :guilabel:`Allowance to Grant` field determines when a badge can be granted, and by whom:
+
+- :guilabel:`Everyone`: this badge can be manually granted by any user.
+- :guilabel:`A selected list of users`: this badge can only be granted by a select group of users.
+  If this option is selected, it generates a new field, :guilabel:`Authorized Users`. Choose the
+  appropriate users from this drop-down list.
+- :guilabel:`People having some badges`: this badge can only be granted by users who have already
+  been awarded a specific badge. If this option is selected it generates a new field,
+  :guilabel:`Required Badges`. Use this drop-down list to select the badge(s) a user must have before they
+  can award this badge to others.
+- :guilabel:`No one, assigned through challenges`: this badge cannot be manually granted, it can
+  only be awarded through challenges.
+
+To limit the number of badges a user can send, tick the :guilabel:`Monthly Limited Spending`
+checkbox. This sets a limit on the number of times a user can grant this badge. In the
+:guilabel:`Limitation Number` field, enter the maximum number of times this badge can be sent per
+month, per person.
+
+.. image:: gamification/create-badge.png
+   :align: center
+   :alt: The details page for a new badge.
 
-| The users can be evaluated using goals and numerical objectives to reach.
-| **Goals** are assigned through *challenges* that evaluate (see image above) and compare members of
-  a team throughout time.
-| You can create a new goal on the fly from a *Challenge* by clicking on *Add new item*, under
-  *Goals*. Select the business object according to your company's needs. Examples: number of new
-  leads, time to qualify a lead, total amount invoiced in a specific week, month or any other time
-  frame based on your management preferences, etc.
+.. _crm/create-challenge:
 
-.. image:: gamification/goal_definitions.png
-   :align: center
-   :alt: View of the goal definition form and a goal definition being created for Odoo Sales
+Create a challenge
+==================
 
-.. note::
-   Goals may include your database setup as well (e.g. set your company data and a timezone,
-   create new users, etc.).
+To create a challenge, navigate to to :menuselection:`Settings --> Gamification Tools -->
+Challenges`. Click :guilabel:`New` in the top-left corner to open a blank challenge form.
 
-Set up rewards
---------------
+At the top of the form, enter a :guilabel:`Challenge Name`.
 
-For non-numerical achievements, **Badges** can be granted to users. From a simple thank you to an
-exceptional achievement, a badge is an easy way to express gratitude to a user for their good work.
-To create and grant badges to your employees based on their performance, go to
-:menuselection:`Settings --> Gamification Tools --> Badges`.
+Create assignment rules
+-----------------------
 
-.. image:: gamification/badges.png
+To assign the challenge to specific users, one or more assignment rules must be utilized.
+
+Click into the first field under :guilabel:`Assign Challenge to`, and select a parameter from the
+drop-down list to define the rule. Then, click into the next field to define the rule's operator. If
+necessary, click into the third field to further define the parameter.
+
+.. tip::
+   To include all users with permissions in the *Sales* app, create a rule with the following
+   parameters:
+   - :guilabel:`Groups`
+   - :guilabel:`is in`
+   - `Sales/User: Own Documents Only`
+
+   .. image:: gamification/assignation-rule.png
+     :align: center
+     :alt: View of the assignation rules section of a Challenge form.
+
+In the :guilabel:`Periodicity` field, select a time frame for goals to be automatically assessed.
+
+Add goals
+---------
+
+Challenges can be based on a single goal, or can include multiple goals with different targets. To
+add a goal to the challenge, click :guilabel:`Add a line` on the :guilabel:`Goals` tab.
+
+In the :guilabel:`Goal Definition` field, choose a goal from the drop-down list. The
+:guilabel:`Condition` field automatically updates to reflect the condition set on the goal
+definition.
+
+.. tip::
+   The *CRM Gamification* module contains preconfigured goals geared towards salesteams:
+
+   - :guilabel:`New Leads`
+   - :guilabel:`Time to Qualify a Lead`
+   - :guilabel:`Days to Close a Dead`
+   - :guilabel:`New Opportunities`
+   - :guilabel:`New Sales Orders`
+
+Enter a :guilabel:`Target` for the goal based on the :guilabel:`Suffix`.
+
+Repeat these steps for each additional goal.
+
+.. image:: gamification/challenge-goals.png
    :align: center
-   :alt: View of the badges page in Odoo
+   :alt: The goals tab of a challenge form.
+
+Add rewards
+-----------
+
+Next, click the :guilabel:`Reward` tab. Choose the :ref:`badges <crm/create-rewards>` to be awarded
+:guilabel:`For 1st User` and :guilabel:`For Every Succeeding User` by selecting them from the
+drop-down lists.
+
+.. note::
+   Badges are granted when a challenge is finished. This is either at the end of a running period,
+   at the end date of a challenge, or when the challenge is manually closed.
+
+After setup is complete, click the :guilabel:`Start Challenge` button at the top-left of the page to
+begin the challenge.