Configuring the EBSCO Plug-In

If you are configuring Primo VE, see Defining a Scope for a Third-Party Index.

The EBSCO search plug-in enables Primo to query and receive results from the EBSCOhost API. End users that are either logged on to Primo or using an on-campus terminal do not need to log on to EBSCO to search for EBSCO content.

The EBSCOhost API does not support the starts with option for title searches. The API will return all results, not just the titles that start with the search term.

By default, the EBSCO search plug-in maps the following EBSCO facets into Primo facet codes in order to display EBSCO facets in Primo:

JN(Journal) maps to jtitle in Primo
ZE(SubjectThesaurus) maps to topic in Primo

If the EBSCOhost API does not return a SubjectThesaurus facet, the EBSCO search plug-in will attempt to use one of the other EBSCO subject facets in the following order:QZ(Subject),ZG(SubjectCompany),ZO(SubjectGeographic), or QN(SubjectNAICS).

For blended searches, Primo maps the Resource type facet to the equivalent EBSCO search index. This means that the facets values do not come from EBSCO, but if chosen, a search is sent to EBSCO. If any other facet is selected, a search is not sent to EBSCO.

It is possible to add additional conversions by modifying the FacetConversion and QueryConversion parameters. For more information, see EBSCO Search Plug-In Parameters and Facet Code Mappings.

Because the EBSCOhost API does not return count values for facets, Primo handles the display of facet values as follows if the Primo view displays facets based on size:

For blended searches, Primo will not display the counts for any facets returned in the search.
For EBSCO-only searches, the order in which the facets values display is based on the order sent by the EBSCOhost API.
For blended searches, EBSCO facet values display at the bottom of the list, and their order is based on the order sent by the EBSCOhost API.

To configure an EBSCO seach plug-in:

On the Mapping Tables page (Primo Home > Advanced Configuration > All Mapping Tables), edit the Deep-Search Plugins mapping table and specify the following fields for the EBSCO local plug-in if it has not been defined or has been removed:
- Enabled – Select this check box to enable the plug-in.
- Plugin ID –EbscoLocal
  
  You can configure a different EBSCO search plug-in for each institution so that they insert their own EBSCOhost API key. At the institution level, use the following naming convention to define a different deep search plug-in for an institution:
  
  EbscoLocal_<institution_code>
- Plugin Class –ebsco.local.EbscoDeepSearch
- Plugin Display Name - Enter the display name (such as EBSCO).
- Description – Enter an optional description (such as Primo to EBSCO search).
For general information on how to use mapping tables, see Editing Mapping Tables.
On the Mapping Tables page (Primo Home > Advanced Configuration > All Mapping Tables), edit the Deep Search Plugin Parameters mapping table and specify the following fields for each EBSCO parameter that you want to modify:
- Enabled – Select this check box to enable the parameter.
- Param name – Specify the name of the parameter (see EBSCO Search Plug-In Parameters).
- Param value – Specify the value of the parameter if encryption is not needed (see EBSCO Search Plug-In Parameters).
- Param value - Encrypted – Specify the value of the parameter if encryption is needed. Use this field to encrypt sensitive information (such as keys and passwords).
- Plugin – Select the plug-in ID of the plug-in that uses the parameter.
- Description – Specify text that describes the functionality of the parameter. This field is optional.
On the Deploy All page (Primo Home > Deploy All), select the Deep Search Configuration option and click Deploy.
Add the deep search plug-in to the search scope in the Views Wizard.
Deploy the view.
EBSCO availability and delivery can also be configured at the institution level. For more information, see Configuring EBSCO Availability and Delivery.
Test the view. If you want to run a test outside of Primo for comparison, see How can we test the EBSCOhost API outside of Primo.

EBSCO Search Plug-In Parameters

The following table lists the valid parameters for the EBSCO search plug-in:

