A KPI definition - the catalog row that names a measurable performance indicator (kpiName, label) and declares where its numbers come from: triggerObjectName/triggerEvent point at the source entity and event, and the *FieldName pointers (accountFieldName, branchFieldName, dateFieldName, itemFieldName, partnerFieldName, resourceFieldName, valueFieldName/valueFieldName2 with valueFunction, rewardFieldName with rewardFunction) map source-entity fields into the KPI dimensions and measures. Child KPIRules rows add filter conditions on the source records. Definitions can be grouped hierarchically: kPIConfigurationId points at a parent configuration and isGroup marks group nodes. Scoping lookups restrict applicability (accountGroupId, partnerAccountGroupId, itemGroupId). This is the KPI that Rewards configuration points at: IncentiveTarget, IncentiveResourceTarget, CompensationLine and CompensationSlab rows all carry a kpiConfigurationId identifying which KPI their target or slab measures. Aggregated results land in KPIData rows (kpiConfigurationId links back); lastExecutedSystemModstamp records the high-water mark of the last calculation pass.
Fields
| Field | Label | Type | Required | What it does |
|---|
AccountFieldName | Account Field Name | Text | | |
AccountGroupId | Account Group | Lookup → AccountGroup | | |
BranchFieldName | Branch Field Name | Text | | |
CreatedById | Created By | Lookup → UserAccount | Yes | |
CreatedDateTime | Created Date | DateAndTime | Yes | |
DateFieldName | Date Field Name | Text | Yes | |
FirstNRecords | Include First N Records | Number | | |
Id | Id | Guid | Yes | |
IncludeChildResources | Include Child Resources | Boolean | Yes | |
IncludeLastNRecords | Include Last N Records | Number | | |
IsActive | Is Active | Boolean | Yes | |
IsGroup | Is Group | Boolean | Yes | |
ItemFieldName | Item Field Name | Text | | |
ItemGroupId | Item Group | Lookup → ItemGroup | | |
JobQueueId | Job Queue | Lookup → InterfaceQueue | | |
KPIConfigurationId | KPI Configuration | Lookup → KPIConfiguration | | Self-referencing parent lookup: points at a parent KPIConfiguration, building a group hierarchy of KPI definitions (isGroup marks the group nodes). Not to be confused with the field of the same name on KPIData/KPIRules, where it links a result or rule to its definition. |
KPIName | KPI Name | Text | | |
LastExecutedSystemModstamp | Last Executed System Modstamp | DateAndTime | | |
MemberType | Member Type | PickList | Yes | Values: Branch, Resource, Customer. |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Name | Text | Yes | |
OwnerId | Owner | Lookup → UserAccount | Yes | |
PartnerAccountGroupId | Account Group | Lookup → AccountGroup | | |
PartnerFieldName | Partner Account Field Name | Text | | |
RecordTypeId | Record Type | Guid, hidden | | |
ResourceFieldName | Resource Field Name | Text | | |
ResultRewardFieldName | Formula Reward Field Name | Text | | |
ResultValueFieldName | Formula Value Field Name | Text | | |
RewardFieldName | Reward Field Name | Text | | |
RewardFunction | Reward Function | PickList | | Values: Sum. |
RuleSuccessCriteria | Rule Success Criteria | PickList | | Values: Always (No Criteria). |
RuleSuccessCustomLogic | Rule Success Custom Logic | Text | | |
TriggerEvent | Trigger Event | PickList | | Values: Scheduled, AFTER_INSERT, AFTER_UPDATE, AFTER_DELETE. |
TriggerObjectName | Trigger Object Name | Text | | |
UIProps | UI Props | Text | | |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
ValueFieldName | Value Field Name | Text | | |
ValueFieldName2 | Value Field Name | Text | | |
ValueFunction | Value Function | PickList | | Values: Count, Average, Formula. |
Actions
| Action | Label | Type | What it does |
|---|
BulkDelete | Delete | Delete | Delete |
Clone | Clone | ServerAction (Clone) | Create a copy of this record |
Delete | Delete | Delete | Delete |
DeleteInList | Delete | Delete | Delete |
Edit | Edit | Edit | Edit |
EditInLine | Edit | Edit | Edit |
New | New | New | New |
