Delivery Tier Fluent Search API

Dear Community,

Currently Im follow up this documentation

so I create the below classes

  1. ref:
    Define Configuration Parameters for Delivery Tier Components or REST Services - Bloomreach Experience Manager (PaaS/Self-Hosted) - The Fast and Flexible Headless CMS

public interface SearchInfo {
@Parameter(name = “pageSize”,
defaultValue = “10”,
displayName = “Page Size”)
int getPageSize();

@Parameter(name = “documentType”,
defaultValue = “bloomreach:basedocument”,
displayName = “Document Type”)
String getDocumentType();

  1. Delivery Tier Fluent Search API - Bloomreach Experience Manager (PaaS/Self-Hosted) - The Fast and Flexible Headless CMS
@ParametersInfo(type = SearchInfo.class)

public class MySearchComponent extends BaseHstComponent {

public void doBeforeRender(final HstRequest request, final HstResponse response)
throws HstComponentException {
HstRequestContext requestContext = request.getRequestContext();
SearchInfo info = getComponentParametersInfo(request);
// the scope to search below, for example /content/documents/myproject
HippoBean scope = requestContext.getSiteContentBaseBean();

try {
// parse a free text query to remove invalid chars. The argument
// ‘false’ means no wildcards allowed
String query = getPublicRequestParameter(request, “q”);
String parsedQuery = SearchInputParsingUtils.parse(query, false);

   int pageSize = NumberUtils.toInt(getPublicRequestParameter(request, "ps"), 10);
   int pageNum = NumberUtils.toInt(getPublicRequestParameter(request, "pn"), 1);

   // create the query to search below 'scope', return beans that are
   // of type BaseDocument bean or a subclass/sub-jcr-types, the
   // third argument, 'true', indicates whether to include subtypes
   HstQuery hstQuery = HstQueryBuilder.create(scope)
            .offset(pageSize * (pageNum - 1))

    // execute the query
    HstQueryResult result = hstQuery.execute();

    // set the result, info and parsedQuery on the HstRequest : It is
    // then available in the JSP
    request.setAttribute("result", result);
    request.setAttribute("info", info);
    request.setAttribute("query", parsedQuery);

} catch (QueryException e) {
    throw new HstComponentException(
     "Exception occured during creation or execution of HstQuery.", e);


  1. ftl
    Render a Search Query Result - Bloomreach Experience Manager (PaaS/Self-Hosted) - The Fast and Flexible Headless CMS

<#include “/WEB-INF/freemarker/include/imports.ftl”>

${info.title?html} for '${query?html}': ${result.totalSize} results

    <#-- Iterate through the hippoBeans on the result --> <#if result?? && result.hippoBeans?has_content> <#list result.hippoBeans as item> < var="link" hippobean=item />
  • <@hst.cmseditlink hippobean=item/> ${item.title?html}
    <#if &&>

    <@fmt.formatDate type="Date" pattern="MMMM d, yyyy h:mm a"/>


So when I run

Its that expected result???

Thanks in advance

The search component you’re creating expects a q parameter with the search term. For example, http://localhost:8080/site/search?q=search-term

The two lines below that you have in the component take the query parameter and parse it:

String query = getPublicRequestParameter(request, “q”);
String parsedQuery = SearchInputParsingUtils.parse(query, false);

Then the hstQuery uses the parsedQuery in the where contstraint

Hi Adam,

Thank you for your answer

Should I add a form to display the response?

When i send the request
I see the same message " Please fill in a search term"

Is there an to test this??


Below is a link to the Essentials Search Component freemarker templates. There are 2 templates:

  1. A search box to submit a search term to the search page
  2. The search results page to render the search results

Thank you!

Hello @andorian,
We are happy you are part of Bloomreach Developer’s Community.
Thank you for reaching out to us.
We hope we have answered your queries and therefore marking this thread for Closure.

Looking forward to your continuous contribution towards our vibrant Bloomreach Community.

Thank you