Alma, Primo VE, and the Dec. 2021 EBSCOhost Parser Changes

January 20, 2022

Background

Since moving to Alma and Primo VE, I-Share libraries may have experienced some connectivity issues to EBSCOhost full-text e-collections.  These problems are not unique to I-Share but are universal to many customers using Alma/Primo VE and EBSCOhost.  Libraries using OpenAthens have had particular difficulties with linking to EBSCOhost resources from Primo VE.

Over the past year, EBSCO and Ex Libris have worked together to improve these issues for their customers.  In May 2021, EBSCO introduced a new OpenURL connector, and in December 2021, Ex Libris announced and distributed a new Linking Parser called EBSCO_HOST::Journals for 188 EBSCOhost full-text e-collections. This combination of changes should help to improve connectivity from Primo VE.

Note that this Parser change only applies to the 188 full-text e-collections listed in the Excel file in the Ex Libris Knowledge Article. Most e-book e-collections are not currently included.

Actions for I-Share Libraries

An I-Share Library using any of the 188 revised EBSCOhost e-collections should edit the e-collections in their Institution Zones (IZs) as described below in order to provide the most effective linking to articles and journals in these EBSCOhost e-collections.  This especially applies to libraries experiencing linking difficulties using OpenAthens and EBSCOhost full text e-collections from Primo VE who may have made previous configuration changes to override parser parameters in one or more of these e-collections in an attempt to improve linking.

1. In your institution's CARLI Box folder, locate the two files that CARLI has provided, where XXX your library’s three letter I-Share code:

  a. XXX > XXX Credentials > "XXX_EBSCOhost OPID info.xlsx".  This file contains:

• Your institution's EBSCO Customer ID for the CUSTOMER_ID field as provided to CARLI by EBSCO.  If you have any questions about this ID, please contact EBSCO Support directly.
• The OPID for the OPID field. If you have any questions about this ID, please contact EBSCO Support directly.
• A base OpenURL unique to your institution that can be used for other testing outside of Alma. You do not need to input this information anywhere in Alma.
• If your institution has more than one EBSCO customer account for separate libraries or campuses, all of them will be listed in this file.  Apply the appropriate Customer ID and OPID to each e-collection in Alma as described below.

  b. XXX > "XXX EBSCOhost Ecollections new parser list.xlsx". This report contains a list of affected EBSCO e-collections in your Institution Zone (IZ) with:

• The E-Collection ID and Name in your IZ
• The E-Collection ID from the Community Zone (CZ)
• The Parser being used
• The default Parser Parameter and if a Parser parameter (override) is in place

If there is no "XXX EBSCOhost Ecollections new parser list.xlsx" file in your institution's XXX Box folder (ALP, IEC, LAC, MLS, NBY, SFM, SSC, SEI, SWI), your IZ does not contain any of the affected e-collections and there are no changes that you need to make at this time.

2. Search for the electronic collection in Alma by Name or ID.

3. In the results list of e-collections, click the ellipsis and choose Edit Service to edit the Full Text service in the Electronic Service Editor.

4. Click on the Linking tab and look at the Parser:

If the Parser shows "EBSCO_HOST::Journals" AND the Parser parameters (override) box is blank:

  a. Scroll down the page to the "Linking Parser Parameters" section and enter your institution's CUSTOMER_ID and OPID from the "XXX_EBSCOhost OPID info.xlsx" sheet, if they are not already present.

• Examples in the screenshot below are fake CUSTOMER_ID and OPIDs; be sure to input the correct IDs for your institution!
• If there are any other values for other parameters already filled into the SHIBBOLETH, SSO, or IPAUTH fields, leave them as is; do not add, edit, or remove.

  b. Click Save in the upper right corner to save the changes.  The change for this e-collection is complete. 

  c. Test the e-collection connectivity in Primo VE and make sure that it links out as expected. If you already had a record or citation open in your browser before the change, reload the page or redo the search in Primo VE before testing.

Stop here and repeat steps 2-4 above for the next e-collection in your CARLI-provided list.

If the Parser shows "EBSCO_HOST::Journals" AND there is something in the Parser parameters (override) box:

This means that the Parser had been locally customized in your IZ e-collection in the past. Several I-Share libraries that use OpenAthens had customized EBSCOhost Parser parameters in order to improve linking, but now, these customizations are no longer needed.

  a. Double-check that the default Parser parameters now includes the new string (probably at the end): &opid=$$OPID

