Document toolboxDocument toolbox

CQL Search Counter Macro

Owned by Cao Liang
Last updated: Feb 10, 2020
2 min read

Introduction

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

  • Support placeholder in the CQL query

 

CQL Search Counter Macro (Text)

  • Display the value as text only

  • Display the value as a link to the search page

  • Support placeholder in the CQL query

 

 

Configuration for CQL Search Counter Macro (Board)

Field Name

Required

Default Value

Explanation

Additional Information

Field Name

Required

Default Value

Explanation

Additional Information

CQL



 

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

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

 

Configuration for CQL Search Counter Macro (Text)

Field Name

Required

Default Value

Explanation

Additional Information

Field Name

Required

Default Value

Explanation

Additional Information

CQL



 

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.