Versions Compared

Version Old Version 17 New Version Current
Changes made by

Lora Hanson

Lora Hanson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

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 and EBSCOhost Integration Overview

The main purpose of the EDS integration these integrations is to enhance the user experience for EDS users bringing the power of LibKey Linking into EDS and EBSCOhost 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 EBSCO 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

  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:

...

Info

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.

...

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.

Expand
titleStep 1: LibKey Link setup

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 Categorydrop 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-OpenURL-Link_detailed-config-w-notes.png


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

  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.

Panel
panelIconId1f441-fe0f-200d-1f5e8-fe0f
panelIconText👁️‍🗨️
bgColor#DEEBFF

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

...

Expand
titleStep 3: Add links and assign an order for them to display

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

  1. Navigate to the the Customize Services tab tab, select your profile [EBSCO Discovery Service (eds) - eds OR EBSCOhost Research Databases (ehost) - ehost] and then click the Linking tabthe Linking tab. If setting up the integration in both EDS and eHost you will need to repeat this step for both profiles.

  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 - Instant PDF (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:

    rank_order.png


    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.

Info

Changes in Experience Manager materialize quickly, but it will take up to 24 hrs for EBSCOadmin changes to be reflected unless you “push changes to EBSCO”.

EBSCOadmin option to 'push changes to EBSCO'

Any CustomLinks with (New Interface) in the name will only be visible through the new discovery URL with OPID and not through the classic EDS; to see changes in the new UI, replace {OPID} below with your group’s code: https://discovery.ebsco.com/c/{OPID}

...

Available link options explained

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