AccountFieldName | Account Field Name | Text | | The technical name of the customer field to credit when Member Type is Customer, for example AccountId. |
AccountGroupId | Account Group | Lookup → AccountGroup | | Intended customer-group scope. Not read by the accrual. |
BranchFieldName | Branch Field Name | Text | | The technical name of the branch field to credit when Member Type is Branch, for example BranchId. |
CreatedById | Created By | Lookup → UserAccount | Yes | |
CreatedDateTime | Created Date | DateAndTime | Yes | |
DateFieldName | Date Field Name | Text | Yes | The technical name of the date that places each record in an incentive period, for example DocumentDate. Required; a record without a date counts nowhere. |
FirstNRecords | Include First N Records | Number | | Intended sampling limit. Not read by the accrual. |
Id | Id | Guid | Yes | |
IncludeChildResources | Include Child Resources | Boolean | Yes | Intended roll-up of subordinates' figures to their manager. Not read by the accrual. |
IncludeLastNRecords | Include Last N Records | Number | | Intended sampling limit. Not read by the accrual. |
IsActive | Is Active | Boolean | Yes | Whether the configuration accrues. Only active configurations with a Trigger Object Name accrue KPI Data; turning it off stops accrual and keeps existing KPI Data, which linked targets still score from. |
IsGroup | Is Group | Boolean | Yes | Marks a grouping configuration. Not read by the accrual or by scoring. |
ItemFieldName | Item Field Name | Text | | The field naming the record's item. Stored only; the accrual does not read it. |
ItemGroupId | Item Group | Lookup → ItemGroup | | Intended item-group scope. Not read by the accrual. |
JobQueueId | Job Queue | Lookup → InterfaceQueue | | A job tracking link. Not read when KPI Data is accrued. |
KPIConfigurationId | KPI Configuration | Lookup → KPIConfiguration | | A parent configuration, for grouping. Not read by the accrual or by scoring. |
KPIName | KPI Name | Text | | The display name plan authors see when they pick the configuration on a target. Also used as the label of new KPI Data rows. |
LastExecutedSystemModstamp | Last Executed System Modstamp | DateAndTime | | The progress marker for scheduled accrual: the start time of the last fully successful scheduled run. The next run reads records changed after it. |
MemberType | Member Type | PickList | Yes | Who gets the credit: Resource, Partner, Branch or Customer (Account is accepted as Customer). Decides which member field is read. Must match the incentive plan's Member Type, because scoring finds the member's KPI Data row by the plan's type. Values: Branch, Resource, Customer. |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Name | Text | Yes | The record name. Filled from the KPIC document numbering series only when that numbering setting is switched on (it is off in the standard setup); otherwise it must be supplied, and the standard create form has no Name box. |
OwnerId | Owner | Lookup → UserAccount | Yes | |
PartnerAccountGroupId | Account Group | Lookup → AccountGroup | | Intended company-group scope. Not read by the accrual. |
PartnerFieldName | Partner Account Field Name | Text | | The technical name of the company field to credit when Member Type is Partner, for example PartnerAccountId. |
RecordTypeId | Record Type | Guid, hidden | | |
ResourceFieldName | Resource Field Name | Text | | The technical name of the person field to credit when Member Type is Resource, for example SalesExecutiveResourceId on Invoice. May follow a lookup, such as InvoiceId.SalesExecutiveResourceId on a line. |
ResultRewardFieldName | Formula Reward Field Name | Text | | The KPI Data field read as the reward when Reward Function is Formula. |
ResultValueFieldName | Formula Value Field Name | Text | | The KPI Data field read as the achieved value when Value Function is Formula. The accrual fills only KPI Value Sum, KPI Value Count and Reward Value Sum. |
RewardFieldName | Reward Field Name | Text | | The technical name of a numeric field carrying a reward on each record. Summed into the KPI Data row's Reward Value Sum, which slabs of type KPI Reward Value or KPI Reward Value Percentage pay from. |
RewardFunction | Reward Function | PickList | | How the reward figure is worked out from the KPI Data row, with the same choices as Value Function; empty or Sum = Reward Value Sum. A Custom Reward Value typed on the row above 0 wins. Values: Sum. |
RuleSuccessCriteria | Rule Success Criteria | PickList | | How the configuration's KPI rules combine: empty or Always (No Criteria) ignores the rules and counts every record; All Rules Are Met, Any Rule Is Met or Custom Logic Is Met apply them. A rule that cannot be read makes the whole configuration skip, with the reason in the job summary. Values: Always (No Criteria). |
RuleSuccessCustomLogic | Rule Success Custom Logic | Text | | The rule combination for Custom Logic Is Met, such as {0} AND ({1} OR {2}), where {0} is the first rule by Sequence Number. Only {N}, AND, OR, NOT and parentheses are allowed. |
TriggerEvent | Trigger Event | PickList | | Which saves of the object accrue: AFTER_INSERT (new records), AFTER_UPDATE (changes), AFTER_UPSERT or AFTER_ALL (both), Scheduled (only from a scheduled Accrue KPI configuration data job). An empty value or AFTER_DELETE accrues nothing on save. Deleted records give their contribution back whatever this is set to, while an active configuration measures the object. Values: Scheduled, AFTER_INSERT, AFTER_UPDATE, AFTER_DELETE. |
TriggerObjectName | Trigger Object Name | Text | | The technical name of the entity whose records are measured, for example Invoice or ServiceOrder. Typed, not picked. Leave it empty for a configuration that only groups targets. |
UIProps | UI Props | Text | | |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
ValueFieldName | Value Field Name | Text | | The technical name of the numeric field whose values are measured, on the object or through a lookup (InvoiceId.TotalLineAmount). For the Count Distinct function it is the key whose distinct values are counted, such as AccountId. On the standard form it is the second box labelled Value Field Name. |
ValueFieldName2 | Value Field Name | Text | | A second numeric value read from each record and stored on its KPI Data detail. It is not rolled up or used for scoring. On the standard form it is the first box labelled Value Field Name. |
ValueFunction | Value Function | PickList | | How a member's figure is worked out from the KPI Data row: empty or Sum = KPI Value Sum, Count = number of records, Average = sum divided by count, Formula = the KPI Data field named in Formula Value Field Name, Count Distinct = number of distinct Value Field Name values. A Custom KPI Value typed on the row above 0 wins. Values: Count, Average, Formula. |
