Summon Integration Overview

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

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

These community created code options have been summarized in four different integration options outlined in the below implementation guide.

Step-by-Step Implementation Guide

This guide is intended for Summon administrators with a basic familiarity with the back office functions of Summon but with little programming/scripting experience or knowledge or for those simply wanting to implement this integration quickly. For advanced users, you are welcome to skip right to the this github repository with all necessary files and quick instructions.

Step 1: Contact Third Iron Support

Contact Third Iron at support@thirdiron.com and simply let us know that you are a Summon library and would like to use this integration. In response, we will send your your library’s BrowZine Library ID and BrowZine API Key needed for Step 2.

Step 2: Copy and paste custom script code into a file to be used as an externally linked script

You will need a few code blobs to successfully install this integration into your Summon Administration Console. You will want to be using a plain text editor to do this.

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 2, 3 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?

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 1	Best format link presented	Yes	Yes	Yes	Yes

var browzine = {
  libraryId: "XXX",
  apiKey: "ENTER API KEY",

  version: 2, // Required for the other parameters below to work after December 15, 2021.

  articlePDFDownloadLinkEnabled: true,
  articlePDFDownloadWording: "View Now",
  articlePDFDownloadLinkText: "PDF",

  articleLinkEnabled: true,
  articleLinkTextWording: "View Now",
  articleLinkText: "Article Page",

  articleBrowZineWebLinkTextEnabled: true,
  articleWording: "View in Context",
  articleBrowZineWebLinkText: "Browse Journal",

  journalBrowZineWebLinkTextEnabled: true,
  journalWording: "View the Journal",
  journalBrowZineWebLinkText: "Browse Now",

  printRecordsIntegrationEnabled: true,
  
  showFormatChoice: false,
  showLinkResolverLink: true,
  enableLinkOptimizer: true,

  unpaywallEmailAddressKey: "YourUniversityEmail@greatuniversity.edu",

  articlePDFDownloadViaUnpaywallEnabled: true,
  articlePDFDownloadViaUnpaywallWording: "View Now (via Unpaywall)",
  articlePDFDownloadViaUnpaywallLinkText: "PDF",

  articleLinkViaUnpaywallEnabled: true,
  articleLinkViaUnpaywallWording: "View Now (via Unpaywall)",
  articleLinkViaUnpaywallLinkText: "Article Page",

  articleAcceptedManuscriptPDFViaUnpaywallEnabled: true,
  articleAcceptedManuscriptPDFViaUnpaywallWording: "View Now (Accepted Manuscript via Unpaywall)",
  articleAcceptedManuscriptPDFViaUnpaywallLinkText: "PDF",

  articleAcceptedManuscriptArticleLinkViaUnpaywallEnabled: true,
  articleAcceptedManuscriptArticleLinkViaUnpaywallWording: "View Now (via Unpaywall)",
  articleAcceptedManuscriptArticleLinkViaUnpaywallLinkText: "Article Page",

  articleRetractionWatchEnabled: true,
  articleRetractionWatchTextWording: "Retracted Article",
  articleRetractionWatchText: "More Info",
  
  articleExpressionOfConcernEnabled: true,
  articleExpressionOfConcernWording: "Expression of Concern",
  articleExpressionOfConcernText: "More Info",
};

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

Option 2

This configuration is almost identical to Option 1 but should be a considered a more accessible option as it will always show an Article Link option in addition to PDF links as Article Links can commonly have the full text in HTML which is usually more friendly to screen readers than a PDF.

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?

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 2	All Formats Presented	Yes	Yes	Yes	Yes

var browzine = {
  libraryId: "XXX",
  apiKey: "ENTER API KEY",

  version: 2, // Required for the other parameters below to work after December 15, 2021.

  articlePDFDownloadLinkEnabled: true,
  articlePDFDownloadWording: "View Now",
  articlePDFDownloadLinkText: "PDF",

  articleLinkEnabled: true,
  articleLinkTextWording: "View Now",
  articleLinkText: "Article Page",

  articleBrowZineWebLinkTextEnabled: true,
  articleWording: "View in Context",
  articleBrowZineWebLinkText: "Browse Journal",

  journalBrowZineWebLinkTextEnabled: true,
  journalWording: "View the Journal",
  journalBrowZineWebLinkText: "Browse Now",

  printRecordsIntegrationEnabled: true,
  
  showFormatChoice: true,
  showLinkResolverLink: true,
  enableLinkOptimizer: true,

  unpaywallEmailAddressKey: "YourUniversityEmail@greatuniversity.edu",

  articlePDFDownloadViaUnpaywallEnabled: true,
  articlePDFDownloadViaUnpaywallWording: "View Now (via Unpaywall)",
  articlePDFDownloadViaUnpaywallLinkText: "PDF",

  articleLinkViaUnpaywallEnabled: true,
  articleLinkViaUnpaywallWording: "View Now (via Unpaywall)",
  articleLinkViaUnpaywallLinkText: "Article Page",

  articleAcceptedManuscriptPDFViaUnpaywallEnabled: true,
  articleAcceptedManuscriptPDFViaUnpaywallWording: "View Now (Accepted Manuscript via Unpaywall)",
  articleAcceptedManuscriptPDFViaUnpaywallLinkText: "PDF",

  articleAcceptedManuscriptArticleLinkViaUnpaywallEnabled: true,
  articleAcceptedManuscriptArticleLinkViaUnpaywallWording: "View Now (via Unpaywall)",
  articleAcceptedManuscriptArticleLinkViaUnpaywallLinkText: "Article Page",

  articleRetractionWatchEnabled: true,
  articleRetractionWatchTextWording: "Retracted Article",
  articleRetractionWatchText: "More Info",
  
  articleExpressionOfConcernEnabled: true,
  articleExpressionOfConcernWording: "Expression of Concern",
  articleExpressionOfConcernText: "More Info",
};

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

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.

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?

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 3	Best Format Link Presented	Yes	Yes	Yes	No

