Skip to main content
Top
Review meshIQ Products (G2.com)

Creating and Managing Attribute Filters

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

Beginning with version 12.1, the term viewlet has been changed to widget. Any references to viewlet in older versions of the documentation refer to widget in version 12.1 and later..

The Attribute filter feature allows you to narrow down the number of records in a widget to display more relevant results. Attribute filters can be valuable when searching for specific use cases, such as queues that get disabled, queues with more than 1000 messages, or objects that do not have specific settings (default persistence). Filters can be applied when creating or editing widgets. Users can specify multiple attributes for each filter. The workgroup server applies any active attribute filters to data before it is passed to the application server to be displayed in the browser.

Once you create an attribute filter for a particular technology and widget type, it becomes available for all widgets for that technology and type. For example, if an attribute filter is created for an IBM channel widget, it is available on other IBM channel widgets.

The Active Attribute Filtering checkbox turns attribute filtering on and off for the widget. Select the checkbox to enable attribute filtering. 

Whether attribute filtering is enabled or not, the specific attribute filters that you add will remain available for later use.

View Attribute Filters

You can access attribute filters using one of the following methods:

  • In the Create New Widget or Edit Widget dialog, click Manage attribute filters Green pencil button.png in the Active Attribute Filtering section.

  • In the widget header, click the icon next to the Attributes label.

  • Go to User Settings > Attribute Filters, and then select the required Product and Widget Type.

The Attribute Filters dialog opens. The Available Filters list displays all filters you previously created. Click on a filter to view that filter’s attributes within the content box on the right side of the dialog. 

Search for a Filter

You can search for a filter by entering part of its name in the Search (Filter by) field in the Attribute Filters dialog. The list is automatically filtered based on your entry.

Add Attribute Filters

You must have the Manage Private Attribute Filters right to add, edit, copy, or delete attribute filters.

  1. In the Attribute Filters dialog, click the Create new attribute filter Add buttin.png icon. To learn how to open the dialog, see View Attribute Filters.
  2. The Attribute Filter Management dialog opens. Enter a name for the filter in the Enter Filter Name field.
  3. Select one of the following option buttons:
    • Match All: Objects with all attributes specified by the user will be found.
    • Match At Least One: Objects with at least one of the attributes specified by the user will be found.
  4. Click the button to add one or more attributes to the new filter. The Available Attributes dialog appears.

  5. Select the checkbox of an attribute. Multiple attributes can be selected.

    There are two filter methods to help locate attributes more easily:

  • Filter by name: Use the Search (Attribute By) search box to search by attribute name. You can enter a partial name to match results.
  • Filter by category: Use the drop-down list to select the category of the attribute you are looking for. Categories are specific to the widget’s object type (for example, queue manager categories may include Cluster and Communication; channel categories may include Statistics and Monitoring).
  1. Click Add to return to the Attribute Filter Management dialog. The selected attributes will need to be configured. For each attribute, select an option from the Compare operation drop-down. (Options vary depending on the data type.)
    • For numeric data types, the available comparisons are: is equal, is less than, is greater than, is not equal, is empty, and is not empty.
    • For text data types, the comparisons are: is equal, is not equal, starts with, ends with, contains, does not contain, is blank, is not blank, and matches pattern.
    • For custom attributes, the available compare operations are: key exists, key does not exist, is equal, is not equal, starts with, ends with, contains, does not contain, and matches pattern.)
  2. Then specify a Value. An example is provided below. (To learn how to dynamically set attribute filter criteria using variable values, see Attribute filter variables.)
  3. To remove an attribute, simply click on the Remove button at the end of the attribute row. 
  4. Click Save after all attributes have been configured.
  5. The Attribute filters dialog box appears. The left side of the screen displays all created filters. Click on a filter to view that filter’s attributes within the content box on the right side of the dialog. 

If all attributes must be met, the text, Match ALL of the following, is displayed. 

If at least one attribute must be met, the text, Match at least ONE of the following, is displayed. This is specified when adding a new filter, but can be updated when configuring attributes. 

Sharing Attribute Filters

  • Any filters that you share display an upward-pointing arrow Shared up arrow.png shared icon in the Attribute Filters dialog. To view and use filters shared by others, turn on the Shared Filters slider. Filters shared by others display a downward-pointing arrow shared icon.
  • To share a filter with one or more groups, you must have both Manage Private Attribute Filters and Manage Shared Attribute Filters rights.
  • To Share a filter, click the Create new attribute filter Add buttin.png icon, the Attribute Filter Management dialog opens. Turn on the Share Filter slider. Use the three dots to open the menu showing groups available for filter sharing.
  • Click the eye icon next to the groups you want to share the filter with. The eye icon changes to green for selected groups.

Edit a Filter

In the Attribute Filters dialog, select the filter, and then click Edit to open the Attribute Filter Management dialog. You can add new attributes or modify existing ones. To delete an attribute, click Remove button.

Create a New Attribute Filter Based On an Existing Filter

Select the filter that you want to start with and click Copy button. The Attribute Filter Management dialog opens. You can modify the copied filter, assign it a new name, and click Save.

Delete a Filter

Select the attribute filter that you want to delete and click Delete delete button.png button. Click Yes, Delete to delete the selected attribute filter, or No, Keep to cancel.

Users who have the Manage Private Attribute Filters right can view and manage the filters they have created by going to the User Settings > Attribute Filters tab. Likewise, users with the Manage Global Attribute Filters right can manage global filters through the Application Settings > Attribute Filters tab. See Attribute Filter Tab for more information.

No Results Found

