This chapter describes how to view and purge messages generated by the reporting feature in the Oracle Service Bus Administration Console.
Before you can use the Reporting module, you must first create a proxy service and then add a report action to the message flow of that proxy service. See Section 21.1, "Adding and Editing Actions in Message Flows" and Section 21.27, "Adding Report Actions." See also "Reporting" in the Oracle Fusion Middleware Administrator's Guide for Oracle Service Bus.
Use the Message Report Summary page to view reporting messages information shown in Table 28-2. The page displays up to 100 messages.
To restrict the number of items in the list or locate specific messages:
Click the Open icon to display additional search filters. If you specify multiple search criteria, only results that match all the criteria will be returned.
To set the filter parameters, do one or more of the following steps shown in Table 28-1.
Table 28-1 Message Filter Parameters
| To... | Complete These Steps... |
|---|---|
|
Filter by time parameters |
Set a time period:
Alternatively, you can select parameters for the most recent messages:
Note: By default, message reports for the last 30 minutes are displayed. |
|
Filter by service name |
In the Inbound Service Name field, enter the service name. |
|
Filter by error code |
In the Error Code field, enter an error code. |
|
Filter by report index |
In the Report Index field, enter the report indexes. These are the key value pairs you defined when you configured the report action for this proxy service. This is a string search. |
You can use wildcard characters in service name, error code, and report index field searches.
Entering only asterisk (*) returns all messages. For example, if you enter * in the error code field, messages with and without error codes are displayed.
In the Error Code field only, strict search limitations apply. For example, to find messages with the error code BEA12345, you can enter *, BE*, or BEA12345.
Click Search. The page displays the messages that fall within the filter parameters you set. The maximum number of messages that can be displayed when filtering messages is 1000.
Click View All to remove the search filters and display all messages.
To locate a message, you can also do the following:
Resort the list of messages. Click an underlined column name. Ascending and descending arrows indicate the sort order. Click the column name to change the sort order.
Scroll through the pages. Use the page controls above or below the table. Go to a page by selecting the page number or by using the arrow buttons to go to the next, previous, first, or last page.
Table 28-2 Message (Reporting) Summary Details
| Property | Description |
|---|---|
|
Report Index |
A link to the View Message Details page. See Section 28.2, "Viewing Message Details." Report indexes are key value pairs that you use to extract key identifiers from a message context variable. Keys are a convenient way to filter messages. You use the report action to add key value pairs. See Section 21.1, "Adding and Editing Actions in Message Flows." |
|
DB TimeStamp |
The date and time that the message was added in the database. |
|
Inbound Service |
The inbound service associated with the message. The service is a link to the View a Proxy Service - Configuration Details page. See Section 20.5, "Editing Proxy Service Configurations." |
|
Error Code |
The error code associated with this message, if there is one. You specify error codes when you configure the raise error action. See "Handling Errors in Message Flows" in the Oracle Fusion Middleware Administrator's Guide for Oracle Service Bus and Section 24.2, "Adding Proxy Service Error Handlers." |
Related Topics
See also "How to Enable Message Reporting" in the Oracle Fusion Middleware Administrator's Guide for Oracle Service Bus.
Use this page to view details of a specific message.
Locate the message. See Section 28.1, "Viewing Reporting Messages."
Click the report index. The View Message Details page displays the General Configuration information shown in Table 28-3.
Table 28-3 Message Configuration Parameters
| Property | Description |
|---|---|
|
Message ID |
The unique identification for this message. |
|
Database Timestamp |
The date and time that the message was registered in the database. |
|
Time at point of Logging |
The date and time that the message was logged. |
|
Server name |
The name of the server in which this message was generated. |
|
State |
State of the pipeline in which this message was generated: REQUEST—indicates that the reporting action is executed in a request pipeline. RESPONSE—indicates that the reporting action is executed in a response pipeline. ERROR—the action is running in the service-level error handler. |
|
Node Name |
The node name of the pipeline in which this message was generated. |
|
Pipeline Name |
The name of the pipeline in which this message was generated. |
|
Stage Name |
The name of the stage in which this message was generated. |
The page displays the Inbound Service information shown in Table 28-4.
Table 28-4 Inbound Service Details
| Property | Description |
|---|---|
|
Name |
The inbound proxy service associated with this message. This is a link to the View a Proxy Service - Configuration Details page. See Section 20.5, "Editing Proxy Service Configurations." |
|
URI |
The URI associated with the proxy service. |
|
Operation |
The inbound operation associated with this message. |
The page displays the Outbound Service information shown in Table 28-5.
Table 28-5 Outbound Service Details
| Property | Description |
|---|---|
|
Name |
The outbound business service associated with this message. This is a link to the View a Business Service - Configuration Details page. See Section 19.5, "Editing Business Service Configurations." |
|
URI |
The URI to the outbound business service end point. |
|
Operation |
Name of the operation invoked on the outbound service. |
The page displays the Report Index information shown in Table 28-6.
Table 28-6 Report Index Details
| Property | Description |
|---|---|
|
Report Index Text |
Report indexes are key value pairs that you use to extract key identifiers from a message context variable. Keys are a convenient way to filter messages. You use the report action to add key value pairs. See Section 21.1, "Adding and Editing Actions in Message Flows." |
The page displays the Fault information shown in Table 28-7.
Table 28-7 Fault information Details
| Property | Description |
|---|---|
|
Error Code |
The error code associated with the message, if there is one. You specify error codes when you configure the raise error action. See "Handling Errors in Message Flows" in the Oracle Fusion Middleware Administrator's Guide for Oracle Service Bus and Section 24.2, "Adding Proxy Service Error Handlers." |
|
Reason |
The reason for the error code. |
|
Detail |
The fault details associated with the error code. These details, if present, are typically a stack trace of where a particular fault occurred, and may be truncated due to a size limitation in the database. The limit is 2048 characters. |
The page displays the Report Body information shown in Table 28-8.
Table 28-8 Report Body Details
| Property | Description |
|---|---|
|
Report Body Text |
This link opens another browser that displays the details of the report body. You use an expression in the report action to capture the report body text. See the procedure for the report action in Section 21.1, "Adding and Editing Actions in Message Flows." |
Click OK when you have finished viewing the details of a specific message.
Use this page to purge selected messages from the reporting datastore.
Message purging occurs in the background so the Message Report Summary page is not locked up while the purge occurs. Therefore, you can do a purge that takes a while to finish; the length of time depends on how many messages need to be purged. However, if you filter reporting messages, the purging process is slowed down; the Message Report Summary page may display incorrect data as some of the data hasn't been purged yet.
The Purge Messages feature may be useful during design and test phases of your project. However, in a production environment, Oracle recommends that the management of the data in your database (including purging) is handled by the Database Administrator using database management tools.
Select Operations > Purge Messages.
Do one of the following steps, shown in Table 28-9.
Table 28-9 Message Purging Options
| To... | Complete These Steps... |
|---|---|
|
Purge all messages |
|
|
Purge messages within a specified time frame |
|
Related Topics
To learn more about purging messages, see "Reporting" in the Oracle Fusion Middleware Administrator's Guide for Oracle Service Bus.