Creating a Rule Set

Overview

Rule Sets are a set of Rules and Flows that are targeted to work together for complex data evaluation. They can produce more nuanced results than are possible with other kinds of Rules alone. For instance, a Rule Set could be made of a series of Evaluation Rules and then a Matrix Rule.

Conditional Rules provide the ability to create Rule Sets within a Rule Set. A Conditional Rule Set may evaluate conditions to determine if this Rule Set needs to be executed and may extend Rule Set input data. Data that meets certain conditions can be sent to be reviewed by different groups of Rules. 

Rules that make up a Rule Set need to be created manually within the Rule Set. It is not possible to add existing Rules or use Templates

Rule Set Configuration

1. In the desired Designer Folder, click CREATE RULE on the Global Action Bar. Select Rule Set. In the Element Gallery, expand the Rule Set section and then select, name, and create a Rule Set.
2. On the next screen is a list of various setting. Below is an overview of each property. Once complete, click SAVE.
   

Setup

Type

Allowed Rule Types

Rule Sets only allow Evaluation Rules (similar to a Statement Rule) by default. Additional types of Rules have to be enabled before they can be added to the Rule Set.

Advanced

Data Storage

Lists

Rule Set Data

Service Settings

Creating a Rule Set

In this example, a Rule Set will be created and house a Conditional Rule Set. Then a Flow will test the Conditional Rule Set. Below is a downloadable example that can be imported into Decisions.

1. Input Data for the Rule Set will need to be defined. Select Setup Rule Set.
2. Under RULE SET DATA > Inputs, click ADD.
3. Define the Input Data. Location (String) and Amount (Double) are configured as inputs in this case.
   
4. Under the SETUP, select Conditional for Type and Scoring for Return. Then, click SAVE to save changes and close the dialog window.
5. Click Create Rule Set [Conditional] on the Rule Set action panel. When the dialog box appears, provide a name for the Rule Set and click CREATE.
6. New Rules can be defined using the Add Evaluation Rule. To edit existing rules, click on the Pencil Icon.
7. The Rule Designer will then open, where the Rule can be updated/defined.
   

Running a Rule Set in a Flow

1. Create a new Flow.
2. In the Toolbox, select and drag a Run Rule Set from the Designer Entities > Rules category onto the workspace.
3. Click PICK under the RULE SET CONFIGURATION category on the Properties panel and select the created Rule Set.
   
4. Define the inputs needed for the Rule Set.
   
5. Since the Rule Set is a Conditional Rule Set, the Inclusion Rule Control input is available.
   This input sets the same execution Run Mode for all Evaluation and Intercept Rules, without the need to manually set the values. Below is an overview of the options available.

Debug

1. Click Debug on the top action bar. When the Debugger window opens, click START DEBUGGING. 
2. After the Flow runs, the debugger will display the Rule Set that was running, along with the results for each individual Rule, depending on the Run mode configuration.

Adding Additional Rules

On the Rule Set Designer Folder, click Add on the right side of the screen, then click CREATE.

Setting Execution Order

If multiple Rules exist within a Rule Set, the order in which they will execute can be configured. Within a Rule Set, click Setup, then check Sort by Order before Run.

To set the execution order: 

Edit the Rule. In the Properties panel of the Rule, check the SETTINGS category. Enter a numerical value in the Order field under the Rule Set sub-category.

When the Rule is run through the debugger as part of a Flow, the Rules will execute in their configured order.

---

Enabling/Disabling Rules in Rule Set

On the Properties panel of a Rule in a Rule Set under SETTINGS, users can enable, disable, or partially enable the Rules. The status of the Rule is displayed next to Configure Integration. Unselecting Enabled will disable the Rule, and selecting Use Enable Rules will partially disable the Rule.

Rule Sets and Upgrading

For Rule Sets created in v8.16 or below, if using either (or both) a user defined type or a data return, the Rule Set will have issues when being imported into a version below v9.4. Starting in v9.4 a setting called "Use Unique Namespace for Output Type" will appear under the Return section in the Setup Rule Set dialog menu. This setting by default is set to true. The setting can be set to False for users with a prior ruleset in a Flow that was using the old name space. This will allow it compile and the Flow using the Rule Set to work properly.

The "Use Unique Namespace for Output Type" setting will not appear for Rule Sets that were created in v8.17 or above, or any v9.