Temenos Lifecycle Management Suite - Collection Product Guide
Rules Management - Rule Trace Analyzer
| Administrator Guide > Welcome to Rules Management > Rules Management - Rule Trace Analyzer |
The Rule Trace Analyzer is a detailed, analytical tool that provides administrators with an efficient method of testing and troubleshooting rules directly within the Rules Management Application. This functionality enables the ability to easily uncover issues within a business rule that may impact the rule's ability to execute properly. With this functionality, administrators can create a rule trace within Rules Manager that analyzes a specific rule and returns information about how the rule executes.
 |
The Rule Trace Analyzer functionality provides the ability to evaluate data after a rule is executed. Running a trace on a rule written under the Workflow category might not populate an expected result as the actual test data is not being executed when the trace is run. |
 |
To see this functionality in action, view the Rule Trace Analyzer Video Tutorial. |
The Rule Trace Analyzer topic provides an overview of the following information to assist administrators with generating a rule trace and analyzing the rule trace details:
A Rule Trace can be run to analyze a specific rule within the Rules Management Application and return information about how the rule executed.
To generate a rule trace within Rules Manager, click on the category associated with the desired rule to populate the Rules grid.
 |
For an overview of the Rules Management Application, please see the Getting Started with Rules Management topic within this guide. |
Double-click on the desired rule within the Rules grid, or highlight the rule and click 
.
Within the Edit Rule window click 
.
|
Any unsaved changes to the rule application are not used in the analysis of the rule. |
A window appears to identify the object on which the rule is to be run:
Within this window, enter the following information to run a trace on the rule:
| Field | Description | ||||
| Run Rule On |
Select an option from the drop-down list to identify the object on which the rule is to be run. For example, if the rule should be run on a specific account, select Account. If the rule should be run on a person's entire relationship with the institution, select Person. The options within this drop-down include the following:
|
||||
| Enter Number/Identifier |
Enter the specific number/identifier on which the rule is to be run.
|
After all fields are complete, click to generate the rule trace.
|
If an invalid number/identifier is entered, an error message is received to alert that the entered number/identifier cannot be found. |
Once a rule trace has been generated successfully, the Rule Trace Review screen opens in a separate Internet Explorer window.
|
The first time a rule trace is generated, a Rule Trace folder is created and stored on the sharepath. Each time a rule trace is run, the data is stored in the database and a file is placed in the Rule Trace folder. A record of each rule trace is stored for a default value of 45 days from the last day the trace was opened. This enables the ability to view past rule trace records with the assistance of a Temenos Customer Care Representative. |
The Rule Trace Review screen displays detailed information about the rule's execution for testing and/or troubleshooting purposes and enables the ability to analyze specific details related to the rule's execution. Within this screen, administrators are provided with the ability to compare the values of an object before and after the rule is run as well as analyze each rule condition to understand how the rule executed.
The Rule Trace Review screen includes the following sections:
The Object Before Rules and Object After Rules sections include folders containing the object values on which the rule is run. Each folder can be expanded to display the specific field values that populated both before and after rule execution.
|
The title of these sections and the folders that display are dependent on the rule trace object. For example, when a rule trace is run on a person, these sections appear as Person Before Rules and Person After Rules and the object values that populate are those related to the person. |
The Object Before Rules section appears in the top left of the Rule Trace Review screen and provides an overview of the object values that appeared before the rule was executed.
The Object After Rules section appears in the top right of the Rule Trace Review screen and provides an overview of the object values that were updated after the rule executed.
These sections can be used to compare the value of a specific field, before and after rule execution, to verify whether it updated to an expected value. For more information, please see the Comparing Object Values Before and After Rule Execution section within this topic.
Back to Rule Trace Review Screen ^
The Rules Executed section provides a list of each rule that ran as a part of the initial rule. For example, when a rule is run on an account, a separate rule is run on every person related to the account.
|
When multiple rules are run within the rule being analyzed, by default, the first rule that ran is selected within the list of rules executed. If any pre-processing rules were run, the default rule selected is the first rule run that is not a parent rule as shown in the below example. |
|
A rule that appears in the tree as a child of another rule identifies that the parent rule called the child rule. |
Select a rule within the Rules Executed list to populate a visual representation of the rule within the Rule Review section of the Rule Trace Review screen. When a new rule is selected, the existing rule and any loaded details are cleared from the Rule Review and Details sections before information for the new rule is displayed.
Back to Rule Trace Review Screen ^
The Rule Review section is the main area of the rule trace that displays a visual representation of the rule selected within the list of rules executed. The visual that appears is dependent on the type of rule that ran. For example, if a rule is a Business Language rule, the Rule Review section appears as follows:
The example below displays how the Rule Review section appears for a Decision Table:
Elements within the rule are colored to indicate whether the condition or decision table row evaluated to true, evaluated to false or did not execute.
Reference the table below for an overview of the colors that may appear within the each rule, as well as a description of what each color indicates about the Business Language Rule or Decision Table:
| Color | Business Language Description | Decision Table Description |
| Red | Condition evaluated to false. | Conditions within the row evaluated to false. |
| Green | Condition evaluated to true. | Conditions within the row evaluated to true. |
| Gray | The section of the rule did not execute. | N/A |
| Black | The section of the rule was able to execute since condition(s) evaluated to true. | Conditions within the row were not considered for execution since an earlier condition was met. |
Selecting a condition in the Rule Review section populates the specific values related to that condition within the Details section. This provides administrators with the ability to verify the exact values that caused a true or false evaluation.
Back to Rule Trace Review Screen ^
The Details section displays InRule execution details about the Business Language rule or Decision Table that was executed. When an "If" condition or decision row is selected within the Rule Review section, the details pane expands and displays the execution details.
|
This section only displays details related to a condition or decision row that ran within the rule. No details are provided when a condition or decision row that did not run is selected within the Rule Review section. |
The details within this section are populated from InRule and contain the object values that were updated during rule execution.
Back to Rule Trace Review Screen ^
Within the Rule Trace Review screen, business language rules and decision tables can be analyzed according to the colors that appear within the Rule Review section of the screen, the InRule details that appear within the Details section as well as by comparing values that populate for the object both before and after rule execution.
This section contains the following information to assist administrators with analyzing a rule using Rule Trace Analyzer:
Conditions in a business language rule are grouped by "If" statements. In the example below, since the entire "If" condition appears green, it can be determined that the person the rule was run on has an account that meets all of the specified criteria, therefore the "Then" portion of the rule is able to execute as indicated by the "Then" appearing green and the action appearing black.
Clicking a condition populates the InRule details within the Details section of the Rule Trace Review screen. For example, in the screenshot below, the values for Days DQ and DQ Amount populate to indicate that amounts are greater or equal to the amount identified within the rule:
|
Since "If" conditions are grouped, when one condition evaluates to false, the entire "If" condition appears red. To identify which condition resulted in the false evaluation, click on the condition to populate the values within the Details section. Use the values within the Details section to identify which condition did not meet the specified criteria. In the example below, though the entire "If" condition evaluated to false, the information in the Details section identifies that DQ Amount was the condition that resulted in the false evaluation as 500 is less than 1000:
|
When multiple "If" conditions are included in a rule, and the "If" conditions evaluate differently, the rule appears as follows:
In the example above, the first "If" condition evaluated to true, as identified by the green, therefore the second "If" condition was able to execute. Since the second "If" condition evaluated to false, as identified by the red, the "Then" action did not execute and appears in gray.
Conditions in a Decision Table are grouped by Decision row. In the example below, it can be determined that all conditions within the first decision row evaluated to true, as identified by the green. Since the rule conditions were met, the next rows are not considered for execution and display in black.
When a rule is configured to change a value, the related values can be compared in the Object Before Rules and Object After Rules sections of the screen. For example, the rule executed was configured to set the value of the RepoFlag field to true based on the conditions of the rule being met. Since the conditions in the example rule evaluated to true, the value for the RepoFlag field was updated within the Person After Rules section as shown below:
|
If additional assistance is required with testing/troubleshooting a rule, or viewing a past rule trace record, please contact a Temenos Customer Care Representative. |
