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

Claim Generation Rule — entity reference

One selection condition of a claim generation setup: a field path, an operation and a value, identified by a sequence number. When the setup runs, all of its rules are turned into one query condition over the setup's source entity. They are combined with AND or OR according to the setup's Rule Success Criteria, or by its Rule Custom Logic formula, which refers to the rules by sequence number; the setup's Filter Expression, when present, is always added with AND. Rules are added from the Rules tab of the setup. Saving a rule does not test it, so a rule change is proved by running the setup in simulate mode.

Fields

FieldLabelTypeRequiredWhat it does
ClaimGenerationSetupIdClaim Generation SetupLookup → ClaimGenerationSetupYesThe setup the rule belongs to. Filled in automatically when the rule is added from the setup's Rules tab.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
FieldNameField NameTextYesThe field on the setup's source entity that the condition tests. It may walk to related records with dots, for example Invoice.Status or ServiceOrder.BranchId. Use the field's internal name, not its label. A rule with an empty Field Name is ignored, and a name that does not exist on the source makes the run fail.
FieldValueField ValueTextThe value to compare with. Leave it empty, or type null, to test for an empty field. true and false, numbers and IDs are compared as those types, so the field must be of the same type; everything else is compared as text. For In and Not In, separate values with commas. Picklist fields hold the value's internal name, which can differ from the label shown on screen.
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberTextYesThe rule's number. On save it is replaced by a number from the Claim Generation Rule Settings series (prefix CGR), so whatever is typed in the create form is not kept.
OperationOperationPickListYesHow the field is compared with the value. Equals, Not Equal, Greater Than and Less Than compare directly; Contains is a text match on part of the value; In and Not In take a comma-separated list. An empty operation is treated as Equals. Values: Equals, Not Equal, Greater Than, Less Than, Contains, In, Not In.
OwnerIdOwnerLookup → UserAccountYes
SequenceNumberSequenceNumberYesOrders the rules and is the number a Rule Custom Logic formula uses to refer to the rule. An empty sequence counts as 0. Give every rule its own number: if two rules share one, a formula uses only one of them, while AND/OR criteria still use both.
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete the record.
EditEditEditEdit the ClaimGenerationSetupRule.
EditInLineEditEditInlineEdit inline.
EditInListEditEditInlineEdit inline in the list.
NewNewNewCreate a new ClaimGenerationSetupRule.
NewInLineQuick AddNewInlineNewInLine