GuideReference
TrainingSupportCommunity

match_​variable

  • Property Manager name: Variable
  • Criteria version: The v2023-09-20 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.

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"]}}