Operators

You can use operators to specify the types of Visual Query condition to constrain with a rule. If you do not specify an operator, the rule applies to all valid operations.

STARTS_WITH

For example, "Starts with: Fred" matches Fred, Frederick, or Freddie.

Supported logical types:

SINGLE_LINE_STRING
SUGGESTED_FROM
SELECTED_FROM

Note: The server places a limit on the length of the strings that this operator considers. By default, the limit is 256 characters.

For example:

<!-- Allow 'Person' searches to include conditions for 'First (Given) Name' that start with a given value -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER4" Operators="STARTS_WITH"/>

ENDS_WITH

For example, "Ends with: Fred" matches Fred, Wilfred, or Alfred.

Supported logical types:

SINGLE_LINE_STRING
SUGGESTED_FROM
SELECTED_FROM

Note: The server places a limit on the length of the strings that this operator considers. By default, the limit is 256 characters.

For example:

<!-- Allow 'Person' searches to include conditions for 'First (Given) Name' that end with a given value -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER4" Operators="ENDS_WITH"/>

CONTAINS

For example, "Contains: Fred" matches any of the above terms, and also matches Alfredo.

Supported logical types:

SINGLE_LINE_STRING
SUGGESTED_FROM
SELECTED_FROM

For example:

<!-- Allow 'Person' searches to include conditions for 'First (Given) Name' that contain a given value -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER4" Operators="CONTAINS"/>

WILDCARD_PATTERN

An exact match for a specified term that includes wildcard characters. For example, "Wildcard pattern: Fr?d" matches Fred, but not Alfredo.

Supported logical types:

SINGLE_LINE_STRING
SUGGESTED_FROM
SELECTED_FROM

For example:

<!-- Allow 'Person' searches to include conditions for 'First (Given) Name' that match a wildcard pattern -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER4" Operators="WILDCARD_PATTERN"/>

NOT_WILDCARD_PATTERN

A match for anything except for a specified term that includes wildcard characters. For example, "Not wildcard pattern: Fr?d" matches anything apart from Fr?d.

Supported logical types:

SINGLE_LINE_STRING
SUGGESTED_FROM
SELECTED_FROM

For example:

<!-- Allow 'Person' searches to include conditions for 'First (Given) Name' that do not match a wildcard pattern -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER4" Operators="NOT_WILDCARD_PATTERN"/>

EQUAL_TO

An exact match for the specified term.

Supported logical types:

BOOLEAN
DECIMAL
DATE
DATE_AND_TIME
DOUBLE
INTEGER
TIME
SINGLE_LINE_STRING
SUGGESTED_FROM
SELECTED_FROM

Note: The server places a limit on the length of the strings that this operator considers. By default, the limit is 256 characters.

For example:

<!-- Allow 'Person' searches to include conditions for  'Date of birth' and 'Gender' that match an exact value -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER9, PER15" Operators="EQUAL_TO"/>

NOT_EQUAL_TO

Exact matches for the specified term are excluded. For example, "Not equal to: Fred" matches anything apart from Fred.

Supported logical types:

BOOLEAN
DECIMAL
DATE
DATE_AND_TIME
DOUBLE
INTEGER
TIME
SINGLE_LINE_STRING
SUGGESTED_FROM
SELECTED_FROM

Note: The server places a limit on the length of the strings that this operator considers. By default, the limit is 256 characters.

For example:

<!-- Allow 'Person' searches to include conditions for 'Date of birth' that do not match an exact value -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER9" Operators="NOT_EQUAL_TO"/>

GREATER_THAN

Matches values that are greater than a set value.

Supported logical types:

DECIMAL
DATE
DATE_AND_TIME
DOUBLE
INTEGER
TIME

For example:

<!-- Allow 'Person' searches to include conditions for 'Date of birth' that are greater than a specified value -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER9" Operators="GREATER_THAN"/>

GREATER_THAN_OR_EQUAL_TO

Matches values that are greater than or equal to a set value.

Supported logical types:

DECIMAL
DATE
DATE_AND_TIME
DOUBLE
INTEGER
TIME

For example:

<!-- Allow 'Person' searches to include conditions for 'Date of birth' that are greater than or equal to a specified value -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER9" Operators="GREATER_THAN_OR_EQUAL_TO"/>

LESS_THAN

Matches values that are less than a set value.

Supported logical types:

DECIMAL
DATE
DATE_AND_TIME
DOUBLE
INTEGER
TIME

For example:

<!-- Allow 'Person' searches to include conditions for 'Date of birth' that are less than a specified value -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER9, PER15" Operators="LESS_THAN"/>

LESS_THAN_OR_EQUAL_TO

Matches values that are less than or equal to a set value.

Supported logical types:

DECIMAL
DATE
DATE_AND_TIME
DOUBLE
INTEGER
TIME

For example:

<!-- Allow 'Person' searches to include conditions for 'Date of birth' that are less than or equal to a specified value -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER9" Operators="LESS_THAN_OR_EQUAL_TO"/>

BETWEEN

Matches values that are within a set range.

Supported logical types:

DECIMAL
DATE
DATE_AND_TIME
DOUBLE
INTEGER
TIME

For example:

<!-- Allow 'Person' searches to include conditions for 'Date of birth' that match a range of values -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER9" Operators="BETWEEN"/>

IS_SET

Matches properties with any populated value.

Supported logical types:

BOOLEAN
DECIMAL
DATE
DATE_AND_TIME
DOUBLE
INTEGER
TIME
SINGLE_LINE_STRING
SUGGESTED_FROM
SELECTED_FROM

For example:

<!-- Allow 'Person' searches to include searches for 'Date of birth' values that have been entered -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER9" Operators="IS_SET"/>

IS_NOT_SET

Matches properties without a value entered.

Supported logical types:

BOOLEAN
DECIMAL
DATE
DATE_AND_TIME
DOUBLE
INTEGER
TIME
SINGLE_LINE_STRING
SUGGESTED_FROM
SELECTED_FROM

For example:

<!-- Allow 'Person' searches to include searches for 'Date of birth' values  
that have not been entered -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER9" Operators="IS_NOT_SET"/>