Some of the content described in this article is available in meshIQ Manage versions 12.1 and later.
For a quick overview of what's new or changed, visit the meshIQ Highlights page for a version-by-version breakdown.  

Jump to Section:
Version 12.x and Later
Version 11.3 and Earlier

Version 12.x and Later

Your queues handle thousands of messages. To make managing messages easier, you can create and apply a message criteria configuration to filter messages in widgets across your management system.

When a message criteria configuration is applied, all message actions (browsing, copying, moving, rerouting, and deleting) are filtered based on the configuration. For mass actions such as Copy All, Move All, and Delete All, you can choose which message criteria configuration to apply. Message criteria that are applied to a widget also impact the Put New action and can be applied to messages loaded through the Load from File option.

See Locating a message across all queues for an example of when a message criteria configuration is used.

View Existing Message Criteria Configurations

1. Click the Settings button in the top-right toolbar to open the Settings window.
   
2. In User Settings, go to the Message Commands tab, then under Message Criteria Settings, click Configure to open the Message Criteria dialog.

   • At the User Settings level, the list shows message criteria records created by you (the current user).
     To add, edit, or delete these records, you must have the Manage Private Message Criteria security right. Shared records cannot be edited.

   • At the Initial Settings level, the list shows only global message criteria records.
     Modifying these records requires the Manage Global Message Criteria security right and is typically restricted to administrators.
     

3. All existing message criteria configurations appear under Criteria Name. 
   If you are accessing the Message Criteria dialog when editing a widget, you can view shared records by turning on the Shared Criteria slider.
4. To view configuration details, click the buttons on the right side of the corresponding Criteria Name.
   

Create New Message Criteria Configurations

Example 1: Search for Messages by Text Data

In this example, we will search for a message by looking for the text data that is within the message text.

1. Follow steps 1-3 in the view existing message criteria configuration section immediately above.
2. Click New button. A new blank row appears in the list.
3. Enter a name for the configuration in the red-outlined field.
   
4. Click the Data button on the right side of the corresponding Criteria Name. The Message Data Criteria dialog appears.
5. Enter the desired data:
   
6. Click Save on the Message Data Criteria dialog. 
7. In the Message Criteria dialog, verify that the new criteria record is selected, then click Save.

8. You can also select a message criteria record using either of the following methods:

   • Option 1:
     Click Show Filters at the top right of the widget to display the filter row.
     In the Message column of the filter row, click the vertical dotted icon next to the filter field.
     The Message Criteria dialog opens.
     

   • Option 2:
     Go to the widget menu and click Edit Widget.
     In the Edit Widget dialog, click the Manage message criteria button next to the Message Criteria field.
     The Message Criteria dialog opens.

9. In the Edit Widget dialog, ensure the Find Messages checkbox is selected.
10. Click Update. The widget data is refreshed and now displays only messages matching the selected criteria.
11. Click the cell in the widget that contains the message count (for example, Current Depth or Pending Message Count).
12. The Console panel displays the search results. Open a message to view its detailed data.
    
13. Use the Active Filter in the Console tab to change or refine filters at the queue level.
    
    See Message Criteria Configurations for descriptions of the buttons on the Message Criteria dialog. 

Example 2: Search for Messages by Put Date

In this example, we will search for a message according to the date it was put on the queue.

1. Follow steps 1-3 in the view existing message criteria configuration section above.
2. Click New button. A new blank row appears in the list.
3. Enter a name for the configuration in the red-outlined field.
   
4. Click the MD button on the right side of the corresponding Criteria Name. The Message Descriptor Properties dialog opens.
5. Enter the desired date in the Put Date field.
   
6. Click Save on the Message Descriptor Properties dialog. 
7. In the Message Criteria dialog, verify that the new criteria record is selected, then click Save.

8. You can also select a message criteria record using either of the following methods:

   • Option 1:
     Click Show Filters at the top right of the widget to display the filter row.
     In the Message column of the filter row, click the vertical dotted icon next to the filter field.
     The Message Criteria dialog opens.
     

   • Option 2:
     Go to the widget menu and click Edit Widget.
     In the Edit Widget dialog, click the Manage message criteria button next to the Message Criteria field.
     The Message Criteria dialog opens.

9. In the Edit Widget dialog, ensure the Find Messages checkbox is selected.
10. Click Update. The widget data is refreshed and now displays only messages matching the selected criteria.
11. Click the cell in the widget that contains the message count (for example, Current Depth or Pending Message Count).
12. The Console panel displays messages that meet the selected criteria.
    
13. Open a message to view its detailed data.
14. Use the Active Filter in the Console tab to change or refine filters at the queue level.
    

