Brief Search

Note: In the View Wizard, the code is defined in the Name field.

A search scope can include multiple local scope values and/or MetaLib quick-sets and/or Primo Central.

The Front End will decode the search scope in the same way that it does it for a search entered in the Primo Front End. Only one ‘search_scope’ parameter is allowed per request. For example:

http://host:port/primo_library/libweb/action/dlSearch.do?institution=PRIMO&query=any,contains,test&vid=Auto1&search_scope=blend

The deep-link will display the tab which is associated with the search scope. If the same search scope is used by several tabs and the ‘tab’ parameter is not included in the deep link, the system will display the first tab that includes the search scope. If a deep link specifies a search scope that is not defined for any tab, the system will display the first tab and the first search scope defined for the tab.

In earlier version the “loc” parameter was used, but in newer versions, we recommend using the search_scope instead.]

Supports 3 different search targets:

1) Local
2) Deep Search
3) Remote (Metalib) – If the results from a remote site are not in the MetaLib data format, Primo displays a link to the results in the Additional Results section, which appears first in the results.

In order to add a target to search on, add the following template to the URL:
loc=<target>,<location reference>

<target> possible values:

1) local – For a local search
2) adaptor – For a deep search
3) remote – For a remote search against Metalib

<location reference> possible values:

1) for local – define the scope to search on
Example: loc=local,scope:(VOLCANO)
2) for adaptor – need to define the name of the requested adaptor
Example: loc=adaptor,primo_central_multiple_fe
3) for remote – need to define a quick set name
Example: loc=remote,Business and Sciences

A single request will let you define as many search targets as you want, meaning, all 3 can be done in a single request.

Example for single search target:

http ://il-primo03:1702/PrimoWebServices/xservice/search/brief?institution=PRIMO&query=any,contains,book&indx=20&bulkSize=10&loc=local,scope:(VOLCANO)
Example for multi search (two)  targets:

http ://il-primo03:1702/PrimoWebServices/xservice/search/brief?institution=PRIMO&query=any,contains,book&indx=20&bulkSize=10&loc=local,scope:(VOLCANO)&loc=adaptor,primo_central_multiple_fe

Example for multi search (three)  targets:

http ://il-primo03:1702/PrimoWebServices/xservice/search/brief?institution=PRIMO&query=any,contains,book&indx=20&bulkSize=10&loc=local,scope:(VOLCANO)&loc=adaptor,primo_central_multiple_fe&loc=remote,Business and Sciences

Multiple scopes
You can search multiple scopes in 2 ways:
1) loc=local,scope:(VOLCANO,NORTH)
2) Use multiple loc parameters:
&loc=local,scope:(VOLCANO)&loc=local,scope:(NORTH)
There is a limitation to the order and which scopes can be used in such queries.
The limitation is according to the “Search Scopes” you have defined for each view.
To be sure what your “Search scopes” are, you can view the following file on your FE machine:
$primo_dev/ng/jaguar/home/system/conf/search_schema.xml

under the <filters> tag you will find all your configured search scopes:
<filters>
<filter>facet_frbrtype:(7 OR 6)</filter>
<filter>NOT scope:(“PRIMO”)</filter>
<filter>scope:(NORTH)  OR scope:(demo_digitool) OR scope:(“CENTRAL”)</filter>
<filter>scope:(BBR)</filter>
You are allowed to use only those scopes listed in the file and only use the order as in the file.
Mixing the order will not work, so &loc=local,scope:(NORTH, demo_digitool, “CENTRAL”) will work but &loc=local,scope:( demo_digitool, NORTH,”CENTRAL”) will not!
Searching against Primo Central
Searching against Primo Central is done via an adaptor.
Therefor as mentioned above, you will need to add the following:
loc=adaptor,primo_central_multiple_fe

&tab=mixed

According to the tab code configured in the view wizard

NOTE: the value sent, must be in lower case, even if the code contains upper case letters.

Specifies the type of sort to perform. If this parameter is not specified or left empty, the system uses the relevance sort. In addition to the relevance sort, Primo supports the following types of sorts:

• stitle – performs a title sort.
• scdate – performs a date sort in descending order.
• scdate2 – performs a date sort in ascending order.
• screator – performs an author sort.
• popularity – performs a popularity sort.

The valid values for this parameter are defined with the Index Field column in the Sort Fields Config mapping table. The direction of the sort is defined with the Direction column.

Use the following format to specify either a start and end range, a start date only, or an end date only:

&query=dr_s,exact,YYYYMMDD&query=dr_e,exact,YYYYMMDD

For example:
&query=dr_s,exact,19840201&query=dr_e,exact,99991231

NOTE: You must also specify a search query. For more information, see the query parameter above.

highlight
Indication whether highlights by server is required.
Possible values: true or false
Default: false

If highlight=true, you must specify one or more displayField parameters to indicate which fields to highlight.

displayField
defines in which field from the Display section of the PNX to highlight, if it contains the search term.
Possible values: PNX field names from the Display section.
You can define more than 1 displayField:
&highlight=true&displayField=title&displayField=creator

NOTE: the highlighting is done by wrapping the relevant section in the PNX with a <span> tag,
i.e. <span class=”searchword”>BOOK</span>

NOTE: If the Include Results with no full-text option is selected in the Views Wizard (Primo Home > Ongoing Configuration Wizards > Views Wizard), the Expand My Results option will be disabled in the Front End. Users will have to select the Full Text Online facet to display PC records that have full text only.