These instructions are for the NDE version of Primo. If you are instead using Primo/Primo VE please see the appropriate instructions for setup in that interface here. When you are ready to move to NDE, you can use the same API Key previously issued to your library in NDE and can use it in NDE and your current version of Primo at the same time. This will not cause any conflicts in operation for either interface.

Open

Key aspects of this Primo community-informed integration of LibKey into Primo include:

• One-click to PDF and/or HTML articles from hundreds of publishers and aggregators

• Extending BrowZine cover images to display in the citation record

• Link from the citation record to the full journal issue in BrowZine

• Link to the journal current issue in BrowZine

• Indicating retracted article status

• Indicating expression of concern status

• Indicating Third Iron Problematic Publisher status (Subscription Required)

• Providing “Request PDF” links for document delivery with Article Galaxy Scholar

• Links that resolve to indicate a second order retraction status

These different elements are optionally available so that libraries can customize their installation to work best for their community.

Step-by-Step Implementation Guide (includes Video)

This guide is intended for Primo/Alma administrators who have a basic familiarity with Alma but with little programming/scripting experience or knowledge, or for those simply want a quick way to complete an integration.  

For advanced users, you are welcome to access this github repository to see how the integration works.

Step 1: Contact Third Iron Support

Please contact support@thirdiron.com to let us know you are a Primo library and would like to integrate LibKey.  In response, we will send your your library’s BrowZine Library ID and BrowZine API Key needed for Step 2.

Step 2: Customizing the JSON configuration file

There are two decisions to make for your integration:

1. Choose your View Option

2. Choose your Feature Options

The first thing to decide is which View Option makes the most sense for your library and its users. This is a new option available in Primo NDE which was not available in the Primo VE integration. We did this in recognition of the new design language that Ex Libris introduced with NDE (what we call below “The Stack” - meaning the drop down of content access links that appears within the interface).

We provide three basic view options that affect the LibKey button arrangement:

1. "Stack + BrowZine Link"

   This version fully embraces the new “Stack” concept of link minimization in NDE by putting the “one click” link front and center with additional linking options available in the drop down arrow. LibKey Links would take precedent over Alma QuickLinks whenever they may both exist. The BrowZine View Issue Contents link appears separate since it serves a different purpose then immediate content access.

   Set in the config JSON file with: "viewOption": "stack-plus-browzine",

2. "Single Stack"

   This version puts all LibKey and Alma generated links under a single stack. Effectively the only difference between this and the above option is that the BrowZine View Issue Contents appears with the links to content.

   Set in the config JSON file with: "viewOption": "single-stack",

3. "No Stack"

   With this arrangement we recommend turning off the link resolver when LibKey can create links as leaving it on can result in duplicate linking since Alma will generate a “stack” of links via a drop down menu off to the right which could be confusing.

   Set in the config JSON file with: "viewOption": "no-stack",

As you’ll see in step 3 there is a small JSON file that needs to be created in a text editor.

Now, choose your Feature Options. We’ve highlighted below templates for each of these for the JSON file for your convenience. You can of course edit it to make totally different options to suit your organizational needs, but we’ve found that one of these five is typically appropriate. Under each Option you’ll see the JSON configuration codes listed three times to reflect the different View Options that have the specified features enabled or disabled.

Feature Option 1

This is our recommended, most accessible option as it presents all formats (PDF and Article Links when available)

Feature Option 2

This option is identical to Option 1 except only the “best” format link is presented that provides the fewest clicks to the PDF.

Feature Option 3

This configuration removes display of links to non-version of record copies.  Commonly used by corporate libraries and hospitals who often prefer displaying only the version of record.

Feature Option 4

This configuration will display all link options and will display duplicate links

Feature Option 5

This configuration option minimizes the number of links to full text that appear

Step 3: Creating and Configuring the Add-on

New for NDE, Ex Libris has added an official “Add-on” area to simplify the installation and maintenance of integrations designed for Primo NDE. To find this area, follow these breadcrumbs after logging into your Alma administrator area:

Configuration → Discovery → (Other) Add-on Configuration:

Open

Then, click Add Row:

Open

The resulting Edit Add-on Configuration screen prompts you to input a few key details to enable the add on.

