AgileApps Support Wiki

Difference between revisions of "Rule Sets"

From AgileApps Support Wiki
imported>Aeric
(Created page with "After the Rule Set is created, you can add Rules to it. The Rule Set can then be invoked as an action from another Rule, allowing a single Rule Set to be used in multiple context...")
 
imported>Aeric
 
(44 intermediate revisions by the same user not shown)
Line 1: Line 1:
After the Rule Set is created, you can add Rules to it. The Rule Set can then be invoked as an action from another Rule, allowing a single Rule Set to be used in multiple contexts.
<noinclude>'''[[File:GearIcon.png]] > Case Automation > Business Rules > Rule Sets'''<br>
'''[[File:GearIcon.png]] > Objects > {object} > Business Rules > Rule Sets'''
</noinclude>
After a Rule Set is created, you can add Rules to it. The Rule Set can then be invoked as a step in a [[Process]], or as an action from another Rule, allowing a set of rules to be created once, and used in multiple contexts.


:''Learn more:'' [[Rules and Rule Sets]]
:''Learn more:'' [[Rules and Rule Sets]]


===Creating or Modifying a Rule Set===
===Creating or Modifying a Rule Set===
# Go to '''Designer > Case Types > {case type} > Rule Sets'''
# Go to '''[[File:GearIcon.png]] > Case Automation > Business Rules > Rule Sets'''<br>or '''[[File:GearIcon.png]] > Objects > {object} > Business Rules > Rule Sets'''
# Click '''[New Rule Set]''', or visit an existing one
# Click '''[New Rule Set]''', or visit an existing one
# Fill in the Rule Set properties, below
# Fill in the Rule Set properties, below
# Click '''[Save]'''
# Click '''[Save]'''


<span id="Process Decision Value"></span><span id="return_type"></span>
====Rule Set Properties====
====Rule Set Properties====
:* '''Title -''' The title you'll see when referencing the Rule Set in the {{HD}} interface. 
:* '''Name -''' The name of the Rule Set--used to reference when invoked from other Rules or from a [[Process]].  
:* '''Name -''' The name used by programmers. A default version of the name is created from the title, but it can be edited, if desired.  
:* '''Enabled -''' Whether or not the Rule Set is currently in force. (Disable a Rule Set to temporarily deactivate it, without deleting it.)
:* '''Enabled -''' Whether or not the Rule Set is currently in force. (Disable a Rule Set to temporarily deactivate it, without deleting it.)
:* '''Use for Inbound Emails -''' The rules will operate on incoming email messages. (Email fields like <tt>To</tt> and <tt>Subject</tt> will be available for processing.)
 
::: ''Learn more:'' [[Email to Case]]
:* '''Return Type'''
:* '''Return Type -''' If the Rule Set will return a value, specify the type of value -- Boolean (true/false), Number, String, Date, a User/Role, or None.  
::* '''None'''
::: The default type.  
::: All Rules in the rule set are evaluated, and all actions dictated by those rules are executed.
 
::* '''Process Decision Value'''
::: A rule set with this return type creates a process value that can be tested in a [[Process Model#Decision Switch]]
::: When a Rule Set has this return type, rules added to it have another possible action: '''Return Process Decision Value'''
::: The returned value is stored in a process variable named ''Rule Value''.
::: The rule to return a value halts the rule engine. The value is returned, and no other rules are evaluated.
 
::* '''Process Step Owner'''
::: Return a User, or Role identifier.
::: A Rule Set with this return type can be used to specify the owner of a [[Process Task|user task or approval step]] in a Process.
::: When a Rule Set has this return type, rules added to it have another possible action: '''Return Step Owner'''
::: When you select that action, you can either specify a Role or select one of the fields in the record that designates a [[User]].
::: The rule to return a value halts the rule engine. The value is returned, and no other rules are evaluated.
 
:* '''Description -''' Write a descriptive summary here.
:* '''Description -''' Write a descriptive summary here.


====Rule Set Example====
{{Best|When a Rule Set returns a value, don't use it to do anything else. Otherwise, rule sequencing becomes an issue.}}
Here's a sample Rule Set that is intended to determine the owner for a case:
:[[File:RuleSetExample.png]]
<noinclude>
 
[[Category:{{HD}}]]
</noinclude>

Latest revision as of 08:21, 1 June 2020

GearIcon.png > Case Automation > Business Rules > Rule Sets
GearIcon.png > Objects > {object} > Business Rules > Rule Sets

After a Rule Set is created, you can add Rules to it. The Rule Set can then be invoked as a step in a Process, or as an action from another Rule, allowing a set of rules to be created once, and used in multiple contexts.

Learn more: Rules and Rule Sets

Creating or Modifying a Rule Set

  1. Go to GearIcon.png > Case Automation > Business Rules > Rule Sets
    or GearIcon.png > Objects > {object} > Business Rules > Rule Sets
  2. Click [New Rule Set], or visit an existing one
  3. Fill in the Rule Set properties, below
  4. Click [Save]

Rule Set Properties

  • Name - The name of the Rule Set--used to reference when invoked from other Rules or from a Process.
  • Enabled - Whether or not the Rule Set is currently in force. (Disable a Rule Set to temporarily deactivate it, without deleting it.)
  • Return Type
  • None
The default type.
All Rules in the rule set are evaluated, and all actions dictated by those rules are executed.
  • Process Decision Value
A rule set with this return type creates a process value that can be tested in a Process Model#Decision Switch
When a Rule Set has this return type, rules added to it have another possible action: Return Process Decision Value
The returned value is stored in a process variable named Rule Value.
The rule to return a value halts the rule engine. The value is returned, and no other rules are evaluated.
  • Process Step Owner
Return a User, or Role identifier.
A Rule Set with this return type can be used to specify the owner of a user task or approval step in a Process.
When a Rule Set has this return type, rules added to it have another possible action: Return Step Owner
When you select that action, you can either specify a Role or select one of the fields in the record that designates a User.
The rule to return a value halts the rule engine. The value is returned, and no other rules are evaluated.
  • Description - Write a descriptive summary here.

Thumbsup.gif

Best Practice:
When a Rule Set returns a value, don't use it to do anything else. Otherwise, rule sequencing becomes an issue.

Retrieved from "https://agileappscloud.info/aawiki-src/index.php?title=Rule_Sets&oldid=19262"