match_variable

Property Manager name: Variable
Criteria version: The v2024-01-09 rule format supports the match_variable criteria v1.2.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

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.

Option	Type	Description	Requires
`variable_name`	string (variable name)	The name of the variable to match.		{"displayType":"string","tag":"input","type":"text"}
`match_operator`	enum	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_values`	string 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_expression`	string (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_bound`	string	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_bound`	string	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_wildcard`	boolean	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_sensitive`	boolean	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"]}}