xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField Sales & SFACRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
Auto DMSConsumer Goods DMSSales Force Automation (SFA) FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/KPI Data — entity reference
REFERENCE · Last reviewed

KPI Data — entity reference

The computed result of a KPI configuration for one incentive plan, period and member. The KPI configuration accrual creates one row per configuration, approved plan, open period and member, and writes one KPI Data Detail line per contributing source record. After every change to its lines it recalculates KPI Value Sum (total of the lines' KPI Value), KPI Value Count (number of lines) and Reward Value Sum (total of the lines' Reward Value). Process Compensation scores each incentive target linked to the configuration from the member's row: a Custom KPI Value or Custom Reward Value above 0 wins, otherwise the configuration's Value Function or Reward Function picks the figure. Rows are never deleted by the accrual; a rebuild zeroes the totals of open periods and keeps the row. Rows in Approved or Posted periods are never changed. Rows are reached from the KPI Data list on a KPI configuration's page and from an incentive period's Details tab; the record page has no header buttons but fields edit in place. Targets without a KPI configuration are scored from Performance KPI rows instead.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → AccountThe member when the configuration's Member Type is Customer (or Account). Empty for other member types.
BranchIdBranchLookup → BranchThe member when the configuration's Member Type is Branch. Filled in by the accrual but not shown on the standard KPI Data page.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DocumentDateDocument DateDateThe latest date of any source record that has contributed to the row. It does not go back when that record leaves the row, and scoring does not read it. Not on the standard page.
EmployeeIDEmployeeCalculatedNever filled in by the accrual or by scoring.
IdIdGuidYes
IncentivePeriodIdIncentive PeriodLookup → IncentivePeriodThe incentive period the row covers. Source records are placed in the period whose start and end dates contain their date (the configuration's Date Field Name).
IncentivePlanIdIncentive PlanLookupThe approved incentive plan the row counts for. A source record that counts for several plans contributes to a row in each plan.
IncentiveResourceIdIncentive ResourceLookup → IncentiveResourceNot stored: shown in the field list but never saved.
IncentiveResourceTargetIdIncentive Resource TargetLookup → IncentiveResourceTargetNever filled in by the accrual. Rows are keyed by configuration, plan, period and member, not by target or quota.
KPIConfigurationIdKPI ConfigurationLookup → KPIConfigurationThe KPI configuration (measure) this row belongs to. The KPI Data list on a configuration's page is not filtered to that configuration, so check this field.
KPIValueCustom KPI ValueNumberAn override for the scored value, whole numbers only, default 0. When above 0, Process Compensation uses it instead of the configuration's Value Function. For a Count Distinct configuration the accrual writes the number of distinct keys here, overwriting any typed value whenever it updates the row.
KPIValueCountKPI Value CountCalculatedThe number of detail lines on this row, recalculated by the accrual whenever a line changes. Read by the Count and Average value functions.
KPIValueSumKPI Value SumCalculated (calculated)The total of the KPI Value of this row's detail lines, recalculated by the accrual whenever a line changes. Read by the Sum (or empty) and Average value functions.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYesWritten by the accrual as the KPI configuration's name, a dot, then an internal code for the incentive period. Use Incentive Period to see which period the row covers.
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → AccountThe member when the configuration's Member Type is Partner. Filled in by the accrual but not shown on the standard KPI Data page.
RecordTypeIdRecord TypeGuid, hidden
ResourceIdResourceLookup → ResourceThe member when the configuration's Member Type is Resource. Empty for other member types.
RewardValueCustom Reward ValueNumberAn override for the scored reward, whole numbers only, default 0. When above 0, Process Compensation uses it instead of the configuration's Reward Function for slabs that pay KPI Reward Value.
RewardValueSumReward Value SumCalculated (calculated)The total of the Reward Value of this row's detail lines, recalculated by the accrual whenever a line changes. Read by the Sum (or empty) reward function.
RNAKpiValueRNAKpiValueCalculated (calculated)Not used: nothing fills it and scoring does not read it.
TargetValueTarget ValueDecimalNot stored: shown in the field list but never saved. Target values come from the plan's targets and member quotas.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete
EditEditEditEdit
Edit1EditEditInlineEdit
EditInLineEditEditEdit
NewNewNewNew