About Rules
  • 24 Jun 2022
  • 4 Minutes to read
  • Dark
    Light
  This documentation version is deprecated, please click here for the latest version.

About Rules

  • Dark
    Light

Article summary

Overview

A Rule evaluates input data to determine whether the data matches certain conditions. The Rule returns an outcome, choosing a path or returning data to a Flow, Form, or a Report. Set the outcome of a Rule to do any number of things:

  • Decide which user is responsible for an assignment
  • Direct which path a Flow follows
  • Determine which controls are visible on a Form
  • Decide how specific values in a Report are formatted
It is recommended to not alter the default Rules as they are used throughout Decisions. If they are edited it could lead to many things breaking.

Create

Rules are built in the Rule Designer. To open the Rule Designer, navigate to a Designer Folder, click CREATE RULE and select Create Rule.

Create-Rule.jpg


Types of Rules



When To Use Each Type of Rule

Statement Rule

This type of Rule, by default, is a true/false if statement rule. It allows a user to configure a process based on whether the Rule evaluates to true or false. Statement rules could have multiple if statements within them called nested if statements. The Statement Rule can also output data depending on the true or false evaluation by clicking on the 'Add' on the outcome scenarios. A typical use case of a statement rule would be for evaluating scenarios on two possible outcomes. To learn more, see Creating a Rule.

Truth Table

Truth Tables are rules that compare the possible combinations of multiple inputs for a single set of data. This allows the user to arrive at different outcomes depending on the specific combination. A truth table can output a piece or pieces of data, or take action by calling a flow. This Rule is represented as a table where conditions can be added at the top (Predicate and Verb), and nouns are defined as rows of the Truth Table along with expected Results (Outcome Data). Truth Tables can be configured to return more than one outcome. This is helpful when there is a single set of data that a developer may want to be analyzed in more than one way. To learn more, see About Truth Tables.

Rule Chains

Rule chains are a set of rules combined in sequence, where every Rule produces a fact that is both an output of the rule chain and can be consumed in Rules farther down the chain. Rule chains are useful because it allows the user to connect a series of rules that could be made up of any one of the Decisions Rule types, and define it as one Rule. To learn more, see Rule Chains.

Matrix Rule

A Matrix Rule is a rule that can be made up of many different rows and columns.  A Matrix Rule is used to evaluate data with customizable settings to each specific row or column. Each row and column can have particular parameters, and these rule evaluations can be nested within each row or column. When a Matrix Rule runs, it has an outcome result, each outcome from a horizontal column creates a column for the Matrix, and each outcome from the vertical row creates a row for the Matrix. For more information, see About Matrix Rules.

Rule Set

Rule Sets are common sets of rules and flows that can be parameterized or customized based on context without the need to copy or rewrite them. A Rule Set allows designers to define a number of Rules or Flows that can work together. These represent the process to follow that will be known as the base set. See Setting Up Rule Set for more information.

Sequential Rule

Sequential Rule is a Flow that represents a sequence of steps that evaluate data. It can be used when the designer wants to embed a complex data evaluation or a sequence of simple rules into a single Rule utilizing a sub-flow. Instead of using the rule editor to make a rule, make a rule using the Flow Designer; the Sequential Rule is another way of creating a Rule, using a Flow as an interface rather than the rule editor. The Sequential Rule can give different options when evaluating data that the rule editor may not have available. For more information, see 

Rule Engine Extension 

A Rule Engine Extension allows users to create a Rule that can be embedded in another Rule. It is required to add anchor Input in the Main Rule to use Rule Engine Extension. This anchor Input should be the same Type of Data that the Extension Rule has as its Rule Input Data. To learn more, see Rule Extensions Using Rule Engine

Interceptor Rules

Interceptor Rules are Rules that catch invalid data in business workflow processes. This helps ensure the Rule is evaluating only valid data. These Rules take place in the process that needs to validate Data using Rule Set Engine. For more information on interceptor Rules, see Interceptor Rules.


Rule Audit and Rule Audit Phrase Table 

By utilizing the Rule Audit and Rule Phrase Audit Database Tables, users may view the history of a Rule that has the Capture Audit History Property enabled. Users may interact with these tables via Database Integration or by using them as a Report Data Source.

The Rule Audit table displays information on the Rule that pertains to the Result of the Rule, including the Rule Name, its Audit Name, the Result Data, its Audit Id, and its Entity Folder Id


The Rule Audit Phrase History table more so deals with the data values used within a Rule such as its Anchor Variables and the Phrase Rule (text) used within the Rule.

Additional Information 
For more information on the Rule Audit and Rule Audit Phrase History tables, see How to Use Rule Audit History.




Was this article helpful?