Viewing Business Rule Logs

This topic describes how to access the logs generated when a business rule runs and explains the information contained in the logs.

Use business rule logs to gather insight into the status and results when your business rules run. Each time a rule runs, triggered by either an event or a scheduled rule, that information is captured and stored. The information can help you confirm that a rule has run, what its status is, and it can also help you to identify, troubleshoot, and resolve any errors or discrepancies. Typically, the logs would be used to assist development and testing efforts, however, log information can also be useful for communicating production environment issues with Oracle support teams.

You access the high-level business rule run information on the Logs page. You can then drill into a specific log to access:

Log details
Rule logs
Action logs

Accessing Business Rule Logs

To access the business rule logs:

In the Navigator, select Common Setup > Business Rules Framework.
Click View Logs on the Business Rules Framework landing page.
On the Logs page, use the search controls to filter the logs and isolate the log(s) you need to review.

You can select to view logs for the last 7, 14, or 30 days. Or, you can select Date Range from the drop-down list to specify a custom range.
Turn on Show All Statuses to display all rule logs.
By default, only Error and Warning statuses are displayed.
Click anywhere in the row for a particular log to open the Log Detail page for that business rule run.

Setting Up Email Notifications for Errors

You can set up an email notification to alert system administrators to log entries with a status of Error. You enable this feature in the agency options.

Select Common Setup > Agency.
Select your agency.

Locate the Business Rules Framework section on the Agency Information tab, and modify these settings.

Page Element	Description
Error Notification Email	Enter the email address to send notifications of any business rule processing errors. Note: Because of the 250-character limit, it is recommended to use email distribution lists, rather than multiple individual email addresses.
Notify on Error	Turn on to enable email communication to be sent related to any business rule processing errors.

Click Save.

Working with Log Details

The Log Detail enables you to drill into specific information regarding a business rule run and its actions.

Page Element	Description
Reference Name	Indicates the object the rule is running against, such as permit, an incident, a user profile, and so on.
Reference ID	The system identification for the object the rule is running against. For example, in the case of a user profile it may display the user name, while in the case of a permit, it displays the transaction ID, which can be clicked to navigate directly to the transaction associated with the rule.
Resource Code	The system name for the business object of the event that triggered the rule. For example, CE_INCIDENT.
Resource	The name of the resource (business object) of the event that triggered the rule. For example, Code Enforcement Incident.
Event Code	The system name of the event that triggered the rule. For example, CE_INCIDENT_STATUS_UPDATED.
Event	The name of the event that triggered the rule. For example, Incident Status Updated.
Log ID	The unique identifier of a particular log entry.
Execution ID	The unique identifier of the internal system instance associated with a particular Business Rules Framework request.
Created Date	The date and time at which the Business Rules Framework request was created.
Created By	The user ID of the individual user, system component, or application that created the Business Rules Framework request. For example, it could be the Oracle Integration Cloud user, an individual user, or the Oracle Permitting and Licensing application (FUSION_APPS_PSC_APPID).
Log Message	A high-level message indicating more details related to when the Business Rules Framework received the request. The detailed log information resides in the rule and actions grid below. Note: The message display is limited to 1,000 characters. In the case of a longer log message, some critical information may not be visible.
Status	The status of a business rule run, such as Success, Error, or Warning. The overall status is comprised of the results of the underlying rule run and the action(s) run. These are the statuses: Success indicates all rules within an execution ID, display a status of Success. Warning indicates there are both Success and Warning statuses within an execution ID. Error indicates there are both Error and Warning statuses within an execution ID. No Rules, indicates the rule found nothing to be completed, there are no rules associated with an event, or the rules associated with an event aren't enabled. Not Available, indicates that Business Rules Framework is aware a request was made but did not receive enough information to begin processing the request. This can indicate momentary network down-time, outages, or brown-outs.
Retry	The Retry button appears for requests in the Not Available status. In this case, you can click Retry to rerun the request. When retrying a request, the system generates a new execution ID, so in the logs you will see the original request execution ID with the Not Available status and the new request execution ID displaying its status. Retrying requests is not supported for: Stop process actions. Scheduled rules. Requests where rule processing had begun.
Retry Status	Appears only for the requests that you retry using the Retry button. This field displays information about the original request and other details depending on the request type.

Beneath the main rule information, you can access additional information related to the rule and actions.

Working with Rule Logs

The rules and actions grid displays the following details for the rules associated with the event.

Page Element	Description
Rule Name	The names of all rules associated with that event appear in the Rule Name column.
Status	Indicates the status of an individual rule.
Log Type	Indicates the type of log, in this case a rule log, and provides a link to display the log text for that rule.
Key-value pairs	Displays the key information that applies to the transaction of the business rule's focus, such as the record key for a permit, inspection, and so on. There can be up to five key-value pairs.

Working with Action Logs

When actions have been triggered, you can expand the rule log row to reveal the action logs for that rule. The action log provides this information.

Page Element	Description
Action Name	The names of all actions associated with that rule appear in the Action Name column.
Log Type	Indicates the type of log, in this case an action log, and provides a link to display the log text for that action.
Status	Indicates the status of an individual action.
Retry Count	Indicates the number of times an action in the status of Error has been retried, automatically or manually.
Sent	Click to view the JSON payload sent by the Business Rules Framework. If needed, an administrator can edit the payload manually to correct data. Click Save to store the changes.
Response Code	Displays the REST/HTTP response code received by the Business Rules Framework after sending the rule payload. For example, 200, 400, 403, and so on.
Received	Click to view the JSON payload received by the Business Rules Framework.
Actions	In the case of actions in the Error status, the Actions column displays the Retry button, which administrators can click to retry the action. If you've modified the sent payload (to resolve any issues detected), the Business Rules Framework sends the modified payload.