EBSCO Parameters
EBSCO Parameter	Description
URL	Enter the following URL for the EBSCOhost API: http://eit.ebscohost.com/Services/SearchService.asmx/Search
USERNAME	Enter your EBSCO user name.
PASSWORD	Enter your EBSCO password.
DB	Enter a list of the short EBSCO database names separated by a comma. For example: rlh,ahl,8gh,lxh,eoh,buh,rvh,oah,rfh,reh, vah,sbh,loh,jph,rph
TIMEOUT	Specify the timeout period for EBSCO queries in milliseconds (such as 30000).
FacetConversion	If you want to display additional facets for EBSCO results, you must list the mapping details for each additional EBSCO facet, separated by a semicolon. Each facet mapping must contain the EBSCO facet code followed by the Primo facet code, separated by a comma. For example: JN,jtitle;ZE,topic For more information, see Facet Code Mappings.
QueryConversion	If you want to display results that have been filtered by clicking an EBSCO facet within Primo, you must list the mapping details for each additional EBSCO facet, separated by a semicolon. Each facet mapping must contain the Primo facet code followed by the EBSCO facet code, separated by a comma. You must prefix each Primo facet code with facet_. For example: facet_jtitle,JN;facet_topic,ZE For more information, see Facet Code Mappings.
rtype_to_ebsco	This parameter maps the Primo resource type to the EBSCO types. Every Primo type should be mapped to a single EBSCO type, but different Primo types can be mapped to the same EBSCO type. The format should be <primo type>,<ebsco type>, and each additional mapping should be separated by a semicolon. For example: other,Abstract;articles,Article;other, Bibliography; If this parameter is not specified, Primo will use the default mappings (see Resource Type Mappings). For more information on this parameter, see Resource Facets Are Not Applied to Results from EBSCO Search Plug-In.
ebsco_to_display_type	This parameter maps the EBSCO resource type to the Primo display/type field. Every EBSCO type should be mapped to a single Primo type. The format should be <ebsco type>,<primo type>, and each additional mapping should be separated by a semicolon. For example: Abstract,other;Article,article; Bibliography,other; If this parameter is not specified, Primo will use the default mappings (see Display Type Mappings).
ebsco_to_ris_type	This parameter maps the EBSCO resource type to the Primo addata/ristype field. Every EBSCO type should be mapped to a single Primo type. The format should be <ebsco type>,<primo type>, and each additional mapping should be separated by a semicolon. For example: Abstract,GEN;Article,JOUR;Bibliography, GEN;Biography,BOOK; If this parameter is not specified, Primo will use the default mappings (see RIS Type Mappings).
ebsco_to_format_type	This parameter maps the EBSCO resource type to the Primo addata/format field. This is a one-to-one relation, which means that every EBSCO type must be mapped to a single Primo type. The format should be <ebsco type>, <primo type>, and different mappings should be separated by a semicolon. For example: Abstract,book;Article,journal;Bibliography,book;Biography,book If this parameter is not specified, Primo will use the default mappings (see Format Type Mappings).
ebsco_to_genre_type	This parameter maps the EBSCO resource type to the Primo addata/genre field. This is a one-to-one relation, which means that every EBSCO type must be mapped to a single Primo type. The format should be <ebsco type>, <primo type>, and different mappings should be separated by a semicolon. For example:<primo><ebsco> Abstract,unknown;Article,article; Bibliography,unknown;Biography,book; If this parameter is not specified, Primo will use the default mappings (see Genre Type Mappings).
port	Not in use for EBSCO, but it is used for Primo-to-Primo adaptors.
scope	If you want to specify a default scope, enter the scope name. Otherwise, enter none.
cache/enable	Set to true to enable result caching. When disabled, every full display initiates a new search.
cache/batchsize	Specify the number of results to store in the cache. Do not configure a large number. Between 10 to 20 results are recommended.
primo_services/primo_rank	If you blend EBSCO with other SEs (such as Primo local and Primo Central), it is recommended to set this parameter to true, which indicates that Primo will apply its own ranking algorithm to the records returned by EBSCO to blend the results.
primo_services/primo_facets	If set to true, Primo will build the facets in the results set and will base them on the facet section of the PNX, assuming that it exists. If set to false, the results set is assumed to already have a facets section.
primo_services/primo_highlighting	Set to true if you want highlighting to appear in the returned results.
warmup/enable	Set to false. If set to true, Primo will warm up the plug-in by sending queries to your plug-in before adding it to Primo's search. This is not necessary for the EBSCO search plug-in.

Facet Code Mappings

The following table lists the valid Primo facet codes and their associated fields in the PNX.

Primo Facet Codes
Facet Code	PNX Facet Section Field Name
creator	creatorcontrib
lang	language
rtype	rsrctype
topic	topic
tlevel	toplevel
pfilter	prefilter
creationdate	creationdate
domain	collection
fsize	filesize
fmt	format
jtitle	jtitle
library	library
local <n>	lfc <n>

Resource Type Mappings

