Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Name

Required

Migratable to Cloud?

Default Value

Description

[default] /key

  • (/)

...

  • NO

The key value to filter on.

minLength

  • (

...

  • X)

...

  • NO

If specified, value must have at least this many characters.

maxLength

  • (

...

  • X)

...

  • NO

If specified, the value must have at most this many characters.

include

  • (

...

  • X)

...

  • 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

  • (

...

  • X)

...

  • 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

  • (

...

  • X)

...

  • NO

(Since 3.4.0) The exact text value that must be matched.

required

  • (

...

  • X)

...

  • NO

false

If set to true, the key value must have a value with more than one non-whitespace character.

contains

  • (

...

  • X)

...

  • NO

If specified, this is the value it may contain.

Editor View

...

  •  

Macro Edit View

  • Not applicable.

Notes

  • Not applicable.

...

Tutorial Examples

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
excerptTypesimple
cqllabel = "text-filter"