Open

1 = Defaulted to checked, this will allow the add-on to turn on immediately after you complete the needed fields and click the save button in the upper right hand corner. Come back to edit your add on and uncheck if you want to temporarily disable it.

2 = Select which view(s) in Primo you want to apply the integration into. The default is “All”.

3 = Provide the Add-on Name: LibKey

4 = This is the URL where the integration’s code is living. The URL for the LibKey Add on is located here: https://discovery-adapters.thirdiron.com/primo-nde/production/

5 = Click the folder icon to search your filesystem for the JSON format Add-on Configuration file you created in the previous step. Once selected, click “Upload” to upload it.

Open

If all went well you’ll get a positive blue message indicated that you uploaded successfully. To complete the setup make sure you hit SAVE.

Step 4: Test!

Visit Primo NDE in a view that you enabled the add-on for and observe that there are LibKey generated links present on article records. If your initial search does not yield good results, make sure to limit to “articles” or try a more “scholarly” topic as LibKey is focussed on DOI bearing materials.

If you run into any trouble, please reach out to our support team at support@thirdiron.com for assistance!

Customizing & Localizing Link Labels (includes Video)

The LibKey Add-on’s textual labels can be fully customized or localized as desired. If you are content with the default English language labels and don’t need any other languages supported, this is an optional step is nothing further is required.

If you are a single campus organization with a single view for your users for NDE (you can have multiple views for testing purposes provided all the LibKey settings are the same) then you can use this attached template Excel document to upload the labels to the various attributes in a variety of supported languages found below:

Open

To add custom labels, do the following:

• Download the Above Excel document. Change any text you would like in the “Description” column. This will be the text then your users will see!

• Navigate in Alma to Configuration → Discovery → Labels

  • Search in the list of labels for “NDE Custom Defined Labels”. This is the recommended home for these labels as its designed for additional labels for custom functionality like this LibKey add-on.

  • In the more actions menu on this row click “Edit”

  • Choose Import and attach the Excel document. It will verify and then upload the document. Be sure to click SAVE in the top right hand corner to apply it to Alma.

  • Then, you can edit the English labels or add translations for other supported languages in your Alma system. Remember always to click SAVE after making changes.

• Finally, test in Primo to make sure this worked as expected. Changes made in Alma should have immediate effect in Primo after a page refresh.

Multi-campus/Multi-View organization

If you are a multi-campus organization or single campus but who uses multiple unique views you will integrate the LibKey Add-on multiple times - once for each view you are supporting. You can also make changes to labels (as well as add localization) by adding the VIEW NAME as a prefix to the labels. This will then OVERRIDE the default English labels LibKey is using.

For example, if you have three views/campuses established that have these view names:

Campus_A

Campus_B

Campus_C

And you want ALL the campuses to have just “PDF” instead of “Download PDF” within Primo following the single campus instructions as shown above will override that label for ALL VIEWS:

LibKey.articlePDFDownloadLinkText → PDF

However, if instead only Campus_A wants this label and Campus_B and Campus_C want to keep the existing default label you can add additional specificity by adding the View as a prefix:

Campus_A.LibKey.articlePDFDownloadLinkText → PDF

Detailed descriptions of all configuration elements

Troubleshooting FAQ

1. When I click on “Other Online Options” I sometimes am taken directly to the resource and other times I am taken to the full list of sources. What is happening?

If this is happening, you have Direct Linking turned on in Alma and you are on an item with only one known source to Alma. Direct linking thus automatically chooses that source. By clicking on the article title you can ALWAYS get to the record detail view regardless of your setting for Direct Linking. To toggle direct linking on or off you need Alma Admin permissions and you can find it here: Alma Configuration → Fulfillment → Discovery Interface Display Logic → Direct Linking.

2. I think I did the instructions right but I see no LibKey integration? What’s wrong?

It’s possible that you will need to include: *.thirdiron.com in the “allowed list additions” of the CSP Header Configuration (to default-src, object-src, worker-src, script-src and connect-src areas).

This can be found here:

Configuration > General > CSP Header Configuration

More information from Alma documentation about this area of Alma.

Try making these changes and reloading Primo to see if that resolves the issue.

Still having trouble? Contact us!