Search related features are handled by the adapters searchAdapter, facetedSearchAdapter and suggestionsAdapter. The following functionality is supported:

The following GraphQL query is a simple example for fetching a search result.

{
  content {
    search(query:"Perfect") {
      numFound
      result {
        name
      }
    }
  }
}

Several parameters can be passed to the SearchAdapter to customize the search:

The query parameter supports the following syntax:

By default, the SearchAdapter employs DefaultSearchServiceProvider, which in turn uses the caeSolrQueryBuilder Spring bean. caeSolrQueryBuilder invokes searches on Solr on the cmdismax endpoint. For details, seeSection 3.8.1, “Details of Language Processing Steps” in Search Manual.

The used SearchServiceProvider is at the same time an ExtensionPoint, which can be implemented and provided by a plugin. See Section 4.16, “Plugin Support” for details.

The following GraphQL query is a more complex example for fetching a search result.

{
  content {
    search(query: "Perfect", offset: 3, limit: 5, docTypes: ["CMArticle", "CMPicture"], sortFields: [CREATION_DATE_ASC, MODIFICATION_DATE_ASC], siteId: "abffe57734feeee", includeSubTypes: true) {
      numFound
      result {
        name
        type
      }
    }
  }
}

If docTypes or limit is not passed as parameter, the following search configuration is taken into account, which is read from CMS content using settings. See general search configuration for details in Blueprint Developer Manual .

Valid from and valid to conditions are applied to search filters automatically.

Faceted Search Results

The Headless Server Search is able to do a faceted search on configured facets on the Solr search index. Headless Server comes with preconfigured facets, e.g. on the document type. See Blueprint Developer Manual on how to configure facets on the search index.

In contrast to the regular search without facets, the facetedSearch query requires the parameter siteId mandatorily. To issue a faceted search request, the search query has to define the desired facets using the parameter facetFilters:

{
  content {
    facetedSearch(
      query: "*"
      siteId: "abffe57734feeee"
      facetLimit: 10
      facetFilters: [
        { facetName: "type", args: ["CMArticle"], excludeInFacet: false }
        { facetName: "subject", args: ["1234", "5678"] }
      ]
    ) {
      numFound
      facets {
        alias
        field
        values {
          query
          value
          hitCount
        }
      }
      result {
        id
        type
        ... on CMArticle {
          detailText {
            text
          }
        }
      }
    }
  }
}

The facets can be found in the facets property of the search result. They provide information about the requested facets, the corresponding facet values and their count of documents where the facet occurred.

Use these parameters to issue a faceted search

By default, the FacetedSearchAdapter employs DefaultFacetedSearchServiceProvider, which in turn uses the caeSolrQueryBuilder Spring bean. caeSolrQueryBuilder invokes searches on Solr on the cmdismax endpoint. For details, seeSection 3.8.1, “Details of Language Processing Steps” in Search Manual.

The used FacetedSearchServiceProvider is at the same time an ExtensionPoint, which can be implemented and provided by a plugin. See Section 4.16, “Plugin Support” for details.

Search Suggestions

Suggestions are a very popular feature for any search on a website. Suggestions are calculated simultaneously and then provided as an optional list to choose from, thus relieving the user from typing the full search expression.

The Headless Server is able to provide suggestions for search query expressions.

{
  content {
    suggest(
      query: "sal"
    ) {
      value
      count
    }
  }
}

Use these parameters to issue a search suggestion query.

By default, the SuggestionAdapter employs DefaultSuggestionSearchServiceProvider, which in turn uses the suggestionsSolrQueryBuilder Spring bean. suggestionsSolrQueryBuilder invokes searches on Solr on the suggest endpoint. For details, seeSection 3.8.1, “Details of Language Processing Steps” in Search Manual.

The used SuggestionSearchServiceProvider is at the same time an ExtensionPoint, which can be implemented and provided by a plugin. See Section 4.16, “Plugin Support” for details.

Configuration of custom SOLR fields

To configure a custom field of the SOLR index, a bean with qualifier customSolrFields can be added to the Spring context.

This bean of type Map<String, String> contains the custom field's name as a constant accessor and the field name in the SOLR index, e.g. TITLE, title.

This custom field can then be used, e.g. to apply a sort order.

The customSolrFields are applied to the SolrQueryBuilder.

The default SOLR fields are defined in the class SearchConstants, these are the default fields of the SOLR CAE index.

Generic configuration

The connection to Solr is defined with solr.url

The search index is specified with property caas.search.solr.collection

Caching is only performed in live mode and can be configured with caas.search.cache.seconds

Configuration of a custom index

If search should be performed on a custom SOLR index, the SolrQueryBuilder must be extended and configured. The following constructor arguments can be passed: