Smartsite Documentatie > Features & Modules > Add-On Modules > Faceted Search > Reference > Smartlets > sml_FacetedSearch smartlet

sml_FacetedSearch smartlet

Release 1.3 - ...

The user interface for Faceted Search is created by a number of interacting smartlets. The main smartlet, sml_FacetedSearch, handles the actual searching, and filtering and paging of the search results. The other smartlets are:

The Faceted Search smartlet supports the following public properties:

Name Type Default Description
searchterm string The search string, including operators.
filters JSON The filters that are applied to the search results.
extractedterms string The terms (words) that were extracted from the searchterm property, separated by comma's.
options string

String of comma-separated name=value pairs. Do not use any whitespace in the options property. The following options are supported (defaults are bold):

  • allowverbose
    int (0 or 1) that shows or hides the verbose checkbox.
  • hidefilters
    int (0 or 1) that hides or shows the currently applied filters. (The main smartlet need not show the filters if the Filters smartlet is also used)
  • allowmulti
    int (0 or 1) that shows or hides the option to change the combination of filters within each facet.
  • searchbase
    Chooses a search base from the query xml. The default is defined there as well.
  • searchstart
    client|server|user; determines if the search is performed before (server) or after (client) the UI is sent to the client, or only after the users clicks the search button (user). For non-scripting clients, the default will be server.
  • allowemptysearch
    int (0 or 1) that allows the searchterm property to be empty.
  • nosearchwithin
    int (0 or 1) that hides or shows the Search within results checkbox.
  • nosearchprofile
    int (0 or 1) that hides or shows the Only search within titles checkbox.
  • helpitem
    Locator that points to a help page.
page int 1 The current page of results.
pagesize int 10 The number of results per page.
queryxml int The item number of the query xml used for this faceted search instance.
queryxmlname string Defines the query xml used for this faceted search instance by name. The query xml must exist in the folder /Configuration/Query Definition XMLs/ within the smartlet folder.
searchprofile string Determines the searchprofile to use. As of release 1.3 only supports "Search within title".
searchwithin int 0 Set to 1 to search within the current set of results.
orderby string searchrank DESC Determines how the results are ordered.
verbose int 0 Set to 1 to show debug information.

Other smartlet properties are only used internally:

Name Type Description
htmlfilters string HTML for the filters display that is returned to the client.
htmlnav string HTML for the navigation display that is returned to the client.
htmlresult string HTML for the search results that is returned to the client.
queryinfo JSON Object that defines all aspects of the current search. Stored in cookie and used for persistance.
rowcount int Number of results.
ratingscale int The absolute rating of the highest rated result. Used to calculate relative ratings.
action string Command used for navigation and persistance.
searchexpression string The previous search definition. Used for search within.
persistkey string Name or index for persistance.
persistproperty string UserProfileProperty name used for query persistance.
Features & Modules