Skip to main content
Previous sectionNext section

Viewing the Business Rule Log

The Business Rule Log (Interoperability > View > Business Rule Log) is a persistent record of business rules that have been executed, their respective results, and reasons for the result. You can navigate to this page using the menu or you can select Rule Log in the ribbon bar of the Interoperability > List > Business Processes page.

This chapter describes this page and how to use it. It contains the following sections:

Introduction

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:

  • Search — 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.

  • Reset — Click to reset the rule log search criteria to the default values of the quick search fields. See the Quick Search section for details.

  • Previous — Click to show the previous page of results based on the Page Size.

  • Next — 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:

Quick Search

Enter the following values to filter the executed rule list:

  • Sort Order — Select to list either the oldest or the newest entries first. Default is Newest First.

  • Page Size — 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 Previous and Next to page through the results. Default is 500.

  • Page — This is a read-only field showing what page of the list is being displayed.

  • Time Format — Select to show the time only or the time with the date. Default is Complete (time with date).

  • Errors — 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.

Search Rules By

You can filter what entries display in the list by entering values in one or more of the following fields:

  • Start Time — Enter the lower limit of a range of Time Executed values.

  • End Time — Enter the upper limit of a range of Time Executed values.

  • Rule Name — 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.

  • Session Id — Find all the rule log entries associated with a particular session.

Once you enter new search criteria, click Search in the ribbon bar to refresh the list accordingly.

Purge Rule Log

You can purge the rule log by entering the number of days to keep the entries and then clicking Purge. 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 field.

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 Business Rule Log page of the Management Portal. The list displays the following information for each business rule log entry:

  • Session — 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.

  • Time Executed — The date and time when this rule was last invoked.

  • Rule Name — The name assigned to the rule in the Rule Editor.

  • Error — The value 1 means that the rule encountered an error. The value 0 means that the rule did not encounter any errors.

  • Return value — The value returned by the rules engine for this rule.

You can also perform the following actions on a selected rule:

  • Select the Session to navigate to the Visual Trace display for the session that contained this particular execution of the business rule.

  • Select the Rule Name to navigate to the Rule Editor page for this business rule definition class.

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:

Execution ID

Unique identifier for this rule execution.

Session ID

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.

Time Executed

Date and time when this rule was executed.

Rule Name

Name of the rule definition class that was executed.

Rule Set

Name of the rule set that was executed.

Reason

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.

Error?

Displays Yes or No depending on whether the execution of the rule resulted in an error.

Error Message

If the rules engine returns an error, then this is the text associated with the error.

Return Value

Value returned by the rules engine for this rule.

Activity Name

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/Time

Effective end date and time of the executed rule set.

These informational values correspond to properties of the Ens.Rule.Log class, which you can view in the Class Reference.

From the right pane, you can perform the following actions on the selected rule:

  • Click Trace to see a visual trace of the session that contained this execution of the business rule.

  • Click Rule to navigate to the Rule Editor page for this business rule definition class. See Developing Business Rules.