The parameter value is a constraint the documents need to match to not be filtered from the result set. The syntax is different from those you specify in case you run a Lucene search. As in In queries you check the property values of the child documents. If the property name you need to match is a alphanumeric token, you do not need to encode it (e.g. Year=2019 ). If it has a space, used use $[...] as delimiters for the property name. For instance $[Customer Reference] . This is similar to the encoding used for Lucene queries with the Display Table Macro. You may also use ${...} or $<...> as delimiters. But , but there is no reason to do so since property names should not contain special characters. We recommend to use the square brackets ($[...] ) since these are also used for Lucene queries of the property name contains a space (see Search Tips). Values that have no spaces and are plain tokens do not need not to be encoded to compare with a property property value (e.g. $[Zip Code]=45672 . In case there is a space, you can use quotes as in in $[Customer Reference]="123 ABC" . You may also compare the property value of the document in the result set with a property value of the document the macro is part of: . Use ${...} to reference the document property by its name, for instance: $[Customer Reference]=${Default Customer Reference} The following options are available Type | Examples | Explanation |
---|
String Literal | $[Customer Reference]="123 ABC" Reference="123 ABC"
| Use string literals if the property to match with contains spaces. | Token | $[Customer Reference]=123ABC Reference=123ABC
| If the value does not contain spaces, no double quotes are required. | Integer Literal | $[Customer Reference]=123 Reference=123
| For integer numbers, no double quotes are required. | Property Reference | $[Customer Reference]=${Default Customer Reference} Reference=${Default Customer Reference}
| For property references, no double quotes are allowed. |
You may combine your property constraints by the following Boolean operators. Operator | Description |
---|
& | AND - both properties need to match | | | OR - only one of the two properties need to match | ! | NOT - only true if the property does not match. |
Use parentheses to group your expressions. Example Box |
---|
title | Example Matcher Expression with !, |, and & |
---|
| Code Block |
---|
| !($[Property A]="Value 1" | !$[Property B] = "Value 2") & $[Property C] = "Value 3" |
|
Version Box |
---|
| Since version 6.2.5 list values are allowed on both sides of a property reference expression. $[Customer Reference]=${Default Customer Reference}
If Customer Reference and Default Customer Reference both resolve to lists of values, then each value of each set is compared. If one tuple matches, the whole expression is resolved as a match. |
Currently the projectdoc Toolbox does not support list searches lists of literals (workaround: resolve with OR connector) or comparisons with greater than or less than. Only exact matches are supported. |