Unify Enterprise Search form portlet

From VYRE

Jump to: navigation, search
Unify Enterprise Search form portlet
module: Publishing module
supplier: VYRE Ltd.


The Unify Enterprise Search form portlet is used to search for content items.

Contents

Usage

This portlet initiates a query to the Rabida search server with the appropriate parameters.

Configuration

URL to Rabida Web Services (No longer required for 4.4)

The full URL to the web services application, e.g. 'http://hostname:8080/rabida-ws'

Key for accessing shared results

This key is used to store the search on a session, therefore it allows for multiply search forms and results on the same page and also allows a search results use a search submitted on a separate page.

Result size

The number of items/documents to retrieve for a given query.

Filter

Static Query filter to apply before attempting a match. This is stated in the Lucene query parser syntax with references to properties specified in the Remote indexing template.

Example

title:"The Right Way" AND description:go

Default Operator

Boolean operator to apply by default in multi word searches where a query for 'brown fox' would find documents that either contain 'brown' or 'fox' if OR is specified as the default operator.

Retrieved fields

A space separated list (since 4.4 is now a comma separated list) of searchable property names. This determines which properties will be brought back as a part of the result set. In order to reference or display a given property in the Rabida search results portlet it must be listed here.

Facet fields

A comma separated list of searchable property names for which we want to generate facets or dynamic navigators.

Facet field limit

The facet field limit allows a limit to be set on the number of facets returned for each facet field stated above. Caution must be used as too great a number can effect performance.

Facet Sorting (since 4.4)

The order of the facets can be changed here, the two options are by count or alphabetically. Count orders it by highest first, where alphabetically is from A-Z based on the facet name,

Highlighting

On/Off as to whether keywords from the query (or inflections thereof) are highlighted e.g. in bold in the results.

Highlighted Fields (Since 4.4)

A comma separated list of the fields that should be highlighted, the default fields are title, description and body

Number of Snippets (Since 4.4)

This number decides how many snippets (sections of text from result) that should be displayed, works with Frag size below.

Frag Size of Snippets (Since 4.4)

This number decides the size, in characters, of the snippet (section of text with search term) that is displayed, default is 100, 0 would display the whole field.

The tag to be used before the highlighted section/The tag to be used after the highlighted section (Since 4.4)

These fields are used to specify the text that should be placed before and after the highlighted sections of the search results.

Filter by locale (Since 4.4)

This field can be set to no filtering, filtering of items based on the site locale or a specific locale can be set for the portlet.

Redirection

Whether to redirect to another page to display results. If left blank the system will expect the result portlets to be on the same page.

Sorting (Since 4.4)

Specify the default sorting for the search, can contain more then one field and should be a comma separated list in the form "field asc" or "field desc".

FreeMarker template for displaying serach form (since 4.4)

A FreeMaker template can be used instead of the default search form and can be selected from the available FreeMarker resources.

N.B. The checkbox needs to be ticked for the FreeMarker template to be used.

The following objects are available to the template at view time:

Form (since 4.4)
  • form: form object reference.
    • .defaultSearchKey: returns the default search key used in the standard search.
    • .defaultSearchValue: returns the default search value for the previous search (empty string if it is the initial search).
    • .getFieldKey(String fieldName): returns the search key for the given field.
    • .getFieldValue(String fieldName): returns the search value for the previous search, for the given field (empty string if it is the initial search).
Localization (since 4.4)
  • bundle: localization bundle object reference.
    • ${bundle.getStringIfExists("key.goes.here")} can be used to display the key key.goes.here

Example

Below is an example of a FreeMarker search form template.

<div class="form search input">
 
 <!-- default search field -->
 <input id="${form.getDefaultSearchKey()}" class="text" type="text" value="${form.getDefaultSearchValue()}" name="${form.getDefaultSearchKey()}"/>
 
 <!-- custom search field for title -->
 <input id="${form.getFieldKey('title')}" class="text" type="text" value="${form.getFieldValue('title')}" name="${form.getFieldKey('title')}"/>
 
 <input type="submit" class="searchButton" value="Search"/>
 
</div>

Predefined Search By Search Results

  • Options (main tab) : Key for accessing shared results, Filter, facet limit, facet ordering
  • Fields: retrieved fields, facet fields
  • Sorting And Pagination: batch size, Default sort Fields,
  • Highlight Options : highlight fields / highlight fragments / highlight snippets / highlighted *
  • Filtering And Extra Options : Filter by locale, extra params textbox

It is now possible for configuration to be shared across the form and results portlet, possibly indexed / retrieved by the rabida key, so that a change would not involve having to copy the configuration over to the other portlets which share the same key. Helpful especially when you have the portlet positioned around the site.

Extra Parameter Strings

In 4.4.0.1 there is the option to add extra parameter strings to send to SOLR. Commonly we would use this so that we can add facet queries or date facet queries.

Example

Limiting facet sizes

limit the number of options returned by a particular field when used as a facet. -1 means there is no limit. You can use this to override the default size configured in the portlet

f.root_category_tax.facet.limit=1

Facet Query

Will show the number of documents which satisfy this query as a facet

facet.query=root_show_stop_range:[NOW-7DAY/DAY TO NOW/DAY+1DAY]

Facet Date Query

This will give facet options for this field from (today - 5Days) to today, with a gap of 1 day. So will generate 5 facet options from today down to today-5days.

facet.date=root_show_stop_range
facet.date.start=NOW/DAY-5DAYS&facet.date.end=NOW/DAY%2B1DAY&facet.date.gap=%2B1DAY

Facet Prefix

this will only show facet options which have a certain prefix for example ireland prefix will only show options which start with ireland ie ireland_products, ireland_food

facet.prefix=ireland

Record Searches

Added in Unify 4.6.2

Whether or not you wish to record searches that are requested through this portlet. The default is for this option to be turned off. When turned on, a record of the search is recorded in the database when the results are displayed. This information can then be used later by the Business Intelligence module.

See Also

Personal tools