Versions Compared

Key

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

  • Step-by-Step Implementation Guide

  • Implementation Variations

...

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 1

Best format link presented

Yes

Yes

Yes

Yes

Expand
titleView Configuration Code
Code Block
languagejs
// Begin BrowZine - Primo Integration...
  window.browzine = {
  
    libraryId: "XXX",
    apiKey: "ENTER API KEY",
    
    journalCoverImagesEnabled: true,
    
    journalBrowZineWebLinkTextEnabled: true,
    journalBrowZineWebLinkText: "View Journal Contents",
    
    articleBrowZineWebLinkTextEnabled: true,
    articleBrowZineWebLinkText: "View Issue Contents",
    
    articlePDFDownloadLinkEnabled: true,
    articlePDFDownloadLinkText: "Download PDF",
    
    articleLinkEnabled: true,
    articleLinkText: "Read Article",
    
    printRecordsIntegrationEnabled: true,
    showFormatChoice: false,
    showLinkResolverLink: true,
    enableLinkOptimizer: true,
  
    articleRetractionWatchEnabled: true,
    articleRetractionWatchText: "Retracted Article",
    
    articleExpressionOfConcernEnabled: true,
    articleExpressionOfConcernText: "Expression of Concern",
    
    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

...

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?

Option 2

All Formats Presented

Yes

Yes

Yes

Yes

Expand
titleView Configuration Code
Code Block
languagejs
// Begin BrowZine - Primo Integration...
  window.browzine = {
  
    libraryId: "XXX",
    apiKey: "ENTER API KEY",
    
    journalCoverImagesEnabled: true,
    
    journalBrowZineWebLinkTextEnabled: true,
    journalBrowZineWebLinkText: "View Journal Contents",
    
    articleBrowZineWebLinkTextEnabled: true,
    articleBrowZineWebLinkText: "View Issue Contents",
    
    articlePDFDownloadLinkEnabled: true,
    articlePDFDownloadLinkText: "Download PDF",
    
    articleLinkEnabled: true,
    articleLinkText: "Read Article",
    
    printRecordsIntegrationEnabled: true,
    showFormatChoice: true,
    showLinkResolverLink: true,
    enableLinkOptimizer: true,
  
    articleRetractionWatchEnabled: true,
    articleRetractionWatchText: "Retracted Article",
    
    unpaywallEmailAddressKeyarticleExpressionOfConcernEnabled: "enter-your-email@your-institution-domain.edu"true,
    articlePDFDownloadViaUnpaywallEnabledarticleExpressionOfConcernText: true"Expression of Concern",
    articlePDFDownloadViaUnpaywallText: 
    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

...

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?

Option 3

Best Format Link Presented

Yes

Yes

Yes

No

Expand
titleView Configuration Code
Code Block
languagejs
// Begin BrowZine - Primo Integration...
  window.browzine = {
  
    libraryId: "XXX",
    apiKey: "ENTER API KEY",
    
    journalCoverImagesEnabled: true,
    
    journalBrowZineWebLinkTextEnabled: true,
    journalBrowZineWebLinkText: "View Journal Contents",
    
    articleBrowZineWebLinkTextEnabled: true,
    articleBrowZineWebLinkText: "View Issue Contents",
    
    articlePDFDownloadLinkEnabled: true,
    articlePDFDownloadLinkText: "Download PDF",
    
    articleLinkEnabled: true,
    articleLinkText: "Read Article",
    
    printRecordsIntegrationEnabled: true,
    showFormatChoice: false,
    showLinkResolverLink: true,
    enableLinkOptimizer: true,
  
    articleRetractionWatchEnabled: true,
    articleRetractionWatchText: "Retracted Article",
    
    articleExpressionOfConcernEnabled: true,
    articleExpressionOfConcernText: "Expression of Concern",
    
    unpaywallEmailAddressKey: "enter-your-email@your-institution-domain.edu",
    articlePDFDownloadViaUnpaywallEnabled: true,
    articlePDFDownloadViaUnpaywallText: "Download PDF (via Unpaywall)",
    articleLinkViaUnpaywallEnabled: true,
    articleLinkViaUnpaywallText: "Read Article (via Unpaywall)",
    articleAcceptedManuscriptPDFViaUnpaywallEnabled: false,
    articleAcceptedManuscriptPDFViaUnpaywallText: "Download PDF (Accepted Manuscript via Unpaywall)",
    articleAcceptedManuscriptArticleLinkViaUnpaywallEnabled: false,
    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

...

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?

Option 4

All Formats Presented

Yes

No

Yes

Yes

Expand
titleView configuration code
Code Block
languagejs
// Begin BrowZine - Primo Integration...
  window.browzine = {
  
    libraryId: "XXX",
    apiKey: "ENTER API KEY",
    
    journalCoverImagesEnabled: true,
    
    journalBrowZineWebLinkTextEnabled: true,
    journalBrowZineWebLinkText: "View Journal Contents",
    
    articleBrowZineWebLinkTextEnabled: true,
    articleBrowZineWebLinkText: "View Issue Contents",
    
    articlePDFDownloadLinkEnabled: true,
    articlePDFDownloadLinkText: "Download PDF",
    
    articleLinkEnabled: true,
    articleLinkText: "Read Article",
    
    printRecordsIntegrationEnabled: true,
    showFormatChoice: true,
    showLinkResolverLink: true,
    enableLinkOptimizer: false,
  
    articleRetractionWatchEnabled: true,
    articleRetractionWatchText: "Retracted Article",
    
    articleExpressionOfConcernEnabled: true,
    articleExpressionOfConcernText: "Expression of Concern",
    
    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

...

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?

Option 5

Best Format Link Presented

Yes

Yes

No

Yes

Expand
titleView configuration code
Code Block
languagejs
// Begin BrowZine - Primo Integration...
  window.browzine = {
  
    libraryId: "XXX",
    apiKey: "ENTER API KEY",
    
    journalCoverImagesEnabled: true,
    
    journalBrowZineWebLinkTextEnabled: true,
    journalBrowZineWebLinkText: "View Journal Contents",
    
    articleBrowZineWebLinkTextEnabled: true,
    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",
    
    articleExpressionOfConcernEnabled: true,
    articleExpressionOfConcernText: "Expression of Concern",
    
    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

...