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.

This user interface was implemented in Perl until Funnelback v11. Starting from v11 a Java-based UI is also available. The Perl UI is now referred as the Classic UI, whereas the Java one is referred to as the Modern UI.

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 (Modern UI) or search.cgi (Classic UI)
is the end point that handles web requests and the generation of web pages.
PADRE
is the search engine that accepts a query, searches the index and returns the results.


Accessing search UIs

The Modern and Classic UIs can be used simultaneously because they're using different URLs.

  • To access the search service using the Modern UI, plase use the /s prefixed URLs:
  • To access the search service using the Classic UI, please use the /search prefixed URLs:

Note that the cache links, click tracking links and RSS generation links are relevant only to the Classic UI. There is no Modern UI equivalent.

URL 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

Each user interface uses its own search forms file format:

  • The .ftl FreeMarker format for the Modern UI.
  • The .form format for the Classic UI

Please read the Search forms section for more information.

Comparison between the Classic UI and the Modern UI

The Classic UI is the interface that was available since the first versions of Funnelback, and is still available today. While it's still maintained and can be used without any restriction, the Modern interface introduced in v11 has some advantages:

  • 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.

Limitations of the Modern UI

The Modern UI user interface does not currently support Document Level Security. If you need to setup a search service on content with document level security, you must use the Classic UI.

The following user interface features are not available with the Modern UI: Tagging, Feedback, Related information

See also

top ⇑