Instance Filters

Class instance filters define which data are shown in various class instance lists. Class instance filters are also used in certain class functions to define which data will be processed. Each filter contains one or more rules that are applied to class fields in order to determine which instances should pass the filter and should be displayed in an instance list or processed by a function.

A filter is expressed as a table with the following fields:

Name

Type

Description

Logical Operation

Integer

Available options are AND and OR. If AND is selected, both this rule and previous rules must be true. If OR is selected, either this rule or previous rules must be true. Logical operation is not available for the first rule in a rule set.

  • 0 - First record has no logical operation since it will be processed regardless of subsequent rules.

  • 1 - represents the AND value.

  • 2 - represents the OR value.

Type

Integer

Condition or Nested Conditions. If Condition is selected, the rule is processed according to Column, Operation and Value defined in it. If Nested Conditions is selected, result of the rule equals to the aggregated result of a nested rule set defined by Nested Conditions table.

  • 0 - represents the Condition value.

  • 1 - represents the Nested Condition value.

Column

String

Defines which class field or database column is checked by the rule. Must be the name of a column which exists in the class being filtered.

Operation

String

Defines which operation is applied for checking column value, e.g. Is Null or Greater Than. Available operations are dependent on column type, and are listed below.

Value

String

Expression which must evaluate to an appropriate values against which the column values will be checked. Some operations ignore this value.

Nested Conditions

Data Table

Defines rules of a sub-filter. The nested filter is a table with the same fields as a top-level filter rules table. Level of nesting is not limited.

Possible Operation Values

Operation

Column Type

Notes

IS_NULL

Any

True if Column value is NULL and ignores the Value.

IS_NOT_NULL

Any

True if Column value is not NULL and ignores the Value.

CONTAINS

String

True if Value is contained in Column value.

IN

Numerical, String, Date

True if the Column value is equal to Value or is equal to one or more strings in the Value list.

A Value list is expressed as a string, with list elements separated by the comma , character. If the comma , character must appear as a literal in Value or in an element of the Value list, it must be escaped by the backslash \ character.

  • If Value is the string "a,1,2001-07-04T12:08:56Z", the Value list will be a, 1, and 2001-07-04T12:08:56Z. Each element is compared against the Column value. The condition will be True if the Column value is equal to any of the values in the Value list.

  • If one or more items from the list generated from the Value string must contain a comma, they must be escaped like so: "James\, Avery Taylor,Phuong\, Casey Nguyen". This will result in a list with elements James, Avery Taylor and Phuong, Casey Nguyen to be compared against the Column values.

DOES_NOT_CONTAIN

String

True if Value is not contained in Column value or Column value is NULL.

BEGINS_WITH

String

True if Column value starts with Value.

DOES_NOT_BEGIN_WITH

String

True if Column value does not starts with Value or Column value is NULL.

ENDS_WITH

String

True if Column value ends with Value.

DOES_NOT_END_WITH

String

True if Column value does not end with Value or Column value is NULL.

EQUALS

Numerical, String, Boolean

True if Column value equals Value.

DOES_NOT_EQUAL

Numerical, String, Boolean

True if Column value does not equal Value.

IS_GREATER_THAN

Numerical, Date

True if Column value is greater than Value.

IS_GREATER_OR_EQUAL_THAN

Numerical, Date

True if Column value is greater than or equal to Value.

IS_LESS_THAN

Numerical, Date

True if Column value is less than Value.

IS_LESS_OR_EQUAL_THAN

Numerical, Date

True if Column value is less than or equal to Value.

ON

Date

True if Column date is equal to Value date.

ON_OR_AFTER

Date

True if Column date is the same or later than the Value date.

ON_OR_BEFORE

Date

True if Column date is the same or earlier than the Value date.

LAST_HOUR

Date

True if Column hour is equal to the current hour minus one.

THIS_HOUR

Date

True if Column hour is equal to the current hour.

NEXT_HOUR

Date

True if Column hour is equal to the current hour plus one.

YESTERDAY

Date

True if Column date is equal to yesterday’s date.

TODAY

Date

True if Column date is equal to today’s date.

TOMORROW

Date

True if Column date is equal to tomorrow’s date.

LAST_WEEK

Date

True if Column week is equal this week of year minus one.

THIS_WEEK

Date

True if Column week is equal this week of year.

NEXT_WEEK

Date

True if Column week is equal this week of year plus one.

LAST_MONTH

Date

True if Column month is equal the current month minus one.

THIS_MONTH

Date

True if Column month is equal the current month.

NEXT_MONTH

Date

True if Column month is equal the current month plus one.

LAST_YEAR

Date

True if Column year is equal the current year minus one.

THIS_YEAR

Date

True if Column year is equal the current year.

NEXT_YEAR

Date

True if Column year is equal the current year plus one.

LAST_X_HOURS

Date

True if Column hour is between the current hour and the current hour minus value.

NEXT_X_HOURS

Date

True if Column hour is between the current hour and the current hour plus value.

LAST_X_DAYS

Date

True if Column day is between the current day and the current day minus value.

NEXT_X_DAYS

Date

True if Column day is between the current day and the current day plus value.

LAST_X_WEEKS

Date

True if Column week is between the current week and the current week minus value.

NEXT_X_WEEKS

Date

True if Column week is between the current week and the current week plus value.

LAST_X_MONTHS

Date

True if Column month is between the current month and the current month minus value.

NEXT_X_MONTHS

Date

True if Column month is between the current month and the current month plus value.

LAST_X_YEARS

Date

True if Column year is between the current year and the current year minus value.

NEXT_X_YEARS

Date

True if Column year is between the current year and the current year plus value.

Was this page helpful?