Filtering Messages

Introduction

To filter the messages shown in the Message Viewer, use the following process:

1. Specify the filter options to use.

2. Click Search.

Alternatively, you can rerun a search from the search history and you can rerun a search that was previously saved.

In any case, the page then display the messages that match your filter criteria.

Above the list of messages, the Message Viewer page displays the number of messages found. It also displays the search criteria currently in use:

Criteria: SourceConfigName = Sample.FileOperation  and  Status = Completed 

This example consists of two search criteria, combined via the logical AND operator. This filter selects only messages that meet both criteria:

• The message was sent by the business host Sample.FileOperation

• The message status is Completed

The overall expression can also use the logical OR operator and can contain parentheses for grouping. Here is another example:

Criteria: SourceConfigName = Sample.FileOperation and (Banked = 1 or IsError = Ok)

This filter selects only messages that meet both of the following requirements:

• The message was sent by the business host Sample.FileOperation

• The Banked property equals 1, or the IsError property equals Ok (or both).

Using Filter Options

To filter the messages shown in the Message Viewer:

1. Optionally specify some or all of the following fields in upper area of the Message Viewer:

   • Type—Select a value from the drop-down list: Session Start, Request, Response, or All (the default).

   • Status—Select a value from the drop-down list. See Message Status.

   • Source—The business host that sent the message. Choose from the list.

   • Target—The business host that is the target of the message. Choose from the list.

   If you are using the Message Bank Viewer, there is an additional filter that restricts the search to a single Message Bank client. See Using the Enterprise Message Bank.

2. Optionally click the Extended Criteria button to see additional options.

3. Optionally filter by the time or message ID. To do so, specify values for the following options:

   • Start Time—Enter the earliest desired message creation time stamp. See Invocation Style and Message Time Stamps.

   • End Time—Enter the latest desired message creation time stamp.

   • Start Id—Enter the lowest desired message ID.

   • End Id—Enter the highest desired message ID.

4. Optionally add a more complex criterion. To do so, click Add Extended Criteria. The page then prompts you for details about the new criterion.

   Note that with more complex queries, this button appears in multiple locations within the query so that you can add criteria to different parts of the query.

5. Optionally add a group of criteria contained in parentheses. For example, suppose you want to add this:

   (Banked = 1 or IsError = Ok)
   

   

   In such cases, click Add Criteria Group. The page then displays a box representing the group and prompts you for details about the first criterion in that group. Specify those details and then click the Add Extended Criteria button within the group to add the next criterion, and so on.

   The criteria in a group are combined via logical AND by default. To change this, look for the AND/OR button to the left of the group. Initially, this button displays AND, which indicates the current logical operator. When you click the button, its label changes to OR, which indicates its new setting.

   This example criteria group was created in steps as follows:

   1. Click Add Criteria Group.

   2. As described generally in Adding a New Criterion, add the criterion Banked = 1.

   3. Click the Add Extended Criteria button within the group.

   4. Add the criterion IsError = Ok.

   5. Click the AND/OR button to the left of this group. The label on this button changes from AND (the initial state) to OR.

   The result looks like this:

   

6. Optionally disable a criterion by using the slider . You can also use the Delete button to delete the criterion if needed.

7. When you are satisfied with your selections, click Search.

   Or click Reset to restore the default criteria.

Adding a Criterion

Each time you add a criterion, InterSystems IRIS displays options like these:

Specify the following values:

• Criterion Type—Choose one of the following:

  • Header Field—This criterion is based on fields in a standard production message header object.

  • Body Property—This criterion is based on properties of a standard production message body object.

  • SearchTable Field—This criterion is based on entries in a search table class that you have defined in this namespace. A search table class is a specialized tool that you create to work with virtual documents.

  • VDoc Segment Field—This criterion is based on fields in a virtual document message segment. Identify the standard and the segment of interest. InterSystems IRIS then prompts you to choose from a list of fields in that segment.

  • VDoc Property Path—This criterion is based on fields in a virtual document message segment. Identify the standard and then enter a virtual property path that identifies a message segment and field that is valid for that standard.

  Note:

  For background information about the VDoc fields in the Extended Criteria interface, see Using Virtual Documents in Productions. You do not need to use these fields unless your production routes some type of virtual document.

• Class—Click a class name from the list. The choices are determined by Criterion Type.

• If section—The options depend on the previous choices:

  • If Criterion Type is Header Field, Body Property, or SearchTable Field, you use the If section to compare a specific field to a value.

    In this case, there are three options in the If section. The first option lets you select the property (or field), the second option lets you choose an operator, and the third option lets you type a comparison value. For example:

    

  • If Criterion Type is VDoc Segment Field, you use the If section to compare a virtual document segment field to a value.

    In this case, there are four options in the If section. The first option lets you select a segment type, the second lets you select a field name, the third option lets you choose an operator, and the fourth option lets you type a comparison value. For example:

    

• If Criterion Type is VDoc Property Path, you use the If section to compare a virtual document property path to a value. That is, the virtual property path is evaluated, and the value returned is compared to the value that you specify.

  In this case, there are four options in the If section. The options are similar to those for VDoc Segment Field.

Important:

When InterSystems IRIS indexes virtual documents (thus adding to the search tables), it replaces any vertical bar (|) with a plus sign (+). Take this into consideration when you use the search table to search for content. For example, to search for a message that contains my|string, use my+string as the search criterion.

Using the Search History

To rerun a previous search, click Search History. The system then displays a page listing the previous searches in descending order by when they were run. For each search, the page shows when the search was run, how long the search took (in seconds), and the SQL query that was used.

When you find the row showing the search that you want to rerun, click Search in that row.

Saving Search Criteria for Later Use

To save the current set of search criteria for later use:

1. Click the Extended Criteria button to display this section, if you are not yet viewing it.

2. Click Save as New Search.

   The system prompts you for a name.

3. Enter a name and click Save.

This option also saves any custom columns you added.

Using Saved Searches

To use a saved search:

1. Click Saved Searches.

   The system then displays a list of the saved searches.

2. Click the name of the search that you want to rerun.

   The system then updates the page to show the name of search, the criteria that it uses, and the results that it currently returns.

Renaming Saved Searches

To rename a saved search:

1. Click the Saved Searches button.

   The system then displays a list of the saved searches.

2. Click the More icon next to the search that you want to rename.

3. Click Rename.

   The system prompts you for a new name.

4. Enter a new name and click Save.

Deleting Saved Searches

To rename a saved search:

1. Click the Saved Searches button.

   The system then displays a list of the saved searches.

2. Click the More icon next to the search that you want to delete.

3. Click Delete.

   The system immediately deletes the search.

Searches and Large Sets of Data

When searching through an especially large message bank, it is possible that the search will time out before returning results. You can avoid this timeout by increasing the Server Response Timeout parameter of the Web Gateway. For more information, see Configuring Default Parameters. The default value of the parameter is 60 seconds.

See Also

• Viewing Messages

• Tracing the Path of Related Messages

• Managing Messages

• Using the Enterprise Message Viewer

• Concepts