Setting Up Rule Set

Overview

Rule Set is a set of Rules and Flows in Decisions that are targeted to work together in a process of complex data evaluation. Rule Sets give the best flexibility in data validation.

Example

This example will demonstrate how to create a Rule Set and use a simple Rule Set to evaluate if a person is over 21 and is in the state of VA. Below is a downloadable example to import into Decisions. 

1. In a Designer Project, click CREATE DATATYPES/INTEGRATIONS. Select Flow Structure and click CREATE.
   
2. In the Flow Structure definition window, provide a Structure Type Name and add four Data Members: FirstName, LastName, State, and Age. When finished, click SAVE to save and continue.
   
   
3. In the Designer Project click CREATE RULE and select Rule Set. Then, click CREATE. Name the Rule Set and click CREATE.
   >
4. The system creates a Rule/Flow Set Base Folder. On the Rule/Flow Set View of this Folder see Rule/Flow Set Settings on the left-hand side and Rules and Flows in Set on the right-hand side of the Page. To edit the Rule Set Settings select Setup on Folder Actions Panel.
   

   
   

   The Setup Rule Set dialog window has multiple sections for configuring the Rule Set. Below are the sections and the options available

   Setup Section

   Usage Option	Description
   Logical	Apply the logical check to data. Best used for validations and data check
   Data Return	Used for data manipulations
   Scoring	Used for statistical purposes when need to do manipulations on the rule results count

   
   

   Run Mode Option	Description
   Run All	Run all Rules/Flows in the Set
   Stop On First True	Terminates Set execution on first Rule evaluating as True
   Stop On First False	Terminates Set execution on first Rule evaluating as Fase

   
   

   
   

   Rule Set Type Option	Description
   Template w/ Instances	Used to create a base set of Rules and then create specific sub-sets of Rules
   Instance	Used to create just a Set of Rules without specific sub-sets.
   Conditional	Rule Set Type that allows users to create Rule Sets within this Rule Set. In the Conditional Rule Set, we can use Flows to Extend Data Inputs for Flows/Rules based on the designed conditions or create Run Set Rule controls to determine if we need to run the Set based on designed conditions.

   Rule Types Section

   Rule Type Option	Description
   Flows – Evaluation	Build a custom Flow that evaluates data and outputs ResultData
   Flows – Evaluation/Data Addition	Build a custom Flow that evaluates data and outputs ResultData and Rule Set Input Data.
   Flows – Transform Data	Build a custom Flow for editing Rule Set Input Data
   Action Rules	Use Rules that trigger different Flows based on the designed conditions
   Truth Tables	Use Truth Tables for more complex data validations
   Interceptor Rules	Allow Interceptor Rules: to build Rules that intercept and stop invalid data from being processed. Intercepted Flow: to build handlers for intercepted data.

   Outcome Options Section

   Outcome Options	Description
   Show All Truth Path	Creating an outcome path that the Flow takes if all Rules in the Set evaluated True
   Show All False Path	Creating an outcome path that the Flow takes if all Rules in the Set evaluated False
   Path For No Rule Result	Default outcome Path that is used when Rule Set execution is completed
   Defined Outcome Paths	Custom outcome Paths that may be used to continue Flow Execution on the desirable Flow Branch based on the Rule Set Result
   Done Path Name	Customize the default ‘Done’ outcome name
   Lists	Outputs the following Lists: Error, False, No Result, Not Run, True

   
   

   Data Storage Section

   Data Storage options: None, Header, HeaderWithAllTrue, HeaderWillAllFalse, All

   If using Interceptor Rules, all intercepted data will be stored even if no Data Storage options are set 

   
   

   In the API section set Allow REST API Calls or Create Web Service for this Rule Set.

5. Select  Add New to add new Rule Set Input Data.
   
   
6. In the Add Inputs definition dialog, name the Input Data and pick the Flow Structure Type that was created previously in this tutorial. Click OK to save and continue.
   
7. Click SAVE to close the Setup Rule Set window.
8. Click Add Evaluation Rule on the Folder Actions panel. Name the Rule and click CREATE RULE to proceed to the Rule Designer.
   
9. Click Select Data Element. Click ApplicationData and select Age. Click NEXT.
   
10.  Select Greater Than and click NEXT on the Verb definition dialog.
    
11. Enter "21" in the value2 field and click DONE.
    
12. Click Save to save changes to the Rule.
13. Add another Evaluation Rule that evaluates as ApplicationData.State is VA.
    

    
    

    If using multiple Rules, the order in which they will execute can be configured individually. On the Properties panel of the Rule under the SETTINGS category, enter a numerical value in the Order field under Rule Set.

    
14. Navigate to the Designer Project and click CREATE FLOW. Select Default and click CREATE. Name the Flow and click CREATE.
    
15. Click the Done path on the Start step. Select Create Data and click ADD.
    
16. With the step selected, click Show Editor. Enter "Application" under the Name field and change the Type to Application.
    
17. Click Edit under Input. Click the ellipses icon under Value and enter values for the data member input fields. Click OK and close the Data Definitions dialog window to save.
18. Click the Done path on the Create Data step and add a Run Rule Set step by navigating to Flows, Rules, Forms, and Reports > Rules.
    
19. Under Rule Set Configuration, click Pick and choose the Rule Set.
    
20. Select Unknown next to the Application Data field under Inputs and click Select From Flow. Select Application and click DONE.
    
21.  Connect the outcome path to the End step. Click Save to save changes.
    

Debug

1. Select Debug on the top panel of the Flow Designer to test the results of the Rule Set.
2. After the debugger runs, select the Run Rule step, click Execution 1, and choose View Input/Output Data.
   The first Rule evaluates true because the age was older than 21. The second Rule evaluated as false because the state was not VA.