This is the documentation for Clover Club 12.0.
Documentation for the upcoming version Rampur 13.0 can be found here.
Accrual Records
- Jan Panoušek
Accrual Records are lightweight Compensation Records which are useful in situations when you need to generate thousands of Compensation Records that represent all possible combinations of several attributes (customer, product, period, etc.). To avoid overloading the system, you can use lightweight Accrual Records with a lot simpler data structure.
An Accrual Record has the following features:
It is an attributed object that stores the calculated compensation amount(s) (accruals) + seller (e.g., store) and product level attributes, i.e., primitive values – it is not intended for large data structures.
A total of 100 generic attributes are available for this purpose.
It has built-in fields to reference the original Compensation Record and identify the Accrual Record by name, within the scope of the (top level) Compensation Record. This is the list of available built-in fields:
Field name | Label | Type |
|---|---|---|
compensationRecordUN | Compensation Record | String |
type | Type | String |
name | Name | String |
label | Description | String |
startDate | Start Date | Date |
endDate | End Date | Date |
payoutDate | Payout Date | Date |
compensationType | Condition Type | String |
status | Status | String |
createDate | Created | Date |
lastUpdateDate | Last Update Date | Date |
createdBy | Created By | String |
lastUpdateBy | Last Updated By | String |
Global attribute metadata, i.e., a single set of attribute meta config (not per Compensation Plan or any other level).
There are no predefined Accrual Record types or statuses. The Sales Compensation logic decides which Type and Status to initialize or update an Accrual Record with. In the UI, there is an option of limited control on visibility of the records by Type and Business Roles, as well a status transitions when using the Mass-Edit functionality.
There is no workflow available.
Accrual Records are created by a Compensation Record logic, i.e., in the context of the Compensation Record Calculation task (given that this is a background job, large amounts of records can be created). The logic bears the full responsibility for the Accrual Record creation, update and deletion (by name).
It has also full control over the content (field values) of the records.Accrual Records are deleted automatically when their parent Compensation Record is deleted.