Help Center

Menu

extra_search.ID.cfg (configuration file)

Name

extra_search.<ID>.cfg

Location

~/conf/collection/

Description

Defines an extra search which can be enabled using the ui.modern.extra_searches search package configuration setting.

Table of Contents

Background

Funnelback can be configured to run extra searches that are run in parallel with a search. The results from extra searches are appended to the search response and can be used to enhance the search results.

The ui.modern.extra_searches configuration option specifies a set of extra search IDs. Each ID must correspond to an extra_search.ID.cfg file which sets the parameters for the extra search.

Format

A text file consisting of two lines:

collection=<COLLECTION-ID>
query_processor_options=<ADDITIONAL-OPTIONS>

Examples

Run an additional search (with the same query) for the top three items from the client~ds-courses data source:

extra_search.courses.cfg
collection=client~ds-courses
query_processor_options= -num_ranks=3

This extra search can then be enabled by setting ui.modern.extra_searches=courses on the search package.

See also