Rule Engine
Introduction
The Rule Engine is a core feature of the FX CPQ module.
The Rule Engine builds quotes and tickets automatically by enforcing rules based on contracts agreed with customers.
The Rule Engine maximizes revenue, ensures contract compliance, and reduces the administrative burden on field personnel.
Prerequisites
To setup and use the rule engine, you need to:
Have these user licenses | Have these permissions | Complete these tasks and review these topics before continuing |
---|---|---|
Rules
-
The Rule Engine features a series of rules.
-
There are two types of rule:
-
Rules run when you add or update a record.
Rules don’t run if a record is read-only.
Rules don’t run in FieldFX Back Office if a record’s status has Sync selected.
-
Rules have criteria that triggers rule actions if a record meets the criteria.
Rule Actions
Basics
Rule actions can do the following:
-
Add required items
-
Add recommended items
-
Remove disallowed items
Permissions determine whether an item only exists once on a Quote or Ticket or each rule that requires the item adds an additional copy of the item. |
Required Items
-
A rule action adds a required item if you add or update a record to meet rule criteria.
-
A rule action removes a required item if you update a record to no longer meet rule criteria.
-
You can’t remove a required item if a record meets the criteria for the rule that added the item.
Recommended Items
-
A rule action adds a recommended item if you add a record to meet rule criteria.
-
A rule action doesn’t add a recommended item if you update a record to meet rule criteria.
-
You can remove a recommended item at any time.
Disallowed Items
-
A rule action removes a disallowed item if you add or update a record to meet rule criteria.
-
You can’t add a disallowed item if a record meets the criteria for the rule that disallowed the item.
-
A rule action stops disallowing an item if you update a record to no longer meet rule criteria.
Parent and Child Items
-
A rule action doesn’t add a child item if its parent item isn’t already on the record.
How the Rule Engine Works
When a Rule Triggers
-
The Rule or Rule Action must be
Active
. -
Using the Rule Processor, the Rule’s
IsCriteriaDirty
field must befalse
. -
The object record’s
Sync__c
field must be false for Quotes or Tickets. -
The user must have an FX CPQ license assigned and have the required FX CPQ minimum permissions.
-
The rule’s criteria must be valid.
FieldFX Back Office
Here are flow diagrams that show how the Rule Engine works in FieldFX Back Office:
For a Quote | For a Ticket | For a Job |
---|---|---|
FieldFX Mobile
Here are graphics that shows how the Rule Engine works in FieldFX Mobile:
For a Quote | For a Ticket | For a Job |
---|---|---|
Recommended Reading
-
Rule Engine Setup - Learn how to set up the Rule Engine.
-
FX CPQ Minimum Permissions - Learn the minimum permissions required to use the Rule Engine.