Example 3: Search for Messages by Properties

To use this search method, the messages that you are searching for must contain the properties that you are searching for. These properties are in the form of name-value pairs. 

1. Follow steps 1-3 in the view existing message criteria configuration section above.
2. Click New button. A new blank row appears in the list.
3. Enter a name for the configuration in the red-outlined field.
   
4. Click the Properties button on the right side of the corresponding Criteria Name. The Message Properties Criteria dialog opens.
5. Click the Add button. Columns for Name and Value will appear. Enter the name of the property and its corresponding value.
   
6. (Optional) To add more name-value pairs, click Add again and repeat the previous step.
7. Click Save on the Message Properties Criteria dialog. 
8. In the Message Criteria dialog, verify that the new criteria record is selected, then click Save.

9. You can also select a message criteria record using either of the following methods:

   1. Option 1:
      Click Show Filters at the top right of the widget to display the filter row.
      In the Message column of the filter row, click the vertical dotted icon next to the filter field.
      The Message Criteria dialog opens.
      

   2. Option 2:
      Go to the widget menu and click Edit Widget.
      In the Edit Widget dialog, click the Manage message criteria button next to the Message Criteria field.
      The Message Criteria dialog opens.

10. In the Edit Widget dialog, ensure the Find Messages checkbox is selected.
11. Click Update. The widget data is refreshed and now displays only messages matching the selected criteria.
12. Click the cell in the widget that contains the message count (for example, Current Depth or Pending Message Count).
13. The Console panel displays the search results, listing messages that contain the specified name-value pair(s).
    
14. Open a message to view its detailed data.
15. Use the Active Filter in the Console tab to change or refine filters at the queue level.
    

Delete Message Criteria Configurations

1. Open the Message Criteria dialog. You can access it either from the Edit Widget dialog by clicking the Manage message criteria button, or from User Settings > Message Commands by clicking Configure.

2. Click the Delete button next to the configuration you want to delete.

There is no delete confirmation.

Share Message Criteria Configurations

To share criteria records with groups, you must have both the Manage Private Message Criteria and the Manage Shared Message Criteria security rights.

To share any record with one or more groups:

1. Open the Message Criteria dialog. You can access it either from the Edit Widget dialog by clicking the Manage message criteria button, or from User Settings > Message Commands by clicking Configure.

2. Click the Shared button displayed in front of the record name.

3. In the popup menu, click the eye icon next to the groups you want to share the message criteria with.
   – The eye icon turns green for selected groups.
   – You can use the Filter By field to search for specific groups.
   

Apply a Message Criteria Configuration

Perform the steps below to apply a message criteria configuration. When a message criteria configuration is applied, all message actions (browsing, copying, moving, rerouting, and deleting) are filtered based on the configuration.

1. Click the Settings button in the top-right toolbar to open the Settings window.
2. In User Settings, on the Message Commands tab, select the Message Criteria from the drop-down list, and then click Save Changes.
   
3. A Success message appears, indicating that the selected message criteria configuration is now applied. It remains in effect until you change it.

Remove Message Criteria Configuration

If you no longer want your messages filtered, you can remove the filter configuration. 

1. Click the Settings button in the top-right toolbar to open the Settings window.
2. In User Settings, on the Message Commands tab, click the X next to the selected criteria record in the Message Criteria list.
   
3. Click Save Changes. Messages will no longer be filtered.

_________________________________________________________________________________________________________________

Version 11.3 and Earlier

Your queues handle thousands of messages. To make managing messages easier, you can create and apply a message criteria configuration to filter messages in viewlets across your management system.

When a message criteria configuration is applied, all message actions (browsing, copying, moving, rerouting, and deleting) are filtered based on the configuration. For mass actions such as Copy All, Move All, and Delete All, you can choose which message criteria configuration to apply. Message criteria that are applied to a viewlet also impact the Put New action and can be applied to messages loaded through the Load from File option.

See Locating a message across all queues for an example of when a message criteria configuration is used.

View existing message criteria configurations

1. Click the Settings button located in the toolbar to open the Settings window.
   
   At the User Settings level, the Message Criteria list includes the message criteria records that you (the current user) have created. To add, edit, and delete criteria records, you must have the Manage Private Message Criteria security right.
   At the Global Settings level, the Message Criteria list includes global message criteria records only. To add, edit, and delete global criteria records, you must have the Manage Global Message Criteria security right.
2. On the Message Commands tab, under Message Criteria Settings, click Configure to open the Message Criteria window.
   
3. All existing message criteria configurations are listed below Name. (If you are accessing the Message Criteria dialog when editing a viewlet, you can view shared records by turning on the Shared Criteria slider.)
4. Click the buttons on the top right to view details of the configuration.

