Revision: 6e79db3654
Create Wiki Page
Restore Revision
@@ -0,0 +1,85 @@
+<p align="justify"> Energy Points System is a rating/karma system that you can enable for your organization.</p>
+
+<p align="justify"> This system can be used to track the performance of each user.</p>
+
+<p align="justify"> To enable Energy Point System go to Energy Point Settings check Enabled.</p>
+
+<h2> 1. How to use the Energy Point System? </h2>
+<p align="justify"> To start using this system you need to create some Energy Point Rules (see section 3. How to create Energy Point Rules?) so that users can get energy points based on their activities.</p>
+
+<h2> 2. What are Energy Point Rules? </h2>
+<p align="justify"> Energy Point Rules store the information about the activity and the value of points to be allocated.</p>
+
+<p align="justify"> Energy Point Rule has the following fields:</p>
+<table class="table table-bordered">
+<thead>
+<tr>
+ <th>Field</th>
+ <th style="text-align:left;">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+ <td>Reference DocType</td>
+ <td style="text-align:left;">Document Type you want to apply the rule on eg. Task, ToDo, Issue, etc.</td>
+</tr>
+<tr>
+ <td>For Document Event</td>
+ <td style="text-align:left;">Options: Save, Submit, Cancel, and Custom.<br><strong>Note:</strong> If "Custom" option is selected then the "Conditions" field becomes mandatory</td>
+</tr>
+<tr>
+ <td>Points</td>
+ <td style="text-align:left;">Points to be allocated.</td>
+</tr>
+<tr>
+ <td>Allot Points To Assigned Users</td>
+ <td style="text-align:left;">If checked, users assigned to the reference document will get points. eg. If users Reema and Jai are assigned to a particular task then both of them i.e, Reema and Jai will get points when the document fulfills the condition</td>
+</tr>
+<tr>
+ <td>User Field</td>
+ <td style="text-align:left;">Field from which user will be selected eg. <code>Resolved By</code>, <code>Modified By</code>, <code>Owner</code>, etc. can be used. If <code>Modified By</code> is selected, the last person to satisfy the doc condition will get the points.</td>
+</tr>
+<tr>
+ <td>Multiplier Field</td>
+ <td style="text-align:left;">Field which stores value for the multiplier. This field can take numeric and decimal values which will be multiplied with points defined in the rule. <br> For example: 2 (multiplier) * 10 (points set in the rule) = 20 points</td>
+</tr>
+<tr>
+ <td>Condition</td>
+ <td style="text-align:left;">Condition for the point allocation. <br>eg. <code>doc.status == 'Closed'</code><br>The above condition will check whether the <code>status</code> field in the document is 'Closed' and if yes then the points will be allocated to the user.</td>
+</tr>
+<tr>
+ <td>Apply Only Once</td>
+ <td style="text-align:left;">The rule will be applied only once per document.</td>
+</tr>
+</tbody>
+</table>
+
+<blockquote>
+ <p><strong>Note:</strong> User Field and Multiplier Field are fetched from the reference doctype.</p>
+</blockquote>
+
+<h2> 3. How to create Energy Point Rules? </h2>
+<p align="justify"> Search for Energy Point Rule > create new Energy Point Rule</p>
+
+<p align="justify"> Take a look at the following example rule:</p>
+<p align="justify"> Suppose, you want to create a rule where a user gets points on completing a task, So when any user completes the task he/she will be rewarded with 5 points. you can do so by creating following rule</p>
+<img src="/files/Energy point rule.png">
+<p align="justify"> Other cases can be covered similarly.</p>
+
+<h2> 4. Features</h2>
+<h3> 4.1 Auto Point allocation </h3>
+<p align="justify"> Based on energy point rules created, users will automatically get points when they complete activities which are tracked using the Energy Point System.</p>
+
+<h2> 4.2 Review System </h2>
+<p align="justify"> Review system can be used to "Appreciate" or "Criticize" someone's work.</p>
+<p align="justify"> For reviewing, the user needs to have review points which can be assigned by System Manager through Energy Point Settings.</p>
+<p align="justify"> You can also setup auto review point allocation from 'Energy Point Settings':</p>
+<img src="/files/Energy point settings.png">
+<h3> 4.3 Leaderboard </h3>
+<p align="justify"> Go to Social Home > Leaderboard (side navigation bar)</p>
+
+<p align="justify"> The leaderboard shows the user's standing in the organization.</p>
+
+
+
+