Managing Ensemble Productions - InterSystems Documentation

Message Browser
• Session — The unique identifier for the session that is (or was) associated with this message. A session marks the
beginning and end of all the activities prompted by a primary request message from outside Ensemble. The primary
request message has an ID value that is identical to the Session. Several additional messages may be instantiated within
Ensemble during the session to fulfill the primary request. All of these messages share the same Session, but each has
a different ID value.
You can click the Session number in any row of the table to see a visual trace of the message object through the production.
• Status — Indicates the status of the message within its normal life cycle: Created, Queued, Delivered, Deferred,
Completed, Discarded, or Suspended. If there is a request-response pair, the value does not indicate an overall status
for the pair; a request may end up with a different Status from its corresponding response.
A message in transit has a Status of Created, until it finds its place on a queue, when it becomes Queued. A message
that reaches its destination is at first Delivered, then finally Completed. An asynchronous response is Discarded if it
arrives after the timeout period for the corresponding request expired. A message response can been Deferred by a
business operation to be sent later on; when a Deferred message is finally sent, it has a Status of Completed.
Some business operations are designed to set the status of any failed messages to Suspended. Alternatively, an
administrator can suspend a message from the Instances display on the [Ensemble] > [Host Monitor] page. In either
case, such a message goes on a special queue where Ensemble keeps all Suspended messages. An administrator can
use the [Ensemble] > [Maintenance] > [Suspended] page to examine Suspended messages, diagnose the problem, and
if possible resend the Suspended messages after the problem is fixed.
• Error — A quick overview of the results returned by the message to the configuration item that sent it, the Error field
can have the values OK, Error, Retry, or Inactive.
OK means normal behavior; Retry means the message experienced a failure but the item that sent it is configured to
retry the failed message. Error means an error was reported somewhere in the activity. Inactive means that the item
that sent the message has been idle for longer than its Inactivity Timeout setting, and may require diagnostic action.
When you filter messages for diagnostic purposes, you can use the Error field to quickly select only those messages
with errors.
• Source — The configuration item (service, process, or operation) that sent the message.
To the right of each row are four commands which you can click to display additional message information:
• Details — Display the fields in the message object in the bottom half of the Message Browser display.
• Contents — View the contents of the message body in an appropriate format.
• Trace — Visually trace the path of the message object through the production.
• Report — Display all the fields in the message header and message body in XML format.
The default background color of rows in the Message Browser table indicates the message’s Status as shown in the following
table.
Color
Red
Orange
Green
Silver
Orange
Indication
The message encountered an Error.
The message is Queued.
The message marks the start of a session.
The message arrived after a timeout expired and is marked as Discarded.
The message is Suspended.
72 Managing Ensemble Productions