Funnelback logo

Documentation

CATEGORY

Curator

Introduction

The curator system provides the ability for the user to customize Funnelback results pages in a number of ways. Generally the customizations performed are based in some way on the request performed by the user (e.g. the query entered), and may involve adjusting the order of results or presenting additional sections of information within the results page.

The curator system is a modernized version of Funnelback's traditional Best Bets / Featured Pages system, providing substantially greater flexibility in configuring common scenarios. Curator's configuration interface can be accessed from the "Customise Result Curations" link under the collection's "Customise" tab.

Manage Rulesets

Curator customizes result pages based on a number of rulesets, each of which define some set of customization actions, and the conditions under which to trigger those actions. Curator displays a list of configured rulesets similar to that shown below.

Manage rulesets.png

Each ruleset in the list may be edited, enabled, disabled and deleted using the links from this page.

Adding and Editing Rulesets

A rulesets triggers and actions can be combined to provide very fine control over search result pages. Possibilities range from simply promoting or removing a result when a certain query term is used, to the following example, where all result pages for users who are detected to be within the media industry, when the date is between the 1st and 5th of September, will see an additional message on result pages and will have the 'New version' page displayed at the top of the result set (assuming it matches their query).

Add_ruleset.png

More detail on the individual triggers and actions is provided below.

Groups of triggers can be combined with 'or' logic, meaning that the trigger activates if any of the individual triggers does, and these groups can be combined with 'and' logic, meaning at least one trigger form each 'or-group' must activate for the triggers to activate overall. Every trigger also has a negative version, which activates only when the normal trigger would not activate.

Actions, however, are always combined with 'and' logic, meaning that all the listed actions will be applied to the result pages where the trigger activates.

Triggers

Details on the behaviour of each available trigger.

When query contains the words

Activates when each of the (space separated) words provided appear in the search term as entered by the user. Case and the order of the individual terms are ignored.

When query exactly matches

Activates when the provided query terms match the query terms entered by the user exactly. Both the order of the query terms and case are considered important for the matching.

When regular-expression matches

Activates when the provided regular expression (in the syntax defined by Java 7's Pattern class) matches the query terms entered by the user.

When the date falls between

Activates when the current date (as determined by the time on the Funnelback server) falls between the given dates.

When requested from country

Activates when the user appears to be from the chosen country (as determined based on the user's IP address and information from the MaxMind GeoLiteCity Database - See Third party licences).

When this sub-string present

Activates when the given substring occurs within the query entered by the user. Case is ignored, however differences in white space are considered important for the matching.

When the user belongs to the segment

Activates when the given string appears within the segment information for the given key for the current user.

Segment information is produced by Funnelback's Predictive Segmentation feature, and is based on the user's IP address. The specific segment information for a given IP address can be checked from the API UI (under Funnelback admin's System Menu) by selecting Data API, then "funnelback-predictive-segmentation-api" and entering the IP address to test.

The following key values are used, however please note that not all will be available for all users.

agency
If organisation-type is government then a value for agency may also hold the the name of the agency.
areas-served
The areas-served are the geographical areas where the organisation has a presence.
department
If organisation has an organisation-type of government, then the organisation may belong to a government department.
industry
The type of industry the organisation belongs for example "Telecommunications, software".
location
The office locations of the organisation.
maxmind-name
The original organisation name string provided by Maxmind, that was associated with the provided IP address.
number-of-employees
The total number of people that are employed by the organisation.
organisation-type
The type of organisation, it may be either company, university, non-profit, or government agency.
revenue
The total revenue as an integer amount of US dollars.
stock-code
The stock codes for the markets the organisations stock is traded.
website
The organisation’s web address.
wikipedia-name
The name of the organisation’s Wikipedia page.
wikipedia-url
The organisation's Wikipedia web address.

When query does not contain all of the words

Logically the opposite of "When query contains the words". Activates when the query entered by the user does not contain all of the (space separated) words given. Case and the order or words are ignored. Note that this query will not activate even if some of the words given are missing from the query - all must be absent for it to activate.

When query is not an exact match to

Logically the opposite of "When query exactly matches". Activates when the query entered by the user does not exactly match the given string. Both the order of the query terms and case are considered important for the matching.

When regular-expression does not match

Logically the opposite of "When regular-expression matches". Activates when the given regular expression (in the syntax defined by Java 7's Pattern class) does not match the query entered by the user.

When not requested from country

Logically the opposite of "When requested from country". Activates when the user does not appear to be from the chosen country (as determined based on the user's IP address and information from the MaxMind GeoLiteCity Database - See Third party licences).

When the date does not fall between

Logically the opposite of "When the date falls between". Activates when the current date (as determined by the time on the Funnelback server) falls outside the given dates.

When this sub-string not present

Logically the opposite of "When this sub-string present". Activates when the given substring does not occur within the query entered by the user. Case is ignored, however differences in white space are considered important for the matching.

When the user does not belong to the segment

Logically the opposite of "When the user belongs to the segment". Activates when the given string does not appear within the segment information for the given key for the current user.

See details of the segment information available in the "When the user belongs to the segment" section above.

Actions

Details on the behaviour of each available action.

Display a message with results

Adds a 'Message' exhibit to the search page data model, which is designed to be displayed by the ftl template as a message.

HTML content is permitted (subject to the ftl template) in the main message body and a category and additional properties are available to provide additional information by which the presentation of the message may be customized. The default ftl template displays all messages above the search results block.

Display properties with results

Adds a 'Properties' exhibit to the search page data model, which is designed to be displayed by the ftl template in a structured way.

The properties object carries a category, intended for use in controlling the location or styling of the exhibit, and additional properties in a key-value form intended to carry the data for display. Note that the default ftl template does not display properties exhibits, so the template must be customized if they are to be presented.

Display a URL advert with results

Adds a 'UrlAdvert' exhibit to the search page data model, which is designed to be displayed by the ftl template as an advert linking to a specified page.

The advert object defines a tile, description, urls to display and to send the user two (which might include additional tracking information), as well as a category and additional properties. The default ftl template displays all adverts below messages and above the search results block

Promote URL to top of results

Moves the given URL to the top of the search results if it is present.

This feature allows specific results to be highlighted under certain conditions without the need to specify a URL advert as described above.

Note that the URL given must match the URL within the index exactly, and that the URL promoted will not be displayed if it does not match the search query performed.

Remove URL from results

Removes the given URL from the search results if it is present.

This feature allows specific results to be removed when required without removing them from all queries.

Note that the URL given must match the URL within the index exactly.

Add a term to the user's query

Adds the specified additional search term to the query which is run.

This feature allows the query to be modified to affect ranking changes or to automatically apply scoping.

See Also

top ⇑