Filtering is supported on the primary views that provide access to Files, Documents, Worksheet content, and User Activity. Options for filtering depend on the properties of the items being filtered. The following types of properties are filterable:

  • Text
  • Dates
  • Numbers
  • File Sizes
  • Single-valued choices in which the value of a field is a single selection from a list of no more than 50 possible values.
  • Multi-valued choices in which the value of a field may be a multiple selection from a list of no more than 50 possible values.

Filters on individual fields ("Field Filters") can be combined to produce the "Combined Filter" which then defines which items should be displayed in any given context.

There are two operating modes for setting up a combined filter:

  • in 'Basic' mode it supports up to ten filters on individual fields combined with an AND operation. This may include multiple filters on the same field.
  • in Advanced mode it supports up to ten sets of filters on individual fields combined with an AND operation. Internally the filters within each set are combined with an OR operation.

The options in the field filters depend on the data type being filtered but all filters provide two standard options:

  • Field filters can be inverted. This applies a NOT operation to the whole field filter such that it matches exactly those items that it did not match in its un-inverted form. Inverting filed filters provides a quick way to partition the data set into two parts and easily switch between them.
  • Field filters have an option to match blank values. This matches any items in the data set where there is no value set for the field being filtered. For text filters, an empty (zero length) text string is regarded as being not set.

Text filters

In addition to the standard options, text filters allow for one or more text strings to be specified. The filter matches any items for which any of the text strings in the filter match the text of the item. Text matching is not case sensitive. Once configured, checkboxes allow individual strings to be temporarily toggled in and out of the set that is matched.

Date filters

Date filters provide five possible clauses of which exactly one can be chosen in any particular filter. The options are:

  • Since last login. This matches any items where the field has a date more recent than the last time the user logged in to the system.
  • In the last n minutes, hours, days, months, weeks, or years, where n is an integer. This is relative to the current time.
  • Before a specific date
  • After a specific date
  • In the period between two specific dates.

When supplying dates for filters both the date and time can be specified. These are in local time. When no time is specified, matches are inclusive so events on the bounding date are matched by the filter. Opus2 Platform supports user-supplied dates both with and without times. When times are specified, timezones may also be specified but are not required. If no timezone is specified, dates with times are assumed to be in the timezone configured for the workspace.

If only a date is provided as a field value (with no time), and only a date is entered as a period bound then equal dates always match the filter independent of any local or workspace timezone settings.

Number filters

Number filters support matching numbers that are greater than a supplied value, less than a supplied value, or within a range between two supplied values. The bounds are inclusive.

File size filters

File size filters operate like number filters but with the addition of a size unit indicating bytes, kilobytes, megabytes or gigabytes. The base for file sizes is 1000 so 1 kilobyte is 1000 bytes and 1 megabyte is a million bytes.

Single valued choices

A single valued choice filter lists all the possible options with checkboxes against each. The filter matches items in which the field value matches one of the selected values.

Multiple valued choices

A multiple-valued choice provides two checkboxes for each item: one to include matching items; and one to exclude matching items. For example, if a field can take a set of values from the list "A", "B", "C", "D", "E", "F", then a filter set to include "A" and "B" but to exclude "C" and "D" will match any item that has "A" or "B" in the field value, as long as it doesn't also have "C" or "D". Hence, "A", "A,B", and "A,B,E" will match, but "A,C", "B,C,D" and "D,E" will not match. Items for which the value contains none of the options set to be included will not match. Thus "E", and "E,F" do not match.

Filter exclusions

The filtering capability is designed to provide a flexible way to rapidly narrow down a large set of results. Although it covers a wide range of cases, there are some clauses and types of query that cannot be expressed. In some cases further options are available through the search interface and the API. Specifically:

  • Text filtering is restricted to plain text substring matching. It does not support wildcards, proximity or other advanced features found in the search interface.
  • Clauses can only be combined one level deep. For field filters F_i, the advanced filter takes the form (F_a OR F_b OR ...) AND (F_p OR F_q ...) AND ... Clauses such as F_a AND (F_b OR (F_c AND F_d)) cannot be expressed directly although in some cases (such as this example) they can be restructured to fit into the advanced filter model.