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", problematicJournalEnabled: true, problematicJournalWording: "Problematic Journal", problematicJournalText: "More Info", documentDeliveryFulfillmentWording: "Request Now", documentDeliveryFulfillmentText: "PDF", }; 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", problematicJournalEnabled: true, problematicJournalWording: "Problematic Journal", problematicJournalText: "More Info", documentDeliveryFulfillmentWording: "Request Now", documentDeliveryFulfillmentText: "PDF", }; 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", problematicJournalEnabled: true, problematicJournalWording: "Problematic Journal", problematicJournalText: "More Info", documentDeliveryFulfillmentWording: "Request Now", documentDeliveryFulfillmentText: "PDF", }; 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

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: false, 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", problematicJournalEnabled: true, problematicJournalWording: "Problematic Journal", problematicJournalText: "More Info", documentDeliveryFulfillmentWording: "Request Now", documentDeliveryFulfillmentText: "PDF", }; 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 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

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