Text Filter

Description

This filter will ensure that the specified prefix:key value matches the required text value. It allows filtering based on the number of characters or on a regular expression.

This macro must be used within a reporter macro.


Parameters

NameRequiredAvailable InMigratable to Cloud?Default ValueDescription
[default] /key
 Yes
Server, Data Center
No
The key value to filter on.
minLength
 Optional
Server, Data Center
No
If specified, value must have at least this many characters.
maxLength
 Optional
Server, Data Center
No
If specified, the value must have at most this many characters.
include
 Optional
Server, Data Center
No
If specified, this is a regular expression specifying the pattern required to be included. For more information, view the knowledge base article on regular expression requirements.
exclude
 Optional
Server, Data Center
No
If specified, this is a regular expression specifying the pattern required to be included. For more information, view the knowledge base article on regular expression requirements.
value
 Optional
Server, Data Center
No
(Since 3.4.0) The exact text value that must be matched.
required
 Optional
Server, Data Center
No
false
If set to true, the key value must have a value with more than one non-whitespace character.
contains
 Optional
Server, Data Center
No
If specified, this is the value it may contain.


Editor View

Tutorial Examples