1. Modeling
  2. Working with Data
  3. List Filter

The List Filter provides quick filtering for list-formatted line items on module and dashboard grids. It can also be used to create a cascading filter. Having reduced the number of items displayed by filtering the list on one line item, you can apply another filter to another line item, and so on, to filter to a fine degree of granularity.

Note: On dashboard grids, List Filters are replaced by Quick Filters. The List Filter option in context menus is replaced by Quick Filter options. Existing List Filters are not converted to Quick Filters. Existing List Filters are available from the Filter dialog.

This topic describes how list filter works and how to:

How List filter works

The List Filter menu option is based on the Filter function and is accessible from the context menu on a dashboard element. When a user selects List Filter and applies filtering criteria, a filter with the operator is equal to is created on the list tab in the Filter dialog.

In the Filter dialog, list filters are indistinguishable from filters applied earlier. For instance, filters applied by the administrator when building the dashboard. It’s not possible to identify whether a filter was created in the Filter dialog or via the List Filter menu option.

List Filter will only work if no other filter is applied to the line item. Any existing filters in the Filter function have the potential to impact the ability to apply a List Filter—users who aren’t aware of this could be frustrated by their inability to apply a second filter. Where an attempt is made to apply more than one filter, a message will display: Multiple filters applied to selection. Use filter dialog; and the Enable filter check box will be disabled.

Filter conflicts

Existing filters can impact on the ability to create a list filter. Where a conflict occurs, different messages will display depending on the context. These are the messages, with an explanation of the circumstance in which they will display:

• If you see the message Multiple filters applied to selection. Use filter dialog, you’re being advised to open the Filter dialog and see what other filters have been applied to this particular line item. It’s most likely you’re trying to add a list filter to a line item that already has a filter applied. Your options are to delete the original filter (in the Filter dialog) or to abandon the list filter.

• The message Adding list filter would exclude all items. Use filter dialog, is warning that applying a second filter to the grid would result in all items being filtered out of the grid, leaving it blank. You must open the Filter dialog and decide which filter you want to retain.

• A less likely scenario is one where a line item has had a filter applied to it and has then been converted to another Type, which is not a list-formatted line item. The message, Existing filter condition is not valid. Use filter dialog, is alerting you to the fact that the original filter criteria is no longer valid—list filters can only be applied to list-formatted line items. You can resolve this situation by selecting Reset default view from the View > Manage Views menu option on the grid.

• All items in the filter dialog can be made active or inactive using the Enable filter check box. If a filter is disabled and you attempt to apply another list filter, this message, Another filter exists which is not active. Use filter dialog, will display. You must open the Filter dialog and decide which filter you want to enable/apply.

Create a List filter

When a single row or column of list-formatted line items is selected, List Filter can be accessed from the context menu (like the Filter option, it’s not available on the blue-dot menu).

The dropdown displays all the items in the list to select filter criteria.

List filter works with nested columns or rows, using the nested dimensions as part of the filter.

If as an administrator, you want to prevent user access to dashboard filter functions, you can disable access to all filter options in the Dashboard Designer’s Menu Options section (Data–Filter).

The List filter dialog

The title of the List Filter dialog includes the name of the selected list-formatted line item. Items are displayed in the order in which they were selected.

The dialog displays options to:

  • choose filter criteria from the items in the dropdown.
  • remove filter criteria by clicking the x next to the line item name.
  • find items by entering characters into the dialog. Line items matching the characters entered will display. Click an item name to select it as filter criteria.
  • toggle the Enable filter checkbox to turn the filter on and off, leaving the filter criteria in place, to use again, rather than deleting it.

If multiple rows or columns are highlighted (whether sequentially or randomly) and List Filter is selected, only list items for the first row/column will be displayed. The other selected rows and columns will be ignored.

Clear List Filter

To remove an individual list filter: highlight the row or column to which the filter is applied and, from the context menu, select List Filter. Either: click the x alongside the filter criteria name to remove it; or deselect the Enable filter option to leave the filter criteria in place to re-enable at a later date.

To remove all the list filters applied to a grid, either:

  • select the entire grid, or
  • highlight one of the rows or columns with a list filter applied, and from the context menu select Clear All List Filters.