Return to menu

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.

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.

1. 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.

2. 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.
3. On the Deploy All page (Primo Home > Deploy All), select the Deep Search Configuration option and click Deploy.
4. Add the deep search plug-in to the search scope in the Views Wizard.
5. Deploy the view.
6. EBSCO availability and delivery can also be configured at the institution level. For more information, see Configuring EBSCO Availability and Delivery.
7. 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.