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

Owned by John Seguin
Last updated: yesterday at 7:39 pm by Lora Hanson
5 min read

Note: this guide is for the “New” version of EDS. For the “Classic” version of EDS please see the appropriate guide.

Is your group trialing the new UI but still using the classic interface?
If so, please do not proceed with this integration yet. EBSCO advises transitioning to the new UI first (documentation), otherwise a conflict with classic EDS/ehost links will occur.

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:

Transition to the new UI is complete (classic interface is noy being used).
Third Iron library ID# and API key.
Access to the new EBSCO Experience Manager for LibKey Library ID & API configuration.
(See Requesting access to EEM for more details).
An EBSCO Connect account so new EDS migration and any missing information such as the OPID or EBSCO accounts access can be requested.
Access to EBSCOadmin:
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. Please see the overview of link options in (part 2) before selecting a configuration guide (part 3).

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, you 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).

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.

Part 2: Available link options explained

  • “LibKey Retraction (New Interface)” : Will appear if there is a retraction notice for that article. Select in EDS to learn more about the retraction.

  • “LibKey - Instant PDF (New Interface)”: These links always resolve to a PDF.

  • “LibKey - Article in Context (New Interface)”: Jumps to the article listed in context of the issue, volume and year of publication in BrowZine.

  • “LibKey - Current Journal Issue (New Interface)”: Navigates to the current issue of the journal in BrowZine

    • Note: If adding this option, in the Mandatory Fields, edit catXXXXXa to match your EDS Custom Catalog dbcode (found in the databases tab of your EDS profile).

Part 3: Customization Options with Recommended Settings

This is the standard configuration: Retracted Article, LibKey Instant PDF, and View Complete Issue.

LibKey CustomLink set up in EBSCOadmin:

  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 and select LibKey - Retraction (New Interface).

  7. Click Submit to save your changes.

  8. Repeat Steps 3-7 to add your other LibKey CustomLinks: LibKey Instant PDF, View Complete Issue, and View Journal.

  9. Next, add the links to your profile. Click the Customize Services tab, select your EDS profile and then click the Linking sub-tab.

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

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

  12. Click Submit. Your changes are saved.

  13. Now let’s give these links a new rank order: Click the Linking tab and then select the Modify link to the right of Custom Links (jump link). EBSCO and Third Iron recommend that LibKey - Retraction be given an Order value of 1 in the CustomLink list, so when an article has been retracted, this link appears above other links. We recommend LibKey Instant PDF be given an Order value of 2, View Complete Issue an Order value of 3, and Current Journal Issue an Order value of 4.

  14. Click Submit to save your changes.