Facet sidebar

Example

In this example some of the keyword search facet block settings are displayed. To view these:

1. Go to OPAC> Configuration Settings.
2. Choose the search Configuration Settings by Config Block.
3. Search using Config Block: g_kws2; Setting: fb_; Interface: [1 or 2..etc..if relevant]

[Related values grouped together]      

Any or all of these can be modified to change the heading or the text displayed when no records are found.

Sidebar header

The text at the top of the facets sidebar is taken from the fb_sidebar_header in the Configuration Block for that search.

For example the text for the sidebar header in the keyword search is:

• Refine your search by:-

Clear all

This appears by default at the top of the Facet block

If you want to change the text:

1. Create 2 new settings in the configuration block g_sidebar:

• Create the setting clearall_checkbox_label to specify the label.
• Create the setting clearall_checkbox_title to specify the hover text.

2. Enter the new text in double quotes.
3. Set Sequence 2= 0.

Overview

To configure a search with pre-selected facets to be included in the Search menu:

1. Create a new Configuration Block that represents the new pre-filtered search.
2. Add several new configuration settings that belong to the new configuration block.

OLIB is supplied with a sample configuration block to help you with the configuration. It can be copied and modified accordingly:

• g_pf_sample

Go to OPAC> OPAC Config Block and search for g_pf% if you want to view this file.

The steps below show you how to create a new g_pf_XXXX similar to the sample above. This uses a new search called "Serials" as an example.

Create a new Config Block

Create a new configuration block representing the pre-filtered search, with a name comprising the g_pf_ prefix plus a suitable mnemonic, e.g. g_pf_serials:

1. Go to OPAC> OPAC Config Block.
2. Click New Record.
3. In Config Block Name enter g_pf_serials.
4. Enter a value in Description, e.g. Serials.

Create new configuration settings

The new settings below all belong in the new configuration block, e.g. g_pf_serials.

Create each setting as follows:

1. Go to OPAC> Configuration Settings.
2. Click New Record.
3. Enter details for each of the settings as shown in the examples below. Config Block Name = g_pf_serials for all of them.

(a) Create the pre-faceted search in Folio's Search Options box:

1. Go to OPAC> Configuration Settings.
2. Click New Record to create an smenu_options setting for the g_pf_serials config block. Enter as follows:

smenu_options

Config Block Name	g_searchmenu
Setting	smenu_options
Description	Serials search
Value	"pf_serials"
Value 2	"Serials"
Value 3
Allowable Values
Sequence 1	1
Sequence 2	8
Include?	Ja

Value should be set to the Config Block Name without the "g_" prefix, e.g. pf_serials. This will then include the search in the Folio Search Options menu.
Value 2 will be the name displayed in the Search Options menu.
This will add an entry in the smenu_options array to represent the pre-faceted search.

(b) Add text for top of facets sidebar

1. Go to OPAC> Configuration Settings.
2. Click New Record to create an fb_sidebar_header setting for the g_pf_serials config block. Enter as in this example:

fb_sidebar_header

Config Block Name	g_pf_serials
Setting	fb_sidebar_header
Description
Value	"Refine your search by:-"
Value 2
Value 3
Allowable Values
Sequence 1	1
Sequence 2	0
Include?	Ja

This displays "Refine your search by:-" at the top of the facets sidebar when the search option is selected.

(c) Create a pf_xxx_facets array setting

Add a pf_xxx_facets array with at least one entry for the facet that is being pre-filtered on. For example, if the pre-filtered search limits the search to serials, include an entry in the pf_serials_facets array for “mtp” (media type).

1. Go to OPAC> Configuration Settings.
2. Click New Record to create a pf_serials_facets setting for the g_pf_serials config block. Enter as in this example:

pf_serials_facets

Config Block Name	g_pf_serials
Setting	pf_serials_facets
Description
Value	"mtp"
Value 2
Value 3
Allowable Values	A valid facet name
Sequence 1	2
Sequence 2	1
Include?	Ja

(d) Add fb_header_mtp settings

This is to display some text at the top of the facet blocks with entries in the e.g. pf_serials_facets array.

1. Go to OPAC> Configuration Settings.
2. For example click New Record to create a fb_header_mtp setting for the g_pf_serials config block. Enter as in this example:

fb_header_mtp

Config Block Name	g_pf_serials
Setting	fb_header_mtp
Description
Value	"Format"
Value 2
Value 3
Allowable Values	Any text
Sequence 1	3
Sequence 2	0
Include?	Ja

(e) Create preselected facet setting

Add a presel_facet_xxx setting for each facet that is to be pre-filtered. The Value field should contain a semi-colon separated list of the key IDs of the facet items that are to be pre-selected, surrounded by double quotes. For example, if the search is to be pre-filtered for books and serials, add a presel_facet_mtp setting with BKM;SER in the Value field.

1. Go to OPAC> Configuration Settings.
2. For example, click New Record to create a presel_facet_mtp setting for the g_pf_serials config block. Enter as in this example:

presel_facet_mtp

Config Block	g_pf_serials
Setting	presel_facet_mtp
Description
Value	"SER;SART"
Value 2
Value 3
Allowable Values	A semi-colon separated list of the key IDs of the facets that should be pre-selected, e.g. "SER;SART".
Sequence 1	4
Sequence 2	1
Include?	Ja

(f) Create searchfields array

Add a searchfields setting to specify which search input fields should be displayed when the search option is selected:

1. Go to OPAC> Configuration Settings.
2. For example click New Record to create a searchfields setting for the g_pf_serials config block. Enter as in this example:

searchfields

Config Block	g_pf_serials
Setting	searchfields
Description	A list of search fields, optional labels, hovertext and in-field prompts for the search boxes.
Value	"The Serial title"
Value 2	"The first few words of the title of the item you are looking for"
Value 3	"Enter one or more words and click Search (or hit Enter) to find records with a title beginning with the words you entered"
Allowable Values	Value 1 is the search field. It must start with one of , nbame, keywords,subject, isbn,, c;lassmark, ctrl or note10. This can then be followed by a space and a label for the search box if desired. Value 2 is the search field's hover text. Value 3 is the in-field help text.
Sequence 1	5
Sequence 2	1
Include?	Ja

(g) Configure a title or keyword search

Add a BaseCB setting with either tiau or kws2 in the Value field to specify whether a title search or a keyword search should be run.

Go to OPAC> Configuration Settings.
Click New Record to create a BaseCB setting for the g_pf_serials config block. Enter as in this example:

BaseCB

Config Block	g_pf_serials
Setting	BaseCB
Description
Value	"tiau"
Value 2
Value 3
Allowable Values	The type of search that should be run. "tiau" represents a title search. "kws2" represents a keyword search.
Sequence 1	6
Sequence 2	0
Include?	Ja

New settings take effect when you next reload Folio.