Console Online Help

Reporting

This section includes the following topics:

• Overview of Reporting
• Listing and Locating Messages
• Viewing Message Details
• Purging Messages

 

---

Overview of Reporting

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 BEA 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:

Page	Associated Tasks	Help Topics
Summary of Messages	View a list of messages.	Listing and Locating Messages
	Filter the list of messages.
View Message Details	View details of a specific message	Viewing Message Details
Purge Messages	Delete messages	Purging Messages

 

 

---

Listing and Locating Messages

The Summary of Messages page enables you to view a list of reporting messages. The page displays up to 100 messages. To learn more about Reporting, see Reporting in the BEA AquaLogic Service Bus User Guide.

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 Summary of Messages page is displayed, which displays the following information for each message. For a more detailed description of the properties, see Viewing Message Details.

Property	Description
Report Index	A link to the View Message Details page. To learn more, 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 search for 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. You specify error codes when you configure the Raise Error action. To learn more, see Error Messages and Handling and Adding Error Handling for the Proxy Service.


 
To locate specific messages, click Search. Additional search fields are displayed.
To set the search parameters, do one or more of the following:

To...	Complete These Steps...
Search by time parameters	Set a time period: 1. Click the Start Date and End Date radio button. 2. In the Start Date field, select a month, day, year, and time. 3. In the End Date field, select a month, day, year, and time. Alternatively, you can select parameters for the most recent messages: 1. Select the For the Last radio button. 2. In the For the Last field, enter the number of days, then select hours and minutes.
Search by service name	In the Inbound Service Name field, enter the service name.
Search by error code	In the Error Code field, enter an error code.
Search 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 Search at any time to remove the search fields from the display.

Click Search. The page displays the messages that fall within the search parameters you set. The maximum number of messages that can be displayed as a result of a search is 1000.
Do one of the following:
• To start a new search, click Reset, then click Search.
• To remove the search fields from view, click Close Search.

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.

Related Topics

Overview of Reporting

Purging Messages

 

---

Viewing Message Details

The View Message Details page enables you to view details of a specific message. To learn more about Reporting, see Reporting in the BEA AquaLogic Service Bus User Guide.

To View Details of a Message

Locate the message. To learn more, see Listing and Locating Messages.
Click the report index.

 

The View Message Details page displays the following General Configuration information:

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:

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:

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:

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 search for 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:

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. To learn more, see Error Messages and Handling and Adding Error Handling for the Proxy Service.
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 following Report Body information:

Property	Description
Report Body Text	This is a link that opens up another browser to display the detail of the report body. You use 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.

Related Topics

Overview of Reporting

Listing and Locating Messages

Purging Messages

 

---

Purging Messages

The Purge Messages page enables you to purge selected messages from the reporting datastore.

Message purging occurs in the background so the Summary of Messages 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 do a search for reporting messages, the purging process is slowed down; the Summary of Messages page may display incorrect data as some of the data hasn't been purged yet.

To learn more about purging, see Reporting in the BEA 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:

To...	Complete These Steps...
Purge all messages	1. Select the Purge All Messages radio button. 2. Click Submit.
Purge messages within a specified time frame	1. Click the Purge From and Purge To radio button. 2. In the Purge From field, select a month, day, year, and time. 3. In the Purge To field, select a month, day, year, and time. 4. Click Submit.


 

Related Topics

Overview of Reporting

Listing and Locating Messages

Viewing Message Details