This is the documentation for Clover Club 12.0.
Documentation for the upcoming version Rampur 13.0 can be found here.

Compensation Records

Owned by Jan Panoušek
Jun 14, 2024
3 min read

Compensation Records are typically created for each line of a Compensation Plan (the record is more or less a copy of the line conditions) and it is the Sales Compensation calculation logic that drives the way the records are created. There can be more Compensation Records for one line item in case that a seller requires more frequent payouts than only once a year.

Working with Compensation Records

The Compensation Records table provides a view on the status and compensation accruals across all Compensation Plans.

Compensation Record List

After you select an individual Compensation Record, you can use the buttons below and above the list to copy or mass submit Compensation Records or to export them to XLS.

Note the following system columns:

  • Source ID – Clicking its value opens the associated Compensation Plan.

  • Rank (optional) – When a Compensation Record calculation job runs, it sorts the Compensation Records by Compensation Plan’s unique name and rank, so records with a lower rank get calculated first. (Ideally there are no dependencies between Compensation Record calculations, so avoid using the Rank field for this purpose.)

Compensation Record Detail

Click a Compensation Record in the list ('COR' in the ID column) to display its details. In the detailed view, select a Compensation Record from the table (there will be one record for each line item).

Choose a Category from the drop-down list:

  • Calculation – Allows you to see how the record was calculated. Displays the calculation logic, target date and user inputs and the calculation results.

  • Text – Allows you to add notes to the record.

  • Record – Displays the whole record – all attributes and its values.

  • Calculation Base – Enables you to see the Datamart data on which the calculation is based. Typically, a filter will be applied to display data relevant for one seller and for the duration of the Compensation Plan.

  • Defined Compensation queries and Compensation charts will also be available for selection here.

Note: Compensation Records inherit user group view and edit permissions from their parent Compensation Plans. If these permissions are set, you must be member of the groups to be able to view/edit the related Compensation Records.

Further sections provide details on:

Copying Compensation Records

Copying is available only for approved Compensation Records and only for users with the Administer Compensation Records role. Once you create a copy, you are taken to the Detail view of the record where all of the values are copied in the Override status. For each copied value there is a quick menu:

  • Override result – Allows you to enter your own value.

  • Negate result value – Makes the value negative.

  • Remove override – Clears the value.

Note also that each copied record has the flag 'isManual'.

Submitting Compensation Records

Compensation Records can be submitted for approval only if there is no error or a critical alert.

Mass submit is available for Compensation Records too. For mass submit, it is necessary to have a default Compensation Calculation in place; see the note in Compensation Calculations on how this is handled so that the mass submit can always be executed. Mass approval/denial of Compensation Records is available as well.

You can review the workflow status and details after clicking the View Workflow button.

Revoking Compensation Records

The Revoke action is available only for approved records – in the Compensation Record detail view – and only for users with the Administer Compensation Records role. This action is useful when the Compensation Record was approved in Pricefx, integration did not happen yet and there is nothing to reverse in ERP. When this action is used, the record changes its status to Revoked.

Working with Integration Status Fields

The general rule is that an already approved object cannot be modified. However, these three Compensation Record fields can be updated. The record update API endpoint makes an exception when the payload (data block) specifies these ‘integration status’ fields:

  • Integration Status (intgStatus)

  • Integration Status Details (intgStatusDetails)

  • Integration ERP Reference (intgStatusErpReference)

These fields help you keep track of the integration updates. They can be customized (type, name).

You can also use these fields for filtering. On each such update, an IntegrationStatusHistory object (typeCode = ‘ISH’) is created, which stores the integration field values as well as {{itemTypedId}} := RebateRecord.typedId.

If your update request contains non-integration fields as well, you will see this error in the log: ”…integration fields updated, but overrides not allowed on approved CompensationRecord”. This has no functional impact, it just guides you how to create proper integration status update requests.

Creating a Data Source from Compensation Records

You can create a Data Source from the Compensation Records table using the Data Source template. The data can be synchronized anytime later by clicking the Sync Metadata button in the Data Source detail.