Compensation Header Type (COHT)

Since version 9.0

When users create a new Compensation Plan document, they always select of which compensation type the new document will be.

The Sales Compensation Type defines:

Which logic will be used for summary calculations of the compensation agreement header.
Which logic will be used to filter the available Compensation Condition Types when the user is adding a new item to the Compensation Plan.
Which logic will build the approval workflow steps for the Compensation Plan.
Which logic will build the approval workflow steps for the Compensation Record.

Configuration

The Compensation Header Types are defined based on project needs and their meta definitions must be stored in the version system together with other configurations.

To configure COHT, navigate to Sales Compensations › Compensation Types.

Fields

uniqueName

Serves as a unique identification of this type. This name will be used in the Compensation Plan document as a foreign key, to identify the Compensation Header Type used.

headerFormulaName

Name of the logic used for building inputs and calculating results for the Compensation Plan header, but it can also manipulate the items and folders.

workflowFormulaName

Name of the approval workflow logic which will build the approval steps for the Compensation Plan document.

creationWorkflowFormulaName

Name of the creation workflow logic which builds the steps of document creation workflow. (available from version 14.0)

scRecordWorkflowFormulaName

Name of the approval workflow logic which will build the approval steps for the Compensation Records.

scTypeFilterFormulaName

Name of logic which will be used to filter the available Compensation Condition Types when the user is adding a new item to the Compensation Plan document.

configuration

Configuration (as JSON string) of the detail page. You can configure e.g the additional tabs on the Compensation Plan detail page which will show information in a form of a dashboard. See Detail Page Layout and Dynamic Tabs for more details.

attribute1..30

These fields are typically used as parameters for the compensation logic. For example, if two types of compensations have the same majority of the item calculations, you can use a single logic (in this case probably for the header) and when the logic is executed, it can read the Compensation Header Type attributes to understand which specific calculations it should do for the current document.