If no attribute values are retrieved, the widget displays No data to display.

_________________________________________________________________________________________________________________

Version 11.3 and Earlier

The Attribute filter feature allows you to narrow down the number of records in a viewlet to display more relevant results. Attribute filters can be valuable when searching for specific use cases, such as queues that get disabled, queues with more than 1000 messages, or objects that do not have specific settings (default persistence).  Filters can be applied when creating or editing viewlets. Users can specify multiple attributes for each filter. In versions 10.4.2 and earlier, attribute filters are applied to data that the workgroup server has already returned. In versions 10.5 and later, the workgroup server applies any active attribute filters to data before it is passed to the application server to be displayed in the browser.

Once you create an attribute filter for a particular product and viewlet type, it becomes available for all viewlets for that product and type. For example, if an attribute filter is created for an IBM channel viewlet, it is available on other IBM channel viewlets.

The Active attribute filtering checkbox (Attribute in 11.2 and later) turns attribute filtering on and off for the viewlet. Select the checkbox to enable attribute filtering. You can access attribute filters from the viewlet header by clicking the icon next to the Attributes label: AttrFltrMenu.png.

Whether attribute filtering is enabled or not, the specific attribute filters that you add will remain available for later use.

CreateViewletAttrFltr.png

Search for a Filter

You can search for a filter by entering part of its name in the Filter by field. The list is automatically filtered based on your entry.

AttrFltrFltr.png

Sharing Attribute Filters:

  • Any filters that you have shared have a green Shared Filter icon ShrdFltrIcon.png on the Attribute Filters dialog. You can view and use filters that others have shared by turning on the Shared Filters slider. Filters that others have shared have a red Shared FilterShrdFltrIconRed.png icon.
  • To share a filter with one or more groups, you must have both Manage Private Attribute Filters and Manage Shared Attribute Filters rights. Turn on the Share Filter slider for the filter in the Attribute Filter Management dialog. From the popup menu, click the eye icon next to the groups you want to share the filter with. The eye icon changes to greenGreenEye.png for selected groups.

Add Attribute Filters

You must have the Manage Private Attribute Filters right to add, edit, copy, or delete attribute filters.

  1. Click the add button AttrAddBt.png. The Attribute Filters dialog box opens. If you created any filters in the past, they are included in the Filter Name list.
    AttrFltrs.png
     
  1. Click Add. The Attribute filter management dialog box opens. Enter a name for the filter within the Filter name field.AttrFilterMgt.png
     
  2. Select one of the following option buttons:
    • Match All: Objects with all attributes specified by the user will be found.
    • Match At Least One: Objects with at least one of the attributes specified by the user will be found.
  3. Click Add to add one or more attributes to the new filter. The Available attributes window appears.  
  4. Click on an attribute to select it. Multiple attributes can be selected. The background color of a selected attribute will appear green.
    AttrAvail.png
    There are two filter methods to locate attributes more easily:
  • Filter by name: Use the Enter filter value search box to search by attribute name. You can enter part of the name.
  • Filter by category: Use the drop-down list to select the category for the attribute you are looking for. Categories are specific to the viewlet’s object type (for example, queue manager categories may include Cluster and Communication; channel categories may include Statistics and Monitoring).
  1. Click OK to return to the Attribute Filter Management dialog. The selected attributes will need to be configured. For each attribute, select an option from the Compare operation drop-down. (Options vary according to the data type. 
    • For numeric data types, the available comparisons are: is equal, is less than, is greater than, is not equal, is empty, and is not empty.
    • For text data types, the comparisons are: is equal, is not equal, starts with, ends with, contains, does not contain, is blank, is not blank, and matches pattern.
    • For custom attributes, the available compare operations are: key exists, key does not exist, is equal, is not equal, starts with, ends with, contains, does not contain, and matches pattern.)
  2. Then specify a Value. An example is provided below. (To learn how to dynamically set attribute filter criteria using variable values, see Attribute filter variables.) To remove an attribute, simply click on the red X at the end of the attribute row. 
  3. Click OK after all attributes have been configured.
    AttrFltrMgt.png
  4. The Attribute filters dialog box appears. The left side of the screen displays all created filters. Click on a filter to view that filter’s attributes within the content box on the right side of the screen. 

If all attributes must be met, the text, Match ALL of the following, is displayed. 

AttrFilterMatchAll.png

If at least one attribute must be met, the text, Match at least ONE of the following, is displayed.  This is specified when adding a new filter, but can be updated when configuring attributes. 

AttrFilterMatchOne.png

Edit a filter

Click Edit to open the Attribute Filter Management dialog, where you can add one or more new attributes, or modify or delete an existing attribute. Existing attributes can be deleted using the delete  button.

Create a new attribute filter based on an existing filter

Select the filter that you want to start with and click Copy As…. The Attribute Management dialog opens. You can modify the filter that you copied, give it a new name, and click OK.

Delete a filter

Select the attribute filter that you want to delete and click Delete. Click Yes to delete the selected attribute filter or No to cancel.

AttrDltConf_.png
 

Users who have the Manage Private Attribute Filters right can view and manage the filters they have created by going to the User Settings > Attribute Filters tab. Likewise, users with the Manage Global Attribute Filters right can manage global filters through the Global User Settings > Attribute Filters tab. See Attribute Filter Tab for more information.

No results found

If no attribute values are retrieved by the WGS, a warning symbol VwltWarn.png is displayed immediately next to the viewlet menu button. Click this button to view the error description.

AttrFltrNoResults.png

VwltAttrErrorDet.png

VwltAttrError.png

Click the blue Description button to view the error details.