Filtering Messages

To add a criterion, click Add Criterion. InterSystems IRIS displays a wizard as follows:

Specify the following values:

• Enable Criterion—Select to enable this search.

• Criterion Type—Choose a value from the list. See the next subsection.

• Class—Click a class name from the list. See the Class subsection.

• Conditions—Allows you to specify fields and values for your logical statement. See the Conditions subsection.

• Display Values—Allows you to specify additional values to display in the table. Your chosen values are displayed on the right side of the table.

Click OK to save this criterion and add it to the Extended Criteria list.

For Criterion Type, select a value from the drop-down list, if applicable. The following table lists the choices and how they affect your subsequent choices in the Class and Conditions fields.

For Class, select a value from the drop-down list, if applicable. InterSystems IRIS lists all the classes appropriate for the selected Criterion Type. For example:

For Conditions, specify fields and values for your logical statement, from left to right, as follows:

1. For the first cell, select a value from the drop-down list, which includes all choices appropriate for this context. For further instructions, see the first table below.

2. For the second cell, select a comparison operator from the drop-down list. See the second table below.

3. In the third cell, type the literal string that you intend to match using the selected operator.

   Do not use double quotes around the string.

Choices in the Conditions panel vary according to your choice of Type. The following table describes the choices.

The comparison operator between the two values in a Conditions statement can be any one of the following.

If you have multiple items in the Extended Criteria section, you can click the up-arrow and down-arrow icons to adjust their order.

To edit an item, click the edit button for that item.

To delete an item, click X.

If Extended Criteria displays contains multiple criteria, they are implicitly joined by AND. For example, suppose that you have three statements visible:

Logical Statement 1
Logical Statement 2
Logical Statement 3

In this case, your filter actually works like this:

Logical Statement 1
AND
Logical Statement 2
AND
Logical Statement 3

To modify this logic, use Add OR and reposition the OR as needed. Suppose you added an OR row and a fourth logical statement to the list shown above. The Extended Criteria panel now looks like this:

Logical Statement 1
Logical Statement 2
Logical Statement 3
OR
Logical Statement 4

And the resulting logic is now:

Logical Statement 1
AND
Logical Statement 2
AND
Logical Statement 3
OR
Logical Statement 4

The operator AND binds more tightly than OR, so the effect of the above sequence is actually:

(1 AND 2 AND 3) OR 4

The Header tab displays the standard fields in any production message header:

• <ObjectId>—The ID of the message header (and also the message ID; see Message Basics).

• TargetConfigName— The name of the business host that is intended to receive the message.

• Type—The message type, Request or Response.

• Invocation—Indicates how the message was sent. See Invocation Style and Message Time Stamps.

• CorrespondingMessageId—For a request message, this field contains the message ID of the corresponding response (if any) or it is blank. For a response message, this field contains the message ID of the corresponding request.

• SessionId—The ID of the session associated with this message. See Sessions.

• SourceConfigName—The business host that sent the message.

• SourceBusinessType—BusinessService, BusinessProcess, BusinessOperation, or Unknown.

• TargetBusinessType—BusinessService, BusinessProcess, BusinessOperation, or Unknown.

• BusinessProcessId—Every business process that gets executed has an instance and this is the object ID of that instance. If the message is a request, this field identifies the business process in whose context the message was created (sender). If the message is a response, this field identifies the business process to which it is being returned (receiver). This field is empty in various circumstances, for example if an error occurred.

• TargetQueueName—The destination “address” for the message, this indicates where it is going:

  • If this is a name, it identifies a public queue, such as Ens.ActorOpens in a new tab.

  • If this is a number, it identifies the job ID associated with the private queue of a business host.

• ReturnQueueName—The return “address” for the message, this indicates where it came from:

  • If this is a name, it identifies a public queue, such as Ens.ActorOpens in a new tab.

  • If this is a number, it identifies the job ID associated with the private queue of a business host.

  The ReturnQueueId value is listed even if there is no response expected or needed for a particular request message type.

