Introduction

The CQL Search Macro allows users to execute contextual searches with predefined CQL. Some possible scenarios are to do title/keyword search within

Configuration

Field Name	Required	Default Value	Explanation	Additional Information

Field Name	Default Value	Explanation	Additional Information
CQL		Enter a CQL statement with $$query$$ or $$query*$$ as the search term.	Placeholder Variables for CQL Information on CQL Configured How to Search Content effectively with Titles Search Results and Warnings Useful scenarios with Canned Search for Confluence
Hide Filenames in Excerpts	Unchecked	The files names are removed from excerpt when checked. Please view Excerpt when filenames are removed for more information.	Remove Image filenames from Returned Results
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
No. of Results per Page	10	Select the no. of results to be displayed: 5 — Pagination will occur if there are >5 search results 10 — Pagination will occur if there are >10 search results 50 — Pagination will occur if there are >50 search results 100 — Pagination will occur if there are >100 search results If there are more results than the selected no. of results to display, pagination will occur.	Search Results with Pagination
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

See Useful scenarios with Canned Search for Confluence for suggestions on how to define CQL for creating context.

Results count and pagination is provided.

From version 1.3.0 onwards, this message can now be customised to provide better information.

There will be an error message displaying suggestions for performing search if there are no result that matches the search term.