This page is the administrator's reference for the Rewards module: what the platform validates and locks on incentive plans, how periods are generated, which actions ship on the Rewards entities, and exactly which KPI field each target type reads. For the concepts behind these rules, start at Incentive plans.
Access
The Rewards app appears in a user's navigation when granted through their security profile. Its entities — Incentive Plan, Compensation, KPI Configuration, Resource, Resource Group, Scheme — follow the platform's record security like any other entity.
Plan validation rules
Enforced when an incentive plan is saved:
| Rule | Detail |
|---|---|
| Scope exclusivity | A partner account group cannot be combined with a partner account or a branch — pick group scoping or direct scoping |
| Resource type gating | Member resource type may only be set when the member type is Resource |
| Period length | Daily, Weekly and Bi Weekly plans are limited to one year between period start and end |
| Date order | Valid-from must not fall after valid-to |
| Locked fields | Once the plan has incentive resources or targets: branch, member type, partner account, partner account group, period type and member resource type can no longer change |
Period generation
Periods are generated once, when the plan is created, from its period type and start/end dates:
| Period type | Generates |
|---|---|
| Yearly | One period covering the range |
| Quarterly | One period per three months, from the first of the start month |
| Monthly | One period per calendar month |
| Weekly / Bi Weekly | One period per week or fortnight, weeks aligned to Monday |
| Daily | One period per day |
Period names are derived from their dates (for example a monthly period is named after its month and year). Because generation happens at creation, changing dates later does not add or remove periods — plan the range before saving.
Seeded actions
The Rewards entities ship with the standard New, Edit and Delete actions (list, row and detail variants) on Incentive Plan, Incentive Line, Incentive Target, Incentive Period, Incentive Resource, Incentive Resource Target, Compensation, Compensation Line and Compensation Slab. The Incentive Plan detail page additionally carries three create actions:
| Action | Creates |
|---|---|
| Create Incentive Target | A measure definition on the plan |
| Create Incentive Line | A qualification line grouping targets |
| Create Compensation Slab | A payout band on a line |
The plan page's slab builder widget drives the same three record types as one guided flow, and the target grids edit incentive resource target values in bulk.
Evaluation trigger
The incentive engine runs inside the save pipeline of Compensation Line records — every create or update of a line evaluates it once against the current plan definition, target values and Performance KPI data. Only plans with status Approved are considered. There is no separate scheduler to configure: evaluation frequency is entirely a function of when compensation lines are saved. See execution order for where save-pipeline logic sits generally.
Target type reference
What each target type reads from the member's matching Performance KPI records, and where the achieved figure is stamped on the compensation line:
| Target type | Sums (Performance KPI) | Stamped on line as |
|---|---|---|
| No Of Sale Orders | Number of orders | No of Bookings |
| No Of Invoices | Number of invoices | No of Invoices |
| Sale Order Amount | Total sale order amount | Sale Order Amount |
| Sale Amount | Total sale invoice amount | Sale Amount |
| Sale Order Quantity | Total sale order quantity | Sale Order Quantity |
| Invoice Quantity | Total sale invoice quantity | Sale Quantity |
| Purchase Order Amount | Total purchase order amount | Purchase Order Amount |
| Purchase Order Quantity | Total purchase order quantity | Purchase Order Quantity |
| No Of Unique Invoices | Count of distinct accounts | No Of Unique Invoices |
| No Of Unique Items | Count of distinct items | No Of Unique Items |
| Custom KPI | The field named on the target | Custom KPI value |
KPI records match a member by the plan's member type — resource plans match the record's resource, partner plans its partner account, branch plans its branch, customer plans its account — and then by the target's item, item group (SKU-aware) and account filters.
Common questions
Why can't a user edit member type or period type on a plan?
The plan has incentive resources or targets — from that point the structural fields are locked because periods, assignments and KPI matching all derive from them. The fix is a new plan, not an edit.
Do all lines need slabs?
Rewards are written from slabs that qualify through targets, so a line without slabs — or with the filter criteria Always (No Criteria), which skips target evaluation — produces no payout. Every paying line needs at least one target and one slab whose percentage bands cover the achievement range you intend to reward, including an open-ended top band.
What should an administrator check before a period goes live?
Plan status Approved; every member enrolled with the correct member reference for the plan's member type; a target value per member per period (no zeros — a zero target can never qualify); slabs whose bands meet without gaps. The troubleshooting page is the after-the-fact version of this list.