Using the Enterprise Message Viewer

docs.intersystems.com

Home / System Administration / Monitoring Productions / Using the Enterprise Message Viewer

Monitoring Productions

InterSystems: The power behind what matters

This chapter describes using the Enterprise Message Viewer. It discusses the following topics:

The Enterprise Message Viewer is a special production that runs in a namespace. In this namespace, you should identify the systems that you intend to search for messages. To identify a system, you provide a name, Web IP address (including port number), namespace, SOAP credentials, and SSL configuration. For details, see Identifying Enterprise Systems for Viewing and Monitoring. In addition, you must define on the Enterprise Message Viewer system all classes that you will be using in search criteria. These classes are the ones that define the body parts and search tables in the production messages.

Once you have identified one or more systems, you can access the Enterprise Message Viewer by clicking Interoperability, View, and Enterprise Messages. You can also access the Enterprise Message Viewer by clicking Interoperability, Configure, and Enterprise Systems and then clicking the Enterprise Message Viewer link.

For an overview of the Enterprise Message Viewer and the Enterprise Message Bank, see Viewing Messages from Other Namespaces.

Specifying a Query in the Enterprise Message Viewer

To specify a query in the Enterprise Message Search, you can enter any of the following:

Sort Order—specifies whether the messages should be stored newest or oldest first.
Page Size and number—specifies the number of messages to display on a page and the page to display.
Time Format—specifies whether the time or time and date are displayed.
Basic Criteria—provides the basic selection criteria.
- Status—specifies whether all messages are to be selected or only messages with the specified status, such as suspended messages.
- Type—specifies whether session start messages, request messages, response messages, or all messages are to be selected.
- Start Time and End Time—specifies the range of date-times of the messages to be selected.
- Start ID and End ID—specifies the range of message IDs that are to be selected. Since each system numbers messages independently, these criteria are typically only useful when you are searching for messages from a single system.
- Source—specifies the name of the production component that originates the message. Typically, this is a business service or business process. By default, messages from all sources are included in the selection.
- Target—specifies the name of the production component that is the target of the message. Typically, this is a business process or business operation. By default, messages to all targets are included in the selection.
- Maximum Rows—specifies the maximum number of messages that each system should return to the Enterprise Message Viewer.
- Query Timeout—specifies the number of seconds to wait for the systems to respond to the query. A value of zero specifies that there is no timeout period. The query timeout can be specified to 1/100th of a second precision.
Enterprise Clients—specifies which systems should be queried. Check the box for each system that you want to query. The systems listed are the ones specified in Identifying Enterprise Systems for Viewing and Monitoring.
Extended Criteria—allows you to specify queries, which can be combined with the AND and OR operators. The query form specifies:
- Enable Criterion—specifies whether this element of the query is active.
- Criterion Type—specifies whether this element of the query is on the HeaderField, BodyProperty, SearchTableField, VDocSegmentField, VDocPropertyPath, or an OR operation combining the previous element of the query with the next element of the query.
- Class—is dependent on the criteria type and the types defined on the Enterprise Message Viewer system. Note that you do not have access to classes defined on the systems running the productions that are not also defined on the Enterprise Message Viewer system.
- Conditions—specify one or more conditions of the query. The fields of the conditions form are determined by the criterion type.
- Display Values—specify one or more fields to display in the results but that are not part of the selection criteria.
Saved Searches—allows you to save the current search or retrieve a saved search.

Working with the Search Results in the Enterprise Message Viewer

The Enterprise Message Viewer displays a page of the search results. You can page through the results with the Next and Previous buttons. You can examine the information about the message that was included in the search results or you can click the system name in the first column, which is a link to the Message Viewer on the system that runs the business production. You may be prompted for username and password to log onto the system. The link opens the Message Viewer on the system but does not select the individual message that you were examining on the Enterprise Message Viewer. You can use the message ID to search for the message.