• MessageBodyClassName—The class name for the message body.

• MessageBodyId—The ID for the message body. This field matches the <ObjectId> field in the Message Body table.

• Description—A text description of the message. The InterSystems IRIS Business Process Language (BPL) provides text in this field automatically, based on the type of BPL activity that generated the message.

• SuperSession—The ID for messages sent via HTTP from one production to another. For details, see SendSuperSession.

• Resent—Indicates whether this is a resent message.

• Priority—The priority of the message relative to others in the queue, as assigned by the InterSystems IRIS messaging engine. See Message Priority.

• TimeCreated—The message creation time stamp. See Invocation Style and Message Time Stamps.

• TimeProcessed—The message usage time stamp. InterSystems IRIS sets this field when the message is taken off of the queue but then resets it to the current time while the message is being processed. Typically, for a completed message, it represents the time that the message processing was completed.

• Status—Indicates the status of the message. See Message Status.

• IsError?—The value 1 means that the message encountered an error. The value 0 means the message did not encounter any errors.

• ErrorStatus—If IsError? is 1, then this is the text associated with the error. When IsError? is 0, ErrorStatus is the string “OK”.

• Banked—Indicates whether or not this message is part of a message bank.

The Body tab displays the message body information. Fields include:

• The message body class name above the list of fields.

• If the message body is a standard production message body object, a table displays the following information:

  • <ObjectId>—The object identifier for the message body. This field matches the MessageBodyId field in the Header tab.

  • The name and value of each property in the Message Type class.

  If the message body is any other type, there are no additional fields in the display.

The Contents tab displays formatted contents of the message body.

The standard production message body appears in colorized XML format, as shown in the following example:

A virtual document appears in segments, with one segment per line.

To view all the contents of large virtual document, it may be necessary to drag the bottom scroll bar far to the right. To view the message in a wider display, click the View Full Contents link or the View Raw Contents link. View Full Contents displays the message formatted by fields and View Raw Contents displays the unprocessed message contents, which can easily be copied and pasted into a text editor. For background information, see Using Virtual Documents in Productions.

Changing the Character Limit for XML Messages in the Contents Tab

When you select a message in the Messages page and then click the Contents tab, the Management Portal displays only the first 20000 characters of the message by default. This character limit prevents the Management Portal from becoming unresponsive while rendering very large messages such as batch files parsed with a record map. However, InterSystems IRIS enables you to modify the character limit by setting either of the following global nodes:

^EnsPortal.Settings("All","MessageContents","OutputSizeLimit")

^EnsPortal.Settings("All","MessageContents","OutputSizeLimit",<MessageBodyClassname>)

<MessageBodyClassname> is an optional node that specifies the class name of the message bodies to which the limit applies. If you set both nodes, the value in the <MessageBodyClassname> node is used.

You can set the nodes to a value of 0 or greater, where 0 indicates no limit and a positive value indicates the number of characters to display in the Contents tab. For example, to increase the character limit for the Contents tab to 30000 characters for the Demo.Loan.Msg.CreditRatingResponse sample message body class, you can issue the following command in the Terminal:

set ^EnsPortal.Settings("All","MessageContents","OutputSizeLimit","Demo.Loan.Msg.CreditRatingResponse") = 30000

The OutputSizeLimit nodes do not affect the behavior of the View Full Contents or View Raw Contents pages. If you click the View Full Contents or View Raw Contents links in the Contents tab for a message, InterSystems IRIS attempts to display the complete message. To set a character limit for either page, you can append &LIMITSIZE=limit to the page URL, where limit indicates the maximum number of characters to display. For example, to set the character limit for the View Raw Contents page to 30000, you might modify the URL, using the <baseURL> for your instance:

http://<baseURL>/csp/proddemo/EnsPortal.MessageContents.zen?HeaderClass=Ens.MessageHeader&HeaderID=3&RAW=1&LIMITSIZE=30000