Document toolboxDocument toolbox

User Guide for CQL Counter Macro

Introduction


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

 

Configuration


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.

Default Query Term





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

 

Search Type

 

Contains

The searching can done with three type searches.

  • Exact Match – Find contents that contains the exact word

  • Start With – Find contents that starts with the word

  • Contains – Find contents that partially matches the word

Board Size

 

Medium

Select the height of the board:

  • Small

  • Medium

  • Large

 

Board Position

 

Left

Select the position of the board

  • Left

  • Center

  • Right

 

Board Colour

 

White

Select the background colour to be displayed:

  • White

  • Blue

  • Green

  • Navy

  • Yellow

  • Orange

  • Purple

  • Red

 

Footer Text

 

 

Enter a footer text to be displayed below the value.

Please limit the text to below 16 characters

 

Refresh Button

 

Show

Indicate whether to show the refresh button