Message Queue Criteria Configuration dialog box


Configuration details

To access this dialog box, right-click the monitored message queue name and select KM Commands > Configure Search Criteria. This dialog box contains the following items:

Item

Description

Add

Click to open the message queue criteria configuration dialog box. Use this dialog box to define new message queue search criteria.

Modify

Select a configured search criteria and click Modify to edit the configuration details.

Remove

Select a configured search criteria and click Remove to delete the configuration details.

Apply

Click to apply the configuration.

Close

Click to close the dialog box.

Screenshot of the Message Queue Criteria Configuration dialog box

message_queue_search_add_PSL.png

Message Queue Criteria Configuration details 

Item

Description

Search Criteria Name

Enter a unique name to be used for the search criteria. This field is required and can be a maximum of 28 characters. You must enter a name with no slashes, semicolons, or colons. Embedded blank spaces will be replaced with underscores.

Include Message IDs

Enter the message IDs to search. By default all message IDs are included in the search.

You can also use regular expressions to search for multiple matching instances.

Exclude Message IDs

Enter the message IDs to exclude from the search.

You can also use regular expressions to search for multiple matching instances.

Minimum Severity

Enter the minimum severity of the selected messages.

Text

Select whether to include or exclude the text search results.

Text to Search

Enter a text string to search for in the message queue. The search text can be part of a word, an entire word, or a phrase.

You can also use regular expressions to search for multiple matching instances.

Message File and Library

Select whether to include or exclude search results if they match the Message File and Library criteria.

Message File Name

Enter the message file names to include or exclude from the search. By default all the message files are included in the search.

You can also use regular expressions to search for multiple matching instances.

Message File Library

Enter message file library names to include or exclude from the search. By default all the libraries are included in the search.

You can also use regular expressions to search for multiple matching instances.

Job and User

Select whether to include or exclude the search results if they match the Job Name and User Name criteria.

Job Name

Enter the job names to include or exclude from the search. By default all the job names are included in the search.

You can also use regular expressions to search for multiple matching instances.

User Name

Enter the name of the user associated with the job. By default all the user names are included in the search.

You can also use regular expressions to search for multiple matching instances.

Message Type

Specify the message types to search. You can select or clear individual message types. By default, all the message types are selected.

  • *INFO - A message that provides general non error-related information.
  • *INQ - A message that conveys information but also asks for a reply.
  • *RQS - A message that contains a command for processing by a request processor, such as command entry.
  • *COMP - A message that conveys completion status of work.
  • *DIAG - A message that indicates errors in a system function, errors in an application, or errors in input data.
  • *NOTIFY - A message that describes a condition for which a program requires corrective action or a reply.
  • *ESCAPE - A message that describes a condition for which a program must end abnormally.
  • *RPY - A message that is a response to a received inquiry or notify message.
  • *COPY - A copy of an inquiry or notify message that is kept in the sender's message queue.

Auto reply to message

Select the checkbox to indicate whether a reply should be sent automatically for messages that satisfy the selection criteria and that require a reply.

Reply using text below

Indicates what reply is sent automatically for messages that satisfy the selection criteria and that require a reply.

Compose a reply to send instead of the default reply. The default reply is Hello.

OS command or CL program

Enter the OS command or CL program to be invoked on the remote iSeries host when an auto reply is generated.

Maximum Auto replies

Enter the maximum number of consecutive replies automatically sent by PATROL. If there is no limit, leave this field blank.

Reset Auto reply counter after (seconds)

Enter the time, in seconds, that should cause the counter associated with Maximum Autoreplies to get reset. The counter is reset if the time elapsed in between consecutive matching messages needing a reply exceeds the specified number of seconds. By default, this value is set to 60 seconds.

Auto reply wait time (seconds)

Enter the time, in seconds, after which an auto reply should be sent. By default, this value is set to 0 seconds.

Trigger an event

Select this option to instruct PATROL to trigger an event when the message is matched or the maximum number of auto replies are sent.

When Maximum Auto Reply is reached

Select this option to trigger an event when the maximum number of auto replies are sent.

Note: This option should be selected only when Auto Reply is configured.

When matched messages are atleast

Select this option to trigger an event when matched messages are greater than or equal to the value specified in Matched message count.

Matched message count

Enter a value in the field to instruct PATROL to execute the event triggering actions specified when the number of matching message(s) is greater than or equal to the entered value.

Reset matched message count after

Enter the time, in seconds, that should cause the number of matching messages counter to get reset. The counter is reset if the time elapsed in between consecutive matching messages exceeds the specified number of seconds.

Select the Event Class

If you want to send an event to the PATROL Event Manager, select the event class for which to send the event. The available event classes are:

  • AKN_MSGQ_INFO
  • AKN_MSGQ_WARN
  • AKN_MSGQ_ALARM
  • Other

Event Catalog: If you have selected other option in the Event class field, specify the custom event catalog name.

Event Class: If you have selected other option in the Event class field, specify the custom event class name.

Select Event Data

If you want to send an event to the PATROL Event Manager, select the event data to include. When an Event Class and Event Data are specified for a message selection entry, the event data is passed to the event manager as a single argument. Within the argument, each selected piece of event data is included in the order specified below with each field separated from the next. by a tab. For example, when Message Id and Message Type are specified, description of the event appears as follows:
Id\t\tType

The following event data are available for selection:

  • Message Id
  • Message Key
  • Message Type
  • Severity
  • Keyword
  • Full Message Text
  • Sending Job Id
  • Sending Program
  • Message Parameter Data
  • Message File/Library
  • Append Auto reply (if sent)
  • Specified below - Specify the custom message that should included in the event data.

Apply

Click this option for confirming the configuration information that you provided and adding the message queue to the list of configured message queues.

Close

Click to close the dialog box.

Screenshot of the Message Queue Criteria Configuration dialog box

heading.png

message_queue_search_PSL.png

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*