Using the Rule Debugger

Last Updated: 02/06/2016 Introduced in Verision: 2.0

Rules evaluate a data input and return an outcome that is dependent on whether the input satisfies the rule’s conditions. Before using a rule in a production scenario, it can be useful to test it with the Rule Debugger.

To use the Rule Debugger, open the rule you’d like to test in the Rule Designer and click the Debug Rule link at the top of the screen. The debugger will prompt you to supply any required inputs before allowing the rule to run. Resulting outcomes or objects will be reported afterward, along with detailed data about each condition.

Note that if you’re running version 3.5 or higher, you’ll need to click Test Rule instead of Debug Rule.

3.5 Test Rule Shot

Example

Our example rule expects two inputs: a string called Email Address and a Boolean called Can Use Portal. Our rule is set up to evaluate these inputs against the following conditions:

  1. Does Email Address belong to the “yahoo” domain – which is to say, does it contain the string “yahoo.com?”
  2. Is CanUsePortal set to “true?”

If both inputs satisfy their respective conditions, the rule will return an outcome of “true.” If either or both inputs do not satisfy their respective conditions, the rule will return an outcome of “false.”

 

 ruleSet
 
Begin by opening our rule for editing in the Rule Designer.
 
Near the top of the window, click the link Debug Rule.
 
 debugRule

Our debugger’s first action is to prompt us for inputs.

 

 promptForInputs

Set the Can Use Portal parameter to “true” by checking the box

 

 canUsePortalTrue

and we will supply an email address of admin@yahoo.com before clicking Run to begin our debugging session.

 

 firstRun

Because our inputs satisfy both conditions of our rule, the debugger returns a value of True.

 

 firstResultDebugger

The debugger also displays its results as a graph under the Graph View tab.

 

 firstRunResultDebuggerGraph

For a more granular view, the Data tab shows us detailed data about each condition (or step) of our rule.

 

 debuggerDataView

Additional Resources