Creating a New Rule Set

The contents of this article pertain to the current version of Author Studio released in the fall of 2023. If you have not updated to the newest version of the product, see our Archived Author Studio Documentation here.

 In the Rule Sets workspace, there is a New Rule Set button. When you click on this button, you are presented with two options:

• Entity Rule Set
• Independent Rule Set

Independent Rule Sets are not available to be authored in Author Studio, but you can create them in irAuthor.

Entity Rule Set

1. To add an Entity Rule Set, navigate to the Rule Sets page.
2. Click on New Rule Set in the upper right corner of the workspace on the Rule Sets page and select Entity Rule Set from the drop-down. 
   
   
   
3. A prompt will ask you to select the context of the rule set.
   
   
   
4. A new rule set is created and you will have the ability to modify the rule set by clicking on it.

Rule Set Properties

1. Name

The title of the rule set is saved here.

2. Description

The description of the rule set is saved here.

3. Fire Mode Settings

Rule sets are functionally significant because they establish when and how the underlying rules are executed. The Fire Mode allows you to select when the rule set will fire.

Decision Rule Sets always use explicit fire mode. Therefore, the Decision Rule Set properties panel will not show the fire mode settings.

Auto Sequential

Auto Sequential specifies that the rule set and its associated rules are always "on.” Unlike Auto Optimized rule sets, Auto Sequential rule sets execute in the order they appear in the list. These rule sets will fire any time a dependency for a top-level rule condition changes as the result of running a subsequent rule set.

Auto Optimized

The engine will automatically recalculate a condition within the rule set any time any of its dependent values change. These rule sets do not fire in the order they are authored—the engine decides the sequence based on a proprietary optimization algorithm. These rule sets will continue to fire until all of its conditions are satisfied. Only a limited set of actions are available in an optimized rule set.

Auto Single Pass

Auto Single Pass rule sets execute in the order they appear in the list, and execute only once, even if a dependency for a top-level rule condition changes during execution of a subsequent rule set.

Explicit

An Explicit Rule Set will be executed only when explicitly instructed to do so by an action or calling application. An Explicit Rule Set is appropriate for procedural operations and will not get re-fired automatically by the engine.

4. Enabled
If this toggle is set to on, it means you want the rule set to run during execution. If it is set to off,  it will not run during execution.

Add Parameters

You can add parameters to Rule Sets with the fire mode set to Explicit.

To add a Parameter 

1. Navigate to the Rule Set
2. Make sure the Rule Set is set to Explicit 
   
   
   
3. Click on the New Parameter button
   
4. In the parameters table, you can specify the parameter's name, data type, enable or disable Auto Create, and add a description. 
   
   
   1. Name 
   Add a Parameter name here.
   
   2. Data Type 
   Specifies the data type of the field. The available options are:
   
   
   3. Auto Create
   This toggle is used to enable or disable Auto Create. If Auto Create is enabled, an instance of the specified entity type is created automatically when the rule set is executed.
   4. Description
   Add a description of the Parameter here. 

Next, learn how to use Language Rules, and Decision Tables.