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 Rule — entity reference
REFERENCE · Last reviewed

KPI Rule — entity reference

One condition that limits which records a KPI configuration counts. The configuration's Rule Success Criteria combines its rules (all, any or custom logic); with no criteria or Always (No Criteria) the rules are ignored. The standard KPI Configuration page has no rules list and KPI Rule has no standard form, so rules are usually loaded by import or added through a list an administrator places on the page.

Fields

FieldLabelTypeRequiredWhat it does
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
FieldNameField NameTextThe technical name of the field to test on the configuration's object, or a lookup path such as InvoiceId.Status or ItemId.Brand_c. Lookup-path rules are checked on each record after the data query, when the record itself is saved.
FieldValueField ValueTextThe value to compare with, typed to the field's data type. An empty value with Equals means the field is empty; with Not Equal, that it has a value.
IdIdGuidYes
KPIConfigurationIdKPI ConfigurationLookup → KPIConfigurationThe KPI configuration the rule belongs to.
KPINameKPI NameTextNot stored.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYes
OperationOperationPickListThe comparison: Equals, Not Equal, Greater Than, Greater Or Equal, Less Than, Less Or Equal, In (comma-separated list) or Contains (text fields only). Text compares ignore case. Values: Not Equal, Greater Than, In.
OwnerIdOwnerLookup → UserAccountYes
RecordTypeIdRecord TypeGuid, hidden
SequenceNumberSequence NumberNumberThe rule's position. Rules are numbered from {0} in sequence order for Rule Success Custom Logic. Defaults to 0.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

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