Viewing the Business Rule Log
The Business Rule Log ([Interoperability] > [Business Rule Log]
) is a persistent record of business rules that have been executed, their respective results, and reasons for the result.
To access this page from the Management Portal, click Interoperability
, and then click Go
. Or click
in the ribbon bar of the [Interoperability] > [Business Process List]
This chapter describes this page and how to use it. It contains the following sections:
The Business Rule Log
page is divided into the following three panes where you can perform the indicated functions:
You can expand and collapse the right and left panes as desired using the double arrow icons.
There are four commands in the ribbon bar of the Rule Log page:
Click to sort and filter the list of rule log entries using the criteria shown in the left pane. See the Search Rules By
section for details.
Click to reset the rule log search criteria to the default values of the quick search fields. See the Quick Search
section for details.
Click to show the previous page of results based on the Page Size
Click to show the next page of results based on the Page Size
Entering Search and Purge Criteria
The left pane permits you to enter search and purge criteria to filter the list of rules.
There are two types of search:
You can also remove entries from the rule log as described in the following section:
Enter the following values to filter the executed rule list:
The maximum number of rule log entries to display in the middle panel as a result of the search. If more entries exist, you can click
to page through the results. Default is 500
Select a time interval to refresh the list or select not to have the list automatically refreshed. Default is None
This is a read-only field showing what page of the list is being displayed.
Select to show the time only or the time with the date. Default is Complete
(time with date).
Select this check box if you only want to see rule executions that had errors. Default is to show all executions (check box is cleared).
As you enter values in these fields the middle pane display updates to reflect your entries.
You can filter what entries display in the list by entering values in one or more of the following fields:
Choose a rule name as defined in the Rule Editor. The filter finds all of the occasions when this rule has been invoked by business processes.
Find all the rule log entries associated with a particular session.
Once you enter new search criteria, click
in the ribbon bar to refresh the list accordingly.
You can purge the rule log by entering the number of days to keep the entries and then clicking
. The Current Count
is a read-only field displaying the number of entries in the rule log. If you want to purge all entries in the log, enter 0
in the Days
Viewing the Executed Rule List
Each time a business process executes or fires
a rule, InterSystems IRIS™ writes an entry to the Business Rule Log stating the details of what happened. You can view this log on the [Interoperability] > [Business Rule Log]
page of the Management Portal. The list displays the following information for each business rule log entry:
The unique identifier for the session that is (or was) associated with this rule. A session marks the beginning and end of all the activities prompted by a primary request message from outside InterSystems IRIS.
The date and time when this rule was last invoked.
The name assigned to the rule in the Rule Editor.
The value 1 means that the rule encountered an error. The value 0 means that the rule did not encounter any errors.
The value returned by the rules engine for this rule.
You can also perform the following actions on a selected rule:
Click the Session
to navigate to the Visual Trace
display for the session that contained this particular execution of the business rule.
Viewing Rule Execution Details
You can select a log entry to view the details of that particular execution of the rule. Select a row in the middle pane and the expanded right pane displays the following informational fields:
Unique identifier for this rule execution.
Unique identifier for the session that is (or was) associated with this execution of this rule. A session marks the beginning and end of all the activities prompted by a primary request message from outside InterSystems IRIS.
Date and time when this rule was executed.
Name of the rule definition class that was executed.
Name of the rule set that was executed.
Specific rule name that cause the rules engine to generate the result. If a business rule is empty or undefined, the reason is Rule Missing
depending on whether the execution of the rule resulted in an error.
If the rules engine returns an error, then this is the text associated with the error.
Value returned by the rules engine for this rule.
Name assigned to the <rule> activity in the BPL code.
Effective Begin Date/Time
Effective begin date and time of the executed rule set.
Effective end date and time of the executed rule set.
From the right pane, you can perform the following actions on the selected rule: