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

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 not 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 (part 2).

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

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.
This Integration will be set for all your profiles by default. Alternatively, you can select an individual profile to edit from the drop-down.
To be able to modify this form, select the radio button next to Custom.
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 Validate 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: Configuring links in the EBSCOadmin module

This is the standard configuration (Retractions, LibKey Instant PDF, LibKey Article in Context, and LibKey Link). Please expand and complete all steps below.

Step 1 for setting up LibKey Link in EBSCOadmin:

Log in to EBSCOadmin at http://eadmin.ebscohost.com.
Click the Site/Group Maintenance button, then click on Go below CustomLinks.
Click on Add New CustomLink.
Select Copy from existing CustomLink and click on Continue.
Select Full Text from the Category drop down list.
Click on ++show other available CustomLinks and select LibKey OpenURL Link.
In the Basic Settings section, add your LibKey institution ID (a numeric value) to the BaseURL in place of the text “[LibKeyID]”.
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”.
Click Submit to save your changes.
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, Instant PDF, and Article in Context Setup:

In EBSCOadmin, click the Site/Group Maintenance button, then select Go below CustomLinks.
Add New CustomLink.
Select Copy from existing CustomLink and click Continue.
Select Full Text from the Category drop down list.
++show other available CustomLinks and select “LibKey - Retraction (New Interface)”
1. Note: We recommend updating the Link Text to “RETRACTED ARTICLE” in all capital letters to draw attention to the retraction notification.
Submit your selection.
Select Copy from existing CustomLink and click Continue.
Select Full Text from the Category drop down list.
Click ++show other available CustomLinks and select “LibKey - Article in Context (New Interface)”, and “LibKey Instant PDF (New Interface)”
Submit your selections.

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

Navigate to the Customize Services tab, select your profile [EBSCO Discovery Service (eds) - eds] and then click the Linking tab.
Click the Modify link to the right of Custom Links.
Add New CustomLinks and mark the Select box to the left of:
- “LibKey - Retraction (New Interface)”
- “LibKey - Instant PDF (New Interface)”
- “LibKey OpenURL Link”
- “LibKey - Article in Context (New Interface)”
Click Submit so your changes are saved.
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).
Click Submit to save your changes.

Available link options explained

For more information about each link option available for the new EBSCO interfaces, please click here.

Third Iron Technical Documentation