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

Owned by John Seguin
Last updated: May 24, 2024 by Lora Hanson
13 min read

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

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

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.

  • “LibKey OpenURL Link” : This is LibKey Link which will offer options depending on your configuration with Third Iron. If format chooser is enabled, then article links may appear alongside PDF options and retraction notices will appear when applicable. Otherwise, if go to full text is enabled, PDFs would be prioritized.

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

  • “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 - 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).

Option 1

This is the standard configuration (Retractions, LibKey Link, and LibKey Article in Context)

Step 1 for setting up LibKey Link 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 OpenURL Link.

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

    LibKey Link configuration details with unique libraryID emphasizedLibKey Link configuration details with unique libraryID emphasized

 

  1. Set the “Hide Link if Full Text” option:

    • (Recommended) Selecting “No” will ensure that the LibKey Link appears on every item, even if there is full text available from EBSCOhost. If your library has configured the format chooser with Third Iron, then HTML or PDF options may be offered.

      • If go to full text is configured with Third Iron, then PDFs will be prioritized.

    • If you want LibKey Link to only appear when there is no other available full text, then change this option to “Yes”.

  2. Click Submit to save your changes.

  3. All the rest of the necessary fields have already been filled in for you, but please adjust any of remaining fields that meet your library's needs.

Step 2 for setting up Retractions and Article in Context:

  1. In EBSCOadmin, click the Site/Group Maintenance button, then select Go below CustomLinks.

  2. Add New CustomLink.

  3. Select Copy from existing CustomLink and click Continue.

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

  5. ++show other available CustomLinks and select “LibKey - Retraction (New Interface)”

  6. Submit your selection.

  7. Select Copy from existing CustomLink and click Continue.

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

  9. Click ++show other available CustomLinks and select “LibKey - Article in Context (New Interface)”

  10. Submit your selection.

Step 3 to add these links to your profile and give them a ranked order:

  1. Navigate to the Customize Services tab, select your profile [EBSCO Discovery Service (eds) - eds] and then click the Linking tab.

  2. Click the Modify link to the right of Custom Links.

  3. Add New CustomLinks and mark the Select box to the left of:

    • “LibKey - Retraction (New Interface)”

    • “LibKey OpenURL Link”

    • “LibKey - Article in Context (New Interface)”

  4. Click Submit so your changes are saved.

  5. 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). Enter the desired order of Full text links with (1 = first, top of the list). Here’s an example:


    Notes:

    • There are likely other links listed beyond what’s pictured above, please adjust as desired.

    • Leave the default selection enabled to the Show First Available FullText Link Only (Recommended).

  6. Click Submit to save your changes.

 

Option 2

This configuration includes both *HTML and PDF access for accessibility considerations (Retractions, LibKey Link, LibKey Instant PDF)

*Note: Please connect with Third Iron support to ensure that your LibKey settings include format chooser so the article link is offered. If format chooser is enabled, then article links may appear alongside PDF options and retraction notices will appear when applicable. Otherwise, if go to full text is enabled, PDFs would be prioritized.

Steps for Setting up LibKey Link 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 OpenURL Link.

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

  8. Set the “Hide Link if Full Text” option:

    • (Recommended) Selecting “No” will ensure that the LibKey Link appears on every item, even if there is full text available from EBSCOhost.

      • If your library has configured the format chooser with Third Iron, then HTML or PDF options may be offered. If go to full text is configured, then PDFs will be prioritized.

    • If you want LibKey Link to only appear when there is no other available full text, then change this option to “Yes”.

  9. Click Submit to save your changes.

  10. All the rest of the necessary fields have already been filled in for you, but please adjust any of remaining fields that meet your library's needs.

Step 2 for Setting up Retractions and LibKey Instant PDFs:

  1. In EBSCOadmin, click the Site/Group Maintenance button, then select Go below CustomLinks.

  2. Add New CustomLink.

  3. Select Copy from existing CustomLink and click Continue.

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

  5. ++show other available CustomLinks and select “LibKey - Retraction (New Interface)”

  6. Submit your selection.

  7. Select Copy from existing CustomLink and click Continue.

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

  9. Click ++show other available CustomLinks and select “LibKey - Instant PDF (New Interface)”

  10. Submit your selection.

 

Option 3

This configuration prioritizes direct access and fewer links overall (LibKey Link, Article in Context)

Note: LibKey Link will still show retractions as applicable, they just won’t stand out as a separate line item in the list of “Access Options” on EDS records.

 

Option 4

This configuration prioritizes direct access and the fewest links (LibKey Link only)