Reward Rules
Reward Rules¶
The Reward Rules section lets an administrator manage rules that define how users earn Points or Experience for different events (e.g., new friend accepted/confirmed, gifts, weekly prize place). Each rule includes an identifier, calculation settings, message template, and an optional URL.
Steps¶
-
Navigate to Gamification -> Reward Rules to see the list of existing rules.
-
(Optional) Use the filters in the table header to find a rule:
- Identifier
- Parameter
- Rate
- Type
- Message Text
- URL
-
Click 🔍 Search to apply filters or ✖ Clear to reset them.
-
To add a new rule, click Add button in the top-right corner of the page.
-
In the Add form, fill in the required fields:
- Identifier — unique rule name (system key).
- Rate — the base value used for calculation.
- Type — choose Points or Experience.
-
Configure additional fields:
- Parameter — used in the calculation (see formula hint in the form).
- If Parameter is set:
points = parameter × rate - If Parameter is empty:
points = rate
- If Parameter is set:
- Message Text — text shown to the user for this event (supports placeholders like
{{ calculated_value }},{{ friend_name }}, etc.). - URL — optional link related to the event (may support substitutions such as school id).
- Parameter — used in the calculation (see formula hint in the form).
-
Click Submit to save the rule, or Cancel to discard changes.
-
To edit or remove an existing rule, click the actions menu (right-side dropdown) and select:
- Edit — update the rule fields.
- Remove — delete the rule.