Funnelback logo

Documentation

CATEGORY

User interface

Introduction

The Funnelback user interface is normally a web page that allows the user to enter a query, and view the results.

Fb-search-steps.png

The user interface relies on several components working together:

search forms / templates
are the templates for generating the query form and result pages.
search.html
is the end point that handles web requests and the generation of web pages.
PADRE
is the query processor that accepts a query, searches the index and returns the results.


Accessing search UI

Form files

The specific presentation for search results is defined in the .ftl file, which uses the FreeMarker file format.

Please read the Search forms section for more information.

The Classic UI

Earlier versions of Funnelback included an older interface now known as the Classic UI. This user interface remains supported in Funnelback, however its use is discouraged for the following reasons.

  • Performance: The response time of the Classic UI is between 2x and 4x slower than the Modern one.
  • Flexibility: Modern UI form files are easier to write and provide a generic way to access search results data (as opposite to custom tags in the Classic UI).
  • New features: Some features aren't available with the Classic UI such as the ability to run multiple searches in parallel or to use custom content type and headers on form files. The Modern UI also supports localisation, and web resources folders.
  • To access the search service using the Classic UI, please use the /search prefixed URLs:

Unique features of the Classic UI

The following user interface features have been discontinued, and will not be made available in the Modern UI, however they remain available within the Classic UI: Feedback, Related information, morph query parameters. As of 14.0.1 the tagging feature which existed in earlier Classic UI versions has been removed.

Faceted navigation parameters

The URL parameters used in the Modern UI are the same as in the Classic UI (query, collection, meta_X_and, scope, etc.) except for Faceted Navigation parameters.

  • With the Modern UI the faceted navigation parameters looks like: &f.City|X=Sydney&f.Author|Y=Shakespeare
  • With the Classic UI the faceted navigation parameters looks like: &meta_X_phrase_sand=$++ Sydney $++&meta_Y_phrase_sand=$++ Shakespeare $++.

Unless custom developments have been made around faceted navigation this difference shouldn't affect the search service.

Form files

The Classic UI uses .form files rather than .ftl files, and the file syntax is somewhat different.

Please read the Search forms section for more information.

See also

top ⇑