About page filters

Owned by Adaptavist ScriptRunner for Confluence Cloud
Last updated: Sept 17, 2019 by Rina Nir (AC) (Unlicensed)

With the pageFilter element, you define which pages are considered training pages. This filter consists of a filter type and its value.

You can identify pages based on one or more of the following criteria:

You can combine filters and use regular expressions to broaden the scope of pages your rule applies to.

The filters below are given as examples for JSON structure of filters. Refer to Defining page and user filters for complete list of options.


Space name

The filter type PAGE_SPACE_NAME looks at the space name.
Example: You collect all your trainings in a space called Documents.

"pageFilter":
    {"type": "PAGE_SPACE_NAME", "value": "Documents"}

Space key

The filter type PAGE_SPACE_KEY looks at the key associated with the space. This can be useful if the name of a space can change or is not unique.
Example: The name of your space is still a draft, so you use the unique space key 'DOCS'

"pageFilter":
    {"type": "PAGE_SPACE_KEY", "value": "DOCS"}

Label

The filter type LABEL looks at labels you've attached to certain pages. This can be useful if you don't want to limit your training documents to one particular space.
Example: You give all your training pages the label 'training'.

"pageFilter":
    {"type": "PAGE_LABEL", "value": "training"}