Managing Messages (Legacy UI)

This page describes how to use the legacy Message Viewer to resend messages and export messages.

For information on performing these tasks with the new UI, see Managing Messages.

Resending Messages

If a message failed to be delivered, you can correct the problem that resulted in the failure, and then resend the message.

Select the messages by selecting the check boxes in the left column. Or filter the display appropriately and then click the check box at the top of the left column.
If you need to edit messages before resending them, then select a single message. You cannot use the Edit and Resend option (shown later) if you select multiple messages on this page.
Select Resend Messages.
If you checked the check box at the top of the left column and if there are multiple pages of selected messages, the system then displays the following message:
More messages match your search criteria than appear here. If you want to resend all the messages that match your criteria, including those not shown on this page, click OK. To resend only your selected messages, click Cancel.
Now do one of the following:
- Select OK to continue with all the selected messages.
- Select Cancel to continue with only the selected messages that were visible on the first page.
In either case, you can later cancel the action.
The system then displays details for the selected messages. The table includes the following information:
- Session—The session to which each message belongs. Click this to view the visual trace of the primary message object through the production. See Sessions.
- Header—The ID for the message header (also the message ID). Click this to view the visual trace of this specific message. See Message Basics.
- Msg Body—The ID for the message body. Click this to view the message contents.
- Created—The message creation time stamp. See Invocation Style and Message Time Stamps.
- Source—The business host that sent the message.
- Target—The business host that was intended to receive the message. This field also indicates if the production target is not running; note that you cannot resend a message if the intended target is not running. Click this to see the contents of the target’s message queue.
If you selected more than 1000 messages, only the first 1000 are shown, but the page indicates the total number that you selected.
Optionally select a new target business host. To do so, select a value for New target.
Optionally select Resubmit at head of queue.
If you do so, InterSystems IRIS places the resent message at the front of its target queue. This helps to preserve FIFO (first in, first out) processing when the order of messages is important.

Important:

Before using this option, first disable the target component temporarily. This enables the production to build up the queue in the expected order, so that the target does not take messages from the queue before you have finished adding all the messages you want to resend.
Click one of the following:
- Cancel—To cancel this action.
- Resend—To resend the message or messages as specified.
- Edit and Resend—To edit the message and resend it as specified. See the subsection for details.

When you resend multiple messages, InterSystems IRIS resends them in order by age, starting with the oldest messages.

When you resend the messages, the page is redisplayed with an additional Resend Status column. Any status other than OK indicates that the resend operation failed. A resent message retains the same Session identifier and transmits the same message body, but acquires a new message header (with a new, unique ID) to mark its additional trip through the production. The visual trace includes both the original message transmission and any resend operations that involve the same message. The description in the message header contains text indicating this message has been resent; the description includes the original along with any subsequent header object identifiers.

Resend Editor

When you select one message to resend from the Message Viewer page, you have the option to edit the body of the message before resending it.

Click Edit then Resend to display the Resend Editor page.
Use the entry fields to update the message body data. The fields vary depending on the message. If the message has no properties, none are displayed.
If you are editing a virtual document message, you can edit data in the message content and also edit object properties in the box below the content box.
Click Resend to send a new copy of the message header with your edited message body to the target.
After a successful resend, the page refreshes with text indicating the new Header and Msg Body identifiers. Click Trace to see the visual trace of the resent message.

Exporting Messages

You can download multiple messages to your local machine using the Export button of the Message Viewer. Clicking the Export button brings up a dialog box where you can specify the name of the export file, how you want to separate the messages within the file, and the character set used. The export file is downloaded to your local machine using your browser’s built-in download capabilities. You must have USE permissions for the %Ens_MessageExport resource to export messages.

Exporting Large Quantities of Messages

To prevent you from accidentally exporting a very large quantity of messages, the process for exporting large quantities is more complex. If you select all messages, but there are more messages returned by the search than fit on the results page, you must have access to the Workflow Inbox to complete the export process. For administrative instructions on giving users access to the Workflow Inbox, see Giving Users Access to Workflow Inbox .

To export large quantities of messages:

Access the legacy Message Viewer.
Search for the messages you want to export.
Click the check box in the header of the search results page to select all messages.
Click Export .
A dialog box appears that indicates that you have selected more messages than appear on the search results page.
Click OK .
Specify the name of the download file, how you want messages separated in the file, and the character set used.
Click OK twice.
Go the InterSystems IRIS home page.
Go to Analytics > User Portal . The current namespace must be enabled for Analytics to complete this step.
Click Workflow Inbox.
Select the message in the Workflow Inbox and click Confirm in the body of the message.
Wait until a new message titled “Exported File available for download” appears in the Workflow Inbox, then select the message.
Click Download in the body of the message.
When the file has been successfully downloaded by the browser, click Completed Download to remove the temporary file from the server.

Note:

You cannot download messages if they exceed 50% of the free disk space in the directory specified by %SYS("TempDir", namespace ) .

Giving Users Access to Workflow Inbox

You must have proper credentials to complete these steps. The user will not be able to access the Workflow Inbox unless the namespace is enabled for Analytics.

Go to Interoperability > Manage > Workflow > Workflow Users.
Select the user’s name from the Name drop-down list.
Select Active.
Click Save.
Go to Interoperability > Manage > Workflow > Workflow Roles.
In the Name field, enter: %ProductionMessageExport and click Save.
Select the new role from the list and click Add.
Select the user’s name from the User Name drop-down list and click OK.