Managing Ensemble Productions - InterSystems Documentation

Queues
There is no menu on the Queue Contents page. You can return to the Ensemble home page by clicking [Ensemble] in the
title bar navigation path.
Under the Queue Contents page title bar are two display areas, one above the other. The top display lists messages. The
bottom display provides detailed information about the message that is currently selected in the list. If nothing is selected,
the bottom display is empty. You can drag the boundary between the displays to resize them as needed. In some cases you
must use the scroll bars to see the full contents of either display.
In the top display is a table called Message Queue Contents. Each row of the table lists one of the messages currently
waiting on the queue that you selected in the [Ensemble] > [Queues] page. Each row of the table has the following columns:
• Priority — The priority of the message relative to others in the queue: RealTime (1), High (2), Normal (3), or Low (4).
The Ensemble messaging engine assigns priority values to messages automatically, in the course of normal processing,
for its own use. Message priority cannot be programmed into a message class or configured in any way. Priority values
are based in part on whether the message is synchronous (High) or asynchronous (Normal). Also, messages that start
or stop a production are assigned greater priority than other types of message.
• Index — This integer value starts at 1 for the first message placed on the queue after the production starts, and increments
by 1 for each successive message. A message has the same Index value for the entire time it is on the queue. Index
values are never reused.
• MessageId — The object identifier for the message.
In each row, the background color indicates the message’s overall status, as follows:
• Red — The message encountered an Error.
• Orange — The message is Queued.
• Green — The message marks the start of a session.
• Silver — The message arrived after a timeout expired. It has been marked as Discarded.
• Orange — The message is Suspended.
• White or pale blue, in alternating rows — These messages are OK.
To the right of each row in the Queue Contents table are two commands:
• Details — Click this command to display detailed information about the message in that row.
• Abort — Click this command to abandon any ongoing attempts to send the message.
At the top of the display is an Abort All command. If clicked, a confirmation dialog displays. If you confirm the operation,
all queued messages shown on this page are deleted, and the display returns to the [Ensemble] > [Queues] page.
11.2 Message Details
If you select a message in the [Ensemble] > [Queues] > [Contents] page and request further details, message details display
in the bottom half of the screen. Message details provide full information about every data field in the currently selected
message.
Two tables display the contents of the message header and message body, left and right respectively.
On the left is the Message Header, which displays the entire contents of the message header. Fields include:
• — The object identifier for the message header. Whenever a message header and message body are combined
together as a message, the ObjectId value in the header is used to identify the combined message object. As a result,
100 Managing Ensemble Productions