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)

CQL Search Counter Macro (Text)

Canned Search for Confluence > CQL Search Counter Macro > CQL Text V2.png

Configuration for CQL Search Counter Macro (Board)

Field Name	Default Value	Explanation	Additional Information
CQL		Enter a CQL statement with $$query$$ as the search term.	Information on CQL Configured How to Search Content effectively with Titles Search Results and Warnings Useful scenarios with Canned Search for Confluence
Search Type	Exact Match	Select the type of search for $$query$$: Exact Match Start With Contains	Different modes of searching
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	How to use CQL Macro to Share Information
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

Field Name	Default Value	Explanation	Additional Information
CQL		Enter a CQL statement with $$query$$ as the search term.	Information on CQL Configured How to Search Content effectively with Titles Search Results and Warnings Useful scenarios with Canned Search for Confluence
Search Type	Exact Match	Select the type of search for $$query$$: Exact Match Start With Contains	Different modes of searching
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	How to use CQL Macro to Share Information
Display as link	Unchecked	If checked, the macro will display the number of search results as a link.