New EBSCO Discovery Service Overview and Step-by-Step Implementation Guide

Owned by John Seguin
Last updated: Jun 23, 2023 by Lora Hanson

EBSCO Discovery Service Integration Overview

The main purpose of the EDS integration is to enhance the user experience for EDS users bringing the power of LibKey Linking into EDS and to promote journal engagement through the use of View Complete Issue links. Additionally, all integrations include cover images from the BrowZine API to provide a cohesive experience between EDS and BrowZine as well as include Retracted Article designations when appropriate. Select that link to learn more about the retraction via LibKey.

Integration Location

As shown in the screenshot above, all integrations are visible from the “Access now” drop-down that appears beneath each article result. If available, a LibKey full text link will appear.

Assumptions/Needs to be Known Before Getting Started:

Third Iron library ID# and *API key (preferably noted on our side for EDS use).
Access to the new EBSCO Experience Manager for LibKey Library ID & API configuration. Requesting access to EEM.
An EBSCO Connect account so new EDS migration + any missing info such as the OPID or EBSCO accounts access can be requested.
Access to EBSCOadmin with/for:
The “Site/Group Maintenance link” needs to be visible in the upper right corner.
(If missing, submit a ticket with EBSCO Support.)Access to CustomLink configuration and link order ranking.

Instructions:

The LibKey Integration has settings in both the EBSCO Experience Manager (part 1 listed below) and EBSCOadmin (part 2). Part 3 is purely optional.

Part 1: Steps for Setting up LibKey in EBSCO Experience Manager/Configuration:

  1. In EBSCO Experience Manager, go to Configuration, click Integrations in the menu on the left and select the LibKey Integration. This one setup works for all of the LibKey links and cover images.

  2. This Integration will be set for all your profiles by default. Alternatively, you can select an individual profile to edit from the drop-down.

  3. To be able to modify this form, select the radio button next to Custom.

  4. Enter the following required values:

  • Third Iron library ID #

  • LibKey API key (copy all characters, dashes included)

Note: when first entering the API key, users might see a temporary, red text message appear stating that “LibKey API key does not match expected pattern”. Wait about 30+ seconds for that message to disappear.

5. Enable this integration (required): Once you have the above information set up the way you wish, turn this to Show to have this Integration appear in the selected profile(s).

When not enabled, the button is gray and says “Hide” next to it. When enabled, it turns green.

6. Click on the Publish button to push the Integration to your profile(s).

7. A modal window will open confirming the site or profile your new parameters will be applied on. Click Submit to continue.

8. A “Success” banner will appear at the top of the Custom Placard Integration page if your parameters are successfully updated. If there are any errors, a banner with a description of the issue will appear. If you are having trouble with this integration, please visit EBSCO Connect to contact support.

  1. Log in to EBSCOadmin at http://eadmin.ebscohost.com.

  2. Click the Site/Group Maintenance button, then click on Go below CustomLinks.

  3. Click on Add New CustomLink.

  4. Select Copy from existing CustomLink and click on Continue.

  5. Select Full Text from the Category drop down list.

  6. Click on ++show other available CustomLinks.

  7. Select LibKey OpenURL Link.

  8. In the Basic Settings section, add your LibKey institution ID (a numeric value) to the BaseURL in place of the text “[[LibKeyID]]” and click Submit.

     

9. All rest of the necessary fields have already been filled in for you. Please fill in or adjust any of remaining fields that meet your library's needs.

Note: Whatever is typed into the “Link Text” field is what users will see to click on in EDS.

Full Text Finder customers:
If you would like the LibKey Link to appear *ONLY* when full text is available in your collection (which is likely how your EBSCO Full Text Finder Link was operating), then:

  1. Change the Show Link radio button to "If Item is in Collection".

  2. Scroll through the Local Collections for Filter until you find a link called "Online holdings as defined in AtoZ" ({Profile_Name}) - with that Profile Name being something unique to your library. If you are part of a consortia you may see multiple profiles listed so use this to choose the one appropriate for your local collection.

10. Next, add the link to your profile. Click the Customize Services Tab, select your profile and then click the Linking Sub-Tab.

11. Click the Modify link to the right of CustomLinks.

12. Click Add New CustomLink and mark the Select box to the left of the “LibKey OpenURL Link”.

13. Click Submit to save your changes.

It will take up to 24 hrs for changes to be reflected. Any CustomLinks with (New Interface) in the name will only be visible through their new discovery URL with OPID and not in the classic EDS; so check the new EDS UI directly instead of using the “View changes in EBSCO” link provided within EBSCOadmin:

https://discovery.ebsco.com/c/{OPID}

Pro-tip: Assuming the profile is configured for guest access, you might be able to view it at: https://discovery.ebsco.com/c/{OPID}/?acr_values=guest

Here’s an example of what it looks like when you’ve successfully added LibKey OpenURL Link to your full text links for EDS (note: your link order # might be different than what’s pictured below; you can reorder as desired):

There are no EBSCOadmin settings for cover images; that’s taken care of in part 1 through the Experience Manager API configuration.

Part 3: (*Optional; not recommended)
Advanced customization to include all LibKey linking options in Access Options drop-down menu, including Retraction, Instant PDF, and Article in Context links

 

  1. Log in to EBSCOadmin at https://eadmin.ebscohost.com.

  2. Click the Site/Group Maintenance button, then click Go below CustomLinks.

  3. Click Add New CustomLink.

  4. Select Copy from existing CustomLink and click Continue.

  5. Select Full Text from the Category drop down list.

  6. Click ++show other available CustomLinks.

  7. Select one of the LibKey CustomLinks to get started:
    “LibKey - Article in Context (New Interface)”
    “LibKey - Current Journal Issue (New Interface)” → *If adding the “LibKey - Current Journal Issue” CustomLink, in the Mandatory Fields, edit catXXXXXa to match your EDS Custom Catalog dbcode. This can be found in the databases tab of your EDS profile.
    “LibKey - Instant PDF (New Interface)”
    “LibKey - Retraction (New Interface)”

  8. Note: The other CustomLink settings should not be modified.

  9. Click Submit.

  10. Repeat Steps 3-10 for any other LibKey CustomLinks you want to add.*

*Do not immediately proceed to the next step yet. It’s highly recommended to have users go back and add the additional “LibKey” options in #7 bullet points before continuing.

11. Next, add the links to your profile. Click the Customize Services tab, select your profile [EBSCO Discovery Service (eds) - eds ] and then click the Linking sub-tab.

12. Click the Modify link to the right of CustomLinks.

13. Click Add New CustomLink and mark the Select box to the left of the LibKey CustomLinks you just added.

14. Click Submit. Your changes are saved. Repeat steps 12-15 for any other profiles to which you want to add your CustomLink.

15. If adding the LibKey - Retraction (New Interface) CustomLink, it is recommended to an Order value of 1 in the CustomLink list, so when an article has been retracted, this link appears above other links.

Example:

EBSCOadmin Customize Services Linking linking tab with CustomLink ranked order