Before you can use the Reporting module, you must first create a proxy service in the Project Explorer module, then use the Resource Browser module to add a Report action to the message flow of that proxy service.
To learn more about Reporting, see Reporting in the AquaLogic Service Bus User Guide.
The following table lists the pages you can access from the Reporting module. The tasks and help topics associated with each are provided:
Table 23-1 Reporting Pages, Tasks, and Help Topics
The Message Report Summary page allows you to view a list of reporting messages. The page displays up to 100 messages.
Note:
Before you can use the Reporting module, you must first create a proxy service in the Project Explorer module, then use the Project Explorer or Resource Browser modules to add a Report action to the message flow of that proxy service.
To List and Locate Messages
From the left navigation pane, select Reporting. The Message Report Summary page is displayed, which displays the following information for each message. For a more detailed description of the properties, see 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. To learn more, see Adding an Action.
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 Proxy Service Details page. To learn more, see Viewing and Changing Proxy Services.
Error Code
The error code associated with this message, if there is one.
To locate specific messages, click Filter. Additional fields are displayed.
To set the filter parameters, do one or more of the following:
Table 23-3 Message Filter Parameters
To...
Complete These Steps...
Filter by time parameters
Set a time period:
Click the Start Date and End Date radio button.
In the Start Date field, select a month, day, year, and time.
In the End Date field, select a month, day, year, and time.
Alternatively, you can select parameters for the most recent messages:
Select the For the Last radio button.
In the For the Last field, enter the number of days, then select hours and minutes.
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.
Note:
The service name, error code, and report index fields can use wildcard searches.
Note:
You can click Close Filter at any time to remove the filter fields from the display.
Click Search. The page displays the messages that fall within the filter parameters you set. The maximum number of messages that can be displayed as a result of a filter is 1000.
Do one of the following:
To start a new filter, click Reset, then click Filter.
To remove the filter fields from view, click Close Filter.
Note:
To locate a message, you can also do the following:
Sort the list of messages. Ascending and descending arrow buttons indicate sortable columns. Click the button to change the sort order.
Scroll through the pages. Use the controls in the lower right corner. 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.
The View Message Details page displays the following General Configuration information:
Table 23-4 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 following Inbound Service information:
Table 23-5 Inbound Service Details
Property
Description
Name
The inbound proxy service associated with this message. This is a link to the View Proxy Service Details page. To learn more, see Viewing and Changing Proxy Services.
URI
The URI associated with the proxy service.
Operation
The inbound operation associated with this message.
The page displays the following Outbound Service information:
Table 23-6 Outbound Service Details
Property
Description
Name
The outbound business service associated with this message. This is a link to the View Business Service Details page. To learn more, see Viewing and Changing Business Services.
URI
The URI to the outbound business service end point.
Operation
Name of the operation invoked on the outbound service.
The page displays the following Report Index information:
Table 23-7 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. To learn more, see Adding an Action.
The page displays the following Fault information:
Table 23-8 Fault information Details
Property
Description
Error Code
The error code associated with the message, if there is one.
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 following Report Body information:
Table 23-9 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. To learn more, see the procedure for the Report action in Adding an Action.
Click OK when you have finished viewing the details of a specific message.
Reporting in the AquaLogic Service Bus User Guide.
Purging Messages
The Purge Messages page allows you 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.
Note:
The Purge Messages feature may be useful during design and test phases of your project. However, in a production environment, BEA recommends that the management of the data in your database (including purging) is handled by the Database Administrator using database management tools.
To learn more about purging, see Reporting in the AquaLogic Service Bus User Guide.
To Purge Messages From the Reporting Datastore
From the left navigation pane, select Purge Messages from under Reporting.
Do one of the following.
Table 23-10 Message Purging Options
To...
Complete These Steps...
Purge all messages
Select the Purge All Messages radio button.
Click Submit.
Purge messages within a specified time frame
Click the Purge From and Purge To radio button.
In the Purge From field, select a month, day, year, and time.
In the Purge To field, select a month, day, year, and time.