Create new message criteria configurations

Example 1: Search for messages by text data

In this example, we will search for a message by looking for the account number that is within the message text.

1. Follow steps 1-3 in the section immediately above.
2. Click New (the first button). A new blank row appears in the list.
3. Double-click the row to enter a name for the configuration. 
   
4. Click on the new configuration to select it (the row appears dark grey).
5. Click the Message Data Criteria button on the top right to specify the data to look for.
6. Enter the data:
    
7. Click Save on the Message Data Criteria dialog. 
8. Verify that the Account criteria record is selected on the Message Criteria dialog and click Save.
9. On the Edit Viewlet dialog, make sure that the Find Messages checkbox is selected, and that the "Account" message criteria record is displayed in the Search Criteria box.
10. Click Apply Changes. Viewlet data is refreshed.  
11. Click the cell in the viewlet that contains the message count (for example, Current Depth or Pending Message Count).
12. The Console panel displays the search results.  Open the message to view its data:
    

See Filter Configurations for descriptions of the buttons on the Message Criteria dialog. 

Example 2: Search for messages by put date

In this example, we will search for a message according to the date it was put on the queue.

1. Follow steps 1-3 in the section above.
2. Click New (the first button). A new blank row appears in the list.
3. Double-click the row to enter a name for the configuration. 
4. Click on the new configuration to select it (the row appears dark grey).
   
5. Click the Message Descriptor Properties button on the top right to specify the data to look for.
6. Enter the data:
   
7. Click Save on the Message Descriptor Properties dialog. 
8. Verify that the Date criteria record is selected on the Message Criteria dialog and click Save.
9. On the Edit Viewlet dialog, make sure that the Find Messages checkbox is selected, and that the "Date" message criteria record is displayed in the Search Criteria box.
10. Click Apply Changes. Viewlet data is refreshed.  
11. Click the cell in the viewlet that contains the message count (for example, Current Depth or Pending Message Count).
12. The Console panel displays the search results.  Messages that meet the criteria are listed.
    

Example 3: Search for messages by properties

To use this search method, the messages that you are searching for must contain the properties that you are searching for.  These properties are in the form of name-value pairs. 

1. Follow steps 1-3 in the section above.
2. Click New (the first button). A new blank row appears in the list.
3. Double-click the row to enter a name for the configuration. 
4. Click on the new configuration to select it (the row appears dark grey).
5. Click the Properties button on the top right to specify the name-value pair to look for.
   
6. Click Add to add a property.
7. Enter the Name of the property and its Value. 
8. (Optional.) Add more name-value pair criteria records by clicking Add and repeating the previous step.
9. Click Save on the Message Properties Criteria dialog. 
10. Verify that the criteria record you just created is selected on the Message Criteria dialog and click Save.
11. On the Edit Viewlet dialog, make sure that the Find Messages checkbox is selected, and that your new message criteria record is displayed in the Search Criteria box.
12. Click Apply Changes. Viewlet data is refreshed.  
13. Click the cell in the viewlet that contains the message count (for example, Current Depth or Pending Message Count).
14. The Console panel displays the search results.  Messages that contain the name-value pair (or pairs) that you specified are listed.

Delete message criteria configurations

1. Open the Message Criteria dialog.  The Message Criteria dialog can be accessed from the Edit Queue Viewlet Queue tab or from the User Settings Message Commands tab Configure button.
2. Click the configuration that you want to delete (the row appears dark grey).
3. Click . There is no delete confirmation.

Share message criteria configurations

To share criteria records with groups, you must have both the Manage Private Message Criteria and the Manage Shared Message Criteria security rights.

To share any record with one or more groups:

1. Double-click its name. The  Private icon is displayed in front of the name of the record. 
2. Click the Private icon to share the record.  The icon changes to a Shared  icon.
3. From the popup menu, click the eye icon next to the groups you want to share the dashboard with. The eye icon changes to green for selected groups.
   

Apply a message criteria configuration

Perform the steps below to apply a message criteria configuration. When a message criteria configuration is applied, all message actions (browsing, copying, moving, rerouting, and deleting) are filtered based on the configuration.

1. Click the Settings button in the toolbar.
2. On the Message Commands tab, select a configuration from the Message Criteria list.
   
3. The selected message criteria configuration is now applied. It remains in effect until you change it.

Remove message criteria configuration

If you no longer want your messages filtered, you can remove the filter configuration. 

1. On the Message Commands tab of the Settings window, click the X next to the selected criteria record on the Message Criteria list.
   
2. Click Save Changes. Messages will no longer be filtered.