Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  • Primo Integration Overview

  • Step-by-Step Implementation Guide

  • Implementation Variations

The Ex Libris library community has created a number of different ways to integrate LibKey and the Primo interface, including

Anchor
PrimoIntegrationOverview
PrimoIntegrationOverview
:

...

There are a large number of combinations of options available within the configuration script. To simplify installation, we have created a matrix of features to consider as well as pre-configured code snippets to help simplify installation and customization. For ALL of these, you are required to update lines 4, 5 and 29 with your custom information.

...

Option 1

This configuration takes best advantage of LibKey technology and is recommended for most libraries.

...

Configuration name

Best format link presented (PDF preferred) or all formats presented

Link to View Complete Issue for serendipitous discovery in BrowZine?

Minimize duplicate links?

Show link resolver if LibKey link available?

Display Unpaywall non-version of record option?

Option 4

Best Format Link Presented

No

YesYes

No

Yes

Expand
titleView configuration code
Code Block
languagejs
// Begin BrowZine - Primo Integration...
  window.browzine = {
  
    api: "https://public-api.thirdiron.com/public/v1/libraries/XXX",
    apiKey: "ENTER API KEY",
    
    journalCoverImagesEnabled: true,
    
    journalBrowZineWebLinkTextEnabled: false,
    journalBrowZineWebLinkText: "View Journal Contents",
    
    articleBrowZineWebLinkTextEnabled: false,
    articleBrowZineWebLinkText: "View Issue Contents",
    
    articlePDFDownloadLinkEnabled: true,
    articlePDFDownloadLinkText: "Download PDF",
    
    articleLinkEnabled: true,
    articleLinkText: "Read Article",
    
    printRecordsIntegrationEnabled: true,
    showFormatChoice: false,
    showLinkResolverLink: false,
    enableLinkOptimizer: true,
  
    articleRetractionWatchEnabled: true,
    articleRetractionWatchText: "Retracted Article",
    
    unpaywallEmailAddressKey: "enter-your-email@your-institution-domain.edu",
    articlePDFDownloadViaUnpaywallEnabled: true,
    articlePDFDownloadViaUnpaywallText: "Download PDF (via Unpaywall)",
    articleLinkViaUnpaywallEnabled: true,
    articleLinkViaUnpaywallText: "Read Article (via Unpaywall)",
    articleAcceptedManuscriptPDFViaUnpaywallEnabled: true,
    articleAcceptedManuscriptPDFViaUnpaywallText: "Download PDF (Accepted Manuscript via Unpaywall)",
    articleAcceptedManuscriptArticleLinkViaUnpaywallEnabled: true,
    articleAcceptedManuscriptArticleLinkViaUnpaywallText: "Read Article (Accepted Manuscript via Unpaywall)",
  };

  browzine.script = document.createElement("script");
  browzine.script.src = "https://s3.amazonaws.com/browzine-adapters/primo/browzine-primo-adapter.js";
  document.head.appendChild(browzine.script);

  app.controller('prmSearchResultAvailabilityLineAfterController', function($scope) {
    window.browzine.primo.searchResult($scope);
  });

  app.component('prmSearchResultAvailabilityLineAfter', {
    bindings: { parentCtrl: '<' },
    controller: 'prmSearchResultAvailabilityLineAfterController'
  });
// ... End BrowZine - Primo Integration

...

  1. Link directly to your BrowZine Library if a user clicks on the "Journals A-Z" tab at the top of the Primo interface.  Therefore, the primary user experience for journal browsing begins in BrowZine whereas various options to link into BrowZine are still covered by Primo.  You can see examples of this in action at  University of Birmingham (UK), Charles Sturt University (AUS) and more!

  2. Utilize the External Search API to create a search box on your home page to link a user's journal query directly into BrowZine!  If the user's query turns out to not be for scholarly journals but only trade journals or popular ones that BrowZine does not cover, the search is auto-routed back to Primo's A-Z!  Live examples of this in action (be sure to select the Journals/eJournals search from the appropriate dropdowns/options) can be see at Rensselaer Polytechnic Institute (USA), College of William & Mary (USA) and more!