The following table lists the default mappings for the Primo resource type to EBSCO resource type:

Primo Resource Type to EBSCO
Primo r_type	EBSCO
other	Abstract
articles	Article
other	Bibliography
books	Biography
books	Book
book_chapter	Book Chapter
reviews	Book Review
books	Case Study
conference_proceedings	Conference Paper
reviews	Course Review
images	Cover Art
books	Directory
other	Editorial
reviews	Entertainment Review
other	Erratum
books	Essay
other	Excerpt
images	Image
other	Interview
other	Letter
books	Literary Criticism
other	Obituary
other	Poem
reviews	Poetry Review/Criticism
conference_proceedings	Proceeding
reviews	Product Review
other	Recipe
reference_entrys	Reference Entry
other	Science Experiment
books	Short Story
reviews	Short Story Review
other	Speech
books	Table of Contents

Display Type Mappings

The following table lists the default mappings for the EBSCO resource type to the Primo display type:

EBSCO Type to Primo Display Type
EBSCO Type	Primo display/type
Abstract	other
Article	article
Bibliography	other
Biography	book
Book	book
Book Chapter	book_chapter
Book Review	review
Case Study	book
Conference Paper	conference_proceeding
Course Review	review
Cover Art	image
Directory	book
Editorial	other
Entertainment Review	review
Erratum	other
Essay	book
Excerpt	other
Image	image
Interview	other
Letter	other
Literary Criticism	book
Obituary	other
Poem	other
Poetry Review/Criticism	review
Proceeding	conference_proceeding
Product Review	review
Recipe	other
Reference Entry	reference_entry
Science Experiment	other
Short Story	book
Short Story Review	review
Speech	other
Table of Contents	book

RIS Type Mappings

The following table lists the default mappings for the EBSCO resource type to the Primo RIS type:

EBSCO Type to Primo RIS Type
EBSCO Type	Primo addata/ristype
Abstract	GEN
Article	JOUR
Bibliography	GEN
Biography	BOOK
Book	BOOK
Book Chapter	BOOK
Book Review	GEN
Case Study	BOOK
Conference Paper	JOUR
Course Review	GEN
Cover Art	GEN
Directory	BOOK
Editorial	GEN
Entertainment Review	GEN
Erratum	GEN
Essay	BOOK
Excerpt	GEN
Image	GEN
Interview	GEN
Letter	GEN
Literary Criticism	BOOK
Obituary	GEN
Poem	GEN
Poetry Review/Criticism	GEN
Proceeding	JOUR
Product Review	GEN
Recipe	GEN
Reference Entry	GEN
Science Experiment	GEN
Short Story	BOOK
Short Story Review	GEN
Speech	GEN
Table of Contents	BOOK

Format Type Mappings

The following table lists the default mappings for the EBSCO resource type to the Primo format type:

EBSCO Type to Primo Format Type
EBSCO Type	Primo addata/format
Abstract	book
Article	journal
Bibliography	book
Biography	book
Book	book
Book Chapter	book
Book Review	book
Case Study	book
Conference Paper	book
Course Review	book
Cover Art	book
Directory	book
Editorial	book
Entertainment Review	book
Erratum	book
Essay	book
Excerpt	book
Image	book
Interview	book
Letter	book
Literary Criticism	book
Obituary	book
Poem	book
Poetry Review/Criticism	book
Proceeding	journal
Product Review	book
Recipe	book
Reference Entry	book
Science Experiment	book
Short Story	book
Short Story Review	book
Speech	book
Table of Contents	book

Genre Type Mappings

The following table lists the default mappings for the EBSCO resource type to the Primo genre type:

EBSCO Type to Primo Genre Type
EBSCO Type	Primo addata/genre
Abstract	unknown
Article	article
Bibliography	unknown
Biography	book
Book	book
Book Chapter	book
Book Review	book
Case Study	book
Conference Paper	journal
Course Review	unknown
Cover Art	unknown
Directory	book
Editorial	unknown
Entertainment Review	unknown
Erratum	unknown
Essay	book
Excerpt	unknown
Image	unknown
Interview	unknown
Letter	unknown
Literary Criticism	book
Obituary	unknown
Poem	unknown
Poetry Review/Criticism	unknown
Proceeding	journal
Product Review	unknown
Recipe	unknown
Reference Entry	unknown
Science Experiment	unknown
Short Story	book
Short Story Review	unknown
Speech	unknown
Table of Contents	book