Query parameters
Release 1.3 - ...
To create two-way communication between the different Smartlets in a non-scripting environment, Faceted Search works extensively with querystring parameters.
General parameters
| Parameter | Value | Description |
|---|---|---|
| q | Search directly from the query string. Used by the "did you mean" links. | |
| action | reset | To reset the search term and all user-added filters. |
Adding filters
| Parameter | Value | Description |
|---|---|---|
| facet | Name of the facet from which the filter is added. | |
| key | Key for the filter, as used in the associated WHERE clause. | |
| name | Friendly name, used by the filter display. | |
| multi | Multi-select mode [single|or|and]. |
Example: ?facet=searchterm_topx&key=52&name=iXperion&multi=single
Removing filters
| Parameter | Value | Description |
|---|---|---|
| filter | Name of the filter to be removed. | |
| remove | true |
Persist query
To load or delete a query from a user profile the following parameters are used:
| Parameter | Value | Description |
|---|---|---|
| action | load | Load a query from a user profile. |
| action | delete | Delete a query from a user profile. |
| index | Zero-based index of the query to be loaded or deleted. | |
| prop | Name of the personalisation property where the queries are stored. |
Example: ?action=load&index=0&prop=sml_facetedsearch_persist_1_saved1234
Loads the first stored query for the Faceted Search smartlet on page 1234.
Paging in facets
To expand or collapse the list of entries in a facet the following parameters are used:
| Parameter | Value | Description |
|---|---|---|
| facet | Name of the facet that is being expanded or collapsed. | |
| maxrows | The maximum number of items in the list. |
Please note that because only a single facet is passed in the query string, expanding a facet will automatically collapse any other facet that was expanded.