Operators

You can use operators to specify the types of visual query condition to restrict. If you do not specify an operator, the restriction applies to all valid operations.

STARTS_WITH
Applies an implicit asterisk to the end of the condition. For example, Starts with: Fred is equivalent to 'Fred*', which might match; 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 in a given value  -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER4" 
Operators="STARTS_WITH"/>
ENDS_WITH
Applies an implicit asterisk to the start of the condition. For example, Ends with: Fred is equivalent to '*Fred', which might match; 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 in a given value  -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER4" 
Operators="ENDS_WITH"/>
CONTAINS
Applies an implicit asterisk to both the start and the end of the condition. For example, 'Contains: Fred' is equivalent to '*fred*', which could match any of the above terms, but also include 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 to the specified term that includes wildcard characters. For example, Wildcard pattern: Fr?d is equivalent to 'Fr?d', which 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 on a wildcard pattern  -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER4" 
Operators="WILDCARD_PATTERN"/>
NOT_WILDCARD_PATTERN
Excludes an exact match to the specified term that includes wildcard characters. For example, Not wildcard pattern: Fr?d matches anything aside 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 on a wildcard pattern  -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER4" 
Operators="NOT_WILDCARD_PATTERN"/>
EQUAL_TO
An exact match to 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 the 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 on an exact value  -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER9, PER15" 
Operators="EQUAL_TO"/>
NOT_EQUAL_TO
Exact matches to the specified term should be excluded. For example, Not equal to: Fred matches anything aside 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 the 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 on an exact value  -->
<Allow ItemTypeId="ET5" PropertyTypeIds="PER9" 
Operators="NOT_EQUAL_TO"/>
GREATER_THAN
Matches values that are higher 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 higher 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 lower than to 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 lower 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 on 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"/>