var browzine = {
  libraryId: "XXX",
  apiKey: "ENTER API KEY",

  version: 2, // Required for the other parameters below to work after December 15, 2021.

  articlePDFDownloadLinkEnabled: true,
  articlePDFDownloadWording: "View Now",
  articlePDFDownloadLinkText: "PDF",

  articleLinkEnabled: true,
  articleLinkTextWording: "View Now",
  articleLinkText: "Article Page",

  articleBrowZineWebLinkTextEnabled: true,
  articleWording: "View in Context",
  articleBrowZineWebLinkText: "Browse Journal",

  journalBrowZineWebLinkTextEnabled: true,
  journalWording: "View the Journal",
  journalBrowZineWebLinkText: "Browse Now",

  printRecordsIntegrationEnabled: true,
  
  showFormatChoice: false,
  showLinkResolverLink: true,
  enableLinkOptimizer: true,

  unpaywallEmailAddressKey: "YourUniversityEmail@greatuniversity.edu",

  articlePDFDownloadViaUnpaywallEnabled: true,
  articlePDFDownloadViaUnpaywallWording: "View Now (via Unpaywall)",
  articlePDFDownloadViaUnpaywallLinkText: "PDF",

  articleLinkViaUnpaywallEnabled: true,
  articleLinkViaUnpaywallWording: "View Now (via Unpaywall)",
  articleLinkViaUnpaywallLinkText: "Article Page",

  articleAcceptedManuscriptPDFViaUnpaywallEnabled: false,
  articleAcceptedManuscriptPDFViaUnpaywallWording: "View Now (Accepted Manuscript via Unpaywall)",
  articleAcceptedManuscriptPDFViaUnpaywallLinkText: "PDF",

  articleAcceptedManuscriptArticleLinkViaUnpaywallEnabled: false,
  articleAcceptedManuscriptArticleLinkViaUnpaywallWording: "View Now (via Unpaywall)",
  articleAcceptedManuscriptArticleLinkViaUnpaywallLinkText: "Article Page",

  articleRetractionWatchEnabled: true,
  articleRetractionWatchTextWording: "Retracted Article",
  articleRetractionWatchText: "More Info",
  
  articleExpressionOfConcernEnabled: true,
  articleExpressionOfConcernWording: "Expression of Concern",
  articleExpressionOfConcernText: "More Info",
};

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

Option 4

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

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?

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	All Formats Presented	Yes	No	Yes	Yes

Option 5

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

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?

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 5	Best Format Link Presented	Yes	Yes	No	Yes

3) Save the your custom file with the modifications you made above.

Step 3: Upload your custom javascript file to a server and link it in the Summon Administration Console

With all your changes made, upload the file to your own server where you can make the file linkable. Are you not sure if that file is linkable? Simply put the URL to it in the browser. If a bunch of javascript code comes up, then it is linkable and can be used by Summon. If you get a 404 or Insufficient Privileges or similar error, either the link is incorrect or the file needs to be made "world readable".

To add the script file to your Summon instance, go into the Summon Administration Console. Under Settings go to Summon 2.0 External Scripts. Flip the toggle from "Default" to "Custom" and insert the URL to the script file you just uploaded in the space provided.

Do you not have any customizations and also don't have a place to host the file? Contact Third Iron Support and if you only are using the BrowZine Integration in your file, we would be happy to host it for you!

All done but the integration is not appearing? You might find that the integration is not seen immediately if your browser has cached some of Summon's code. To defeat this, you may need to perform a shift-reload operation (Shift-Command-R on Mac in most browsers or Shift-Control-R on Windows in most browsers) to defeat the caching your browser is doing.

Implementation Variations

Libraries are invited to consider multiple different approaches to utilizing this API as well as other interactions to get the best use out of the BrowZine Journal Engagement Service:

Link directly to your BrowZine Library from your home page. Therefore, the primary user experience for journal browsing begins in BrowZine whereas various options to link into BrowZine are still covered by Summon. You can see examples of this by other Summon libraries such as Murdoch University (AUS), Metropolitan State University (USA), Johnson County Community College (USA) and more!
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 Serials Solutions 360! Live examples of this in action (be sure to select the Journals/eJournals search from the appropriate dropdowns/options) can be see at University of Michigan Dearborn (USA), Marshall University (USA) and more!

Third Iron Technical Documentation

Ex Libris Summon Overview and Step-by-Step Installation Guide