If the Parser parameters does not include &opid=$$OPID, make a note and proceed through the remaining steps, then check it again after step f below.  If it still does not contain the string after you have completed all the steps through step f below, contact CARLI Support for assistance.

  b. Remove the contents of the Parser parameters (override) box.

  c. Click Save in the upper right corner.  The Electronic Service Editor will close.

  d. Reopen the Electronic Service Editor and go to the Linking tab.

  e. Double-check that the Parser Parameter (override) information has been removed, then scroll down to the "Linking Parser Parameters" section and enter your institution's CUSTOMER_ID and OPID from the "XXX_EBSCOhost OPID info.xlsx" sheet if they are not already present.

• Examples in the screenshot below are fake CUSTOMER_ID and OPIDs; be sure to input the correct IDs for your institution.
• If there are any other values for other parameters already filled into the SHIBBOLETH, SSO, or IPAUTH fields, leave them as is; do not add, edit, or remove.
• If the OPID field is not present at all, contact CARLI Support for assistance.

  f. Click Save in the upper right corner to save the changes.  The change for this e-collection is complete. 

  g. Test the e-collection connectivity in Primo VE and make sure that it links out as expected. If you already had the record or citation open in Primo VE before the change, reload the page or redo the search in Primo VE before testing.

Repeat steps 2-4 above for the next e-collection in your CARLI-provided list.

If the Reports Shows the Parser "EBSCO_HOST::ebsco_am"

This likely means that either there is no Active Service for this e-collection, or if there is a Service there are no Active Portfolios.  If you do not need this e-collection in your IZ, CARLI recommends that you delete it.  If this e-collection should be Active and is not, CARLI recommends that you delete it and re-add it afresh from the Community Zone (CZ) so that it will get the updated Parser information.  Once you've re-added the e-collection from the CZ, it should show the new EBSCO_HOST::Journals Parser and Parser Parameters.  Activate it as usual and then proceed with the steps listed above to fill in the CUSTOMER_ID and OPID.

Frequently Asked Questions

Q: Does this change affect all I-Share institutions?

A: This affects any I-Share library that has activated any of the specified 188 EBSCOhost e-collections in their Alma IZ and whose users access them through Primo VE.

Q: What is the deadline for making these CUSTOMER_ID and OPID changes to the Full Text SErvice in Alma?

A: There is no set deadline, but EBSCO and Ex Libris say this is the recommended method for connecting to these 188 EBSCOhost e-collections through Primo VE, so you should make the changes as soon as possible in order to provide the best experience to your users.

Q: We haven't made these changes but linking to EBSCOhost e-collections is working fine. Should We still make theSe changes?

A: Yes, for the 188 e-collections specified by Ex Libris, it is recommended by EBSCO and Ex Libris (and therefore by CARLI) that you add your institution's CUSTOMER_ID and OPID as described above.

Q: What are the SHIBBOLETH, SSO, and IPAUTH fields in the Linking Parser Parameters section? Should I fill those in?

A: These other three configuration options in the Full Text Service may be filled in depending on how your institution has configured your connections in EBSCOhost Admin. If there are any data in these fields already, leave those entries as is.  If you continue to have connection problems even after entering your CUSTOMER_ID and OPID information, please report this to CARLI Support and we may suggest adding other information to these fields based on your institution's EBSCOhost Admin configurations.

Q: Is this for EBSCOhost e-journals only? What about EBSCOhost e-books?

A: This change is currently only for the 188 mostly e-journal e-collections indicated by Ex Libris.  If Ex Libris announces that additional e-collections or e-books require changes in the future, CARLI will communicate that to I-Share libraries and update this page.

Q: What about EBSCOhost e-collections in the NZ, how do I update those?

A: CARLI staff will update the affected EBSCOhost e-collections in the NZ.

Q: What is the Alma EBSCO link resolver plugin? Do I need to make any changes to that?

A: The Alma EBSCO link resolver plugin was an Integration Profile in Alma that was recommended for all I-Share libraries when we migrated to Alma in June 2020. That plugin has been made obsolete by the new EBSCO OpenURL connector and new Linking Parser.  CARLI staff will make sure that this plugin has been removed from all I-Share IZs; there is nothing for I-Share libraries to do.

Please send any other questions to CARLI Support at support@carli.illinois.edu.