- Property Manager name: Variable
- Criteria version: The
v2024-05-31
rule format supports thematchVariable
criteria v1.2. - Rule format status: Deprecated, outdated rule format
- Access: Read/Write
- Allowed in includes: Yes
Matches a built-in variable, or a custom variable pre-declared within the rule tree by the setVariable
behavior. See Support for variables for more information on this feature.
Option | Type | Description | Requires | |
---|---|---|---|---|
variableName | string (variable name) | The name of the variable to match. | {"displayType":"string","tag":"input","type":"text"} | |
matchOperator | 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 | |||
IS_NOT | Does not match the | |||
IS_ONE_OF | Matches any of an array of string | |||
IS_NOT_ONE_OF | Does not match any of an array of string | |||
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 | |||
IS_NOT_BETWEEN | Is outside the numeric | |||
IS_GREATER_THAN | Is greater than the | |||
IS_GREATER_THAN_OR_EQUAL_TO | Is greater than or equal to the | |||
IS_LESS_THAN | Is less than the | |||
IS_LESS_THAN_OR_EQUAL_TO | Is less than or equal to the | |||
variableValues | string array | Specifies an array of matching strings. | matchOperator 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"]}} |
variableExpression | string (allows variables) | Specifies a single matching string. | matchOperator 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"]}} |
lowerBound | string | Specifies the range's numeric minimum value. | matchOperator is either: IS_BETWEEN , IS_NOT_BETWEEN | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"matchOperator","op":"in","value":["IS_BETWEEN","IS_NOT_BETWEEN"]}} |
upperBound | string | Specifies the range's numeric maximum value. | matchOperator is either: IS_BETWEEN , IS_NOT_BETWEEN | {"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"matchOperator","op":"in","value":["IS_BETWEEN","IS_NOT_BETWEEN"]}} |
matchWildcard | boolean | When matching string expressions, enabling this allows wildcards, where | matchOperator 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"]}} |
matchCaseSensitive | boolean | When matching string expressions, enabling this performs a case-sensitive match. | matchOperator 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"]}} |