Versions Compared

Key

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

...

The CQL Counter Macro displays the number of search result for a predefined CQL. It has the following features:

CQL Search Counter Macro (Board)

  • Display the value in large font with optional footer text

  • Background colour and the size can be changed

...

Image Removed

Image Removed

Image Removed

Image Added

CQL Search Counter Macro (Text)

  • Display the value

in large font with different footer text
  • as text only

  • Display the value as a link to the search page

...

Image Added

Configuration for CQL Search Counter Macro (Board)

...

Field Name

Required

Default Value

Explanation

Additional Information

CQL

(tick)

Enter a CQL statement with $$query$$ as the search term.

Display as link

Unchecked

If checked, the macro will display the number of search results as a link.

Search Type

Exact Match

Select the type of search for $$query$$:

  • Exact Match

  • Start With

  • Contains

Default Query Term



Enter a default query term to replace the $$query$$ in CQL.
Search results will be preloaded if it is provided.

*Note: $self returns current page title

Board Colour

Blue

Select the background colour to be displayed:

  • Blue

  • Emerald

  • Green

  • Navy

  • Orange

  • Peach

  • Red

  • Yellow

*Note: Only when the Display as link is unchecked

Footer Text

Enter a footer text to be displayed below the value.

Please limit the text to below 16 characters

*Note: Only when the Display as link is unchecked

Gadget Height

Medium

Select the height of the gadget:

  • Small

  • Medium

  • Large

*Note: Only when the Display as link is unchecked

Font Weight

normal

Select the font weight for the value to be displayed:

  • normal

  • bold

  • bolder

*Note: Only when the Display as link is unchecked

Custom "No Results Found" message

Enter a customised message when no results are found.

How to Improve Feedback for Users when No Results are Found

Configuration for CQL Search Counter Macro (Text)

Field Name

Required

Default Value

Explanation

Additional Information

CQL

(tick)

Enter a CQL statement with $$query$$ as the search term.

Search Type

Exact Match

Select the type of search for $$query$$:

  • Exact Match

  • Start With

  • Contains

Default Query Term



Enter a default query term to replace the $$query$$ in CQL.
Search results will be preloaded if it is provided.

  • Note: $self returns current page title

Display as link

Unchecked

If checked, the macro will display the number of search results as a link.