API

matchVariable

Matches a built-in variable, or a custom variable pre-declared within the rule tree by the set​Variable behavior. See Support for variables for more information on this feature.

OptionTypeDescriptionRequires
variable​Namestring (variable name)

The name of the variable to match.

{"displayType":"string","tag":"input","type":"text"}
match​Operatorenum 
The type of match, based on which you use different options to specify the match criteria.
{"displayType":"enum","options":["IS","IS_NOT","IS_ONE_OF","IS_NOT_ONE_OF","IS_EMPTY","IS_NOT_EMPTY","IS_BETWEEN","IS_NOT_BETWEEN","IS_GREATER_THAN","IS_GREATER_THAN_OR_EQUAL_TO","IS_LESS_THAN","IS_LESS_THAN_OR_EQUAL_TO"],"tag":"select"}
IS
Matches the variable​Expression string.
IS_​NOT
Does not match the variable​Expression string.
IS_​ONE_​OF
Matches any of an array of string variable​Values.
IS_​NOT_​ONE_​OF
Does not match any of an array of string variable​Values.
IS_​EMPTY
Matches if a defined variable does not contain a value. You can't activate a rule that matches an undefined variable.
IS_​NOT_​EMPTY
Matches if a defined variable contains a value. You can't activate a rule that matches an undefined variable.
IS_​BETWEEN
Is between the numeric lower​Bound and upper​Bound values.
IS_​NOT_​BETWEEN
Is outside the numeric lower​Bound and upper​Bound range.
IS_​GREATER_​THAN
Is greater than the variable​Expression string-formatted number.
IS_​GREATER_​THAN_​OR_​EQUAL_​TO
Is greater than or equal to the variable​Expression string-formatted number.
IS_​LESS_​THAN
Is less than the variable​Expression string-formatted number.
IS_​LESS_​THAN_​OR_​EQUAL_​TO
Is less than or equal to the variable​Expression string-formatted number.
variable​Valuesstring array 
Specifies an array of matching strings.
match​Operator is either: IS_​ONE_​OF, IS_​NOT_​ONE_​OF
{"displayType":"string array","tag":"input","todo":true}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_ONE_OF","IS_NOT_ONE_OF"]}}
variable​Expressionstring (allows variables)
Specifies a single matching string.
match​Operator is either: IS, IS_​NOT, IS_​GREATER_​THAN, IS_​GREATER_​THAN_​OR_​EQUAL_​TO, IS_​LESS_​THAN, IS_​LESS_​THAN_​OR_​EQUAL_​TO
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS","IS_NOT","IS_GREATER_THAN","IS_GREATER_THAN_OR_EQUAL_TO","IS_LESS_THAN","IS_LESS_THAN_OR_EQUAL_TO"]}}
lower​Boundstring 
Specifies the range's numeric minimum value.
match​Operator is either: IS_​BETWEEN, IS_​NOT_​BETWEEN
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_BETWEEN","IS_NOT_BETWEEN"]}}
upper​Boundstring 
Specifies the range's numeric maximum value.
match​Operator is either: IS_​BETWEEN, IS_​NOT_​BETWEEN
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS_BETWEEN","IS_NOT_BETWEEN"]}}
match​Wildcardboolean 
When matching string expressions, enabling this allows wildcards, where ? matches a single character and * matches zero or more characters.
match​Operator is either: IS, IS_​NOT, IS_​ONE_​OF, IS_​NOT_​ONE_​OF
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS","IS_NOT","IS_ONE_OF","IS_NOT_ONE_OF"]}}
match​Case​Sensitiveboolean 
When matching string expressions, enabling this performs a case-sensitive match.
match​Operator is either: IS, IS_​NOT, IS_​ONE_​OF, IS_​NOT_​ONE_​OF
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"matchOperator","op":"in","value":["IS","IS_NOT","IS_ONE_OF","IS_NOT_ONE_OF"]}}