Rebate Agreement Type / HeaderRebateType (HRT)

This is available since Godfather 8.0.

When users creates a new Rebate Agreement document, they always select which Rebate Agreement Type the new document will belong to.

The rebate agreement type defines:

Which logic to use for summary calculations of the Rebate Agreement header.
Which logic to use to filter the available Rebate Types when the user is adding a new item to the agreement.
Which logic will build the approval workflow steps for the Rebate Agreement.
Which logic will build the approval workflow steps for the Rebate Record.

Configuration

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

To configure a Rebate Agreement Type, navigate to Rebates › Rebate Agreement Types.

You can look at the sample configuration file of Rebate Agreement Type.

Fields

configuration – Configuration (as JSON string) of the detail page. You can configure e.g the additional tabs on the Rebate Agreement detail page which will show information in the form of a dashboard. See definition of the Dynamic Tabs for more details.
uniqueName – Serves as a unique identification of this type. This name will be used in the Rebate Agreement document as a foreign key, to identify the Rebate Agreement Type used.
label – Description to guide users when they select the Rebate Agreement Type while creating a new Rebate Agreement.
headerFormulaName – Name of the logic used for building inputs and calculating results for the Rebate Agreement header. It can also manipulate the items and folders.
workflowFormulaName – Name of the approval workflow logic which will build the approval steps for the Rebate Agreement document.
recordWorkflowFormulaName – The name of the approval workflow logic that will generate the approval steps for either a single Rebate Record or a Rebate Record Group. The specific target (individual record or record group) is determined by the setting in the field recordWorkflowFormulaTarget.
recordWorkflowFormulaTarget - This setting decides whether the approval workflow for rebate records within a Rebate Agreement will be created for individual Rebate Records or for Rebate Records Groups. The possible values are either REBATERECORD or REBATERECORDGROUP.
rebateTypeFilterFormulaName – Name of logic which will be used to filter the available Rebate Types when the user is adding a new item to the agreement.
attribute1..30 – These fields are typically used as parameters for the Rebate Agreement logics. For example, if two types of Rebate Agreements 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 Rebate Agreement Type attributes to understand which specific calculations it should do for the current document.