SearchStax integration module

Search and discovery Incubator Version 1.0 Magnolia 6.2 compatible Git

The SearchStax integration module provides a ready to use integration for SearchStax.

This module is at the INCUBATOR level.

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

<dependency>
  <groupId>info.magnolia.search.stax</groupId>
  <artifactId>magnolia-search-stax-integration</artifactId>
  <version>1.0</version>
</dependency>

Configuration

Define a yaml decoration in /magnolia-search-stax-integration/config.yaml.

/magnolia-search-stax-integration/config.yaml
#SEARCH API
selectEndpoint: '<to be defined through decoration>' (1)
#AUTO-SUGGEST API
autoSuggestEndpoint: '<to be defined through decoration>' (1)
#TOKENS
authorizationToken: '<to be defined through decoration>' (1)
#ANALYTICS TRACKING API
analyticsTrackingUrl: '<to be defined through decoration>' (1)
analyticsTrackingKey: '<to be defined through decoration>' (1)
1 You can find these credentials in the settings of your SearchStax app under search-api and analytics-api.

Usage

You get three predefined endpoints to interact with your SearchStax app. For more details, see the SearchStax docs.

Search API

Method: POST
URL: <baseUrl>/.rest/delivery/search-stax-search

Table 1. Parameters
Parameter Description Default

q

required search term

start

start is a zero-based index of the search results.

0

rows

rows are the number of results to return per page.

5

fq

Faceting / Facet Selection

''

Auto-Suggest API

Method: POST
URL: <baseUrl>/.rest/delivery/search-stax-suggest

Table 2. Parameters
Parameter Description Default

inputValue

required search term for suggestion search

Search Analytics REST API

Method: POST
URL: <baseUrl>/.rest/delivery/search-stax-analytics

Table 3. Parameters
Parameter Description Default

data

required tracking object

See SearchStax docs for more details.

Changelog

Version Notes

1.0

Initial release of the module.
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the SearchStax integration module docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules