Skip to main content
ExLibris
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    How to – Set up Direct Linking for Primo on the New UI

    Created By: Stacey van Groll
    Created on: 1/12/2019



    Use Case

    As a user, I want the quickest access possible to full text content in Primo

     

    Goal

    Enable direct linking so that users can click once on the Availability Statement in the Brief Results and go direct to the full text content, without having to open the Full Record Display unnecessarily

    Prevent this behaviour in the case of Journal Resource Type, and instead always open the Full Record Display, so that users can see all coverage ranges for multiple services under View It, and select their preferred link

     

    FYI for the Primo New UI

    Enabling Direct Linking configuration in the Primo Back Office while on the Primo New UI automatically inserts &Force_direct=true into the URL and adds the outlink icon and behaviour to the Availability Statement of opening a new browser tab to the first listed service.

    This Primo configuration overrides Alma Direct Linking configuration option to “Disable direct linking for journals” in the Primo UI.

    This is undesirable given a better user experience for Journal resource type is to always open the Full Record Display, listing all available Alma service/ss with varied coverage ranges, so that a user may view all services and selected their preferred option.

    In order to prevent direct linking via an outlink from the Availability Statement for Journal resource type, Ex Libris has provided code to be added to the Customization Package for sites who wish to enable direct linking for Alma-E.

     

    Outcome - Expected display and behaviour for electronic resources in Primo

    • Outlink / direct linking enabled, for all bar Journals
      • Clicking on the Availability Statement in the Brief Results or in the top section of the Full Record Display will open a new browser tab to the first listed View It electronic service
      • Clicking anywhere on the record entry, other than the Availability Statement
        • Full Record Display opens, at the Top section
      • Users can then select any of the one or more View It services
    • No outlink / direct linking NOT enabled, for Journals
      •  
      • Clicking on the Availability Statement in the Brief Results or in the top section of the Full Record Display
        • Full Record Display opens, at the Get It / View It section
      • Clicking anywhere on the record entry, other than the Availability Statement
        • Full Record Display opens, at the Top section
      • For either option, users can then select any of the one or more View It services

     

     

    Summary

    • Configuration time: 30 minutes to 1 hour
    • Configuration difficulty: Medium – High, as requires changes to customization package

     

    Systems Specs (not all mandatory)

    • Primo New UI, with a single local and remote blended search scope
    • Primo Central Index (PCI), with collections using either Link in Record or Link Resolver
    • Alma, with one or more services providing full text access via the Alma Link Resolver
    • UQ eSpace Institutional repository, with a single static dc:identifier URL for full text access
    • Primo Multi-tenant Back Office, with pipes for Alma and Institutional Repository (UQ eSpace)

     

    Types of Records and System Configuration Areas

    • PCI Link in Record collections
      • Primo Back Office only – GetIT! Link 1 Configuration Mapping Table
    • UQ eSpace ie Online Resource
      • Primo Back Office only – GetIT! Link 1 Configuration Mapping Table
    • PCI Link Resolver collections
      • Primo Back Office – GetIT! Link 1 Configuration Mapping Table
      • Alma Fulfillment Configuration – Direct Linking
      • Alma Fulfillment Configuration – Online Services Order
    • Alma-E aka Alma Electronic resources
      • Primo Back Office – Customization Package
      • Primo Back Office – GetIT! Link 1 Configuration Mapping Table
      • Alma Fulfillment Configuration – Direct Linking
      • Alma Fulfillment Configuration – Online Services Order
    • Note on Alma > Online Services Order
      • This is not mandatory for enabling direct linking, but you may wish to do some work on this ordering given direct linking will result in users being directed to the first listed service after clicking on the Availability Statement

     

    Alma Configuration

    • Green arrow indicates necessary configuration to enable Direct Linking
    • Red arrow indicates ignored configuration for Primo New UI
      • However, if you implement the code copied below to disable direct linking for Journals on the the Primo UI, you may still want to check the box to 'Disable direct linking for journals'.
      • This is because the Test Access functionality for Alma Electronic Portfolios is also affected by enabling Direct Linking Configuration, not just the Primo UI for users
      • In sum, if you enable direct linking in Alma, you will see a Test Access display of only 'Display in new window' and an otherwise blank page (see below)
      • There is no workaround for non-journals provided here (or that I'm aware of), but we decided it was more important to have direct linking for our users in Primo than to retain Test Access functionality for primarily just ebooks

    • If 'Disable direct linking for journals' is checked

    • If 'Disable direct linking for journals is not checked

    If you would also like Direct Linking to apply for Related Services, then there is one extra step on the Alma side as follows

    • Configuration Menu > Fulfillment > Discovery Interface Display Logic > Related Records
    • Click to enable: "Enable direct link for Related Services"

     

    Primo Configuration for Alma-E

     

    Primo Configuration for UQ eSpace ie Online Resource

     

    Primo Configuration for PCI Link in Record

     

    Primo Configuration for PCI Link Resolver

    Primo Configuration for Primo Services Page

    If you would also like Direct Linking to apply for the Services Page, for links coming into Primo from external sources such as Google Scholar, PubMed, EBSCO, Informit, etc, then adjust as follows:

    PS The documentation advises that viewit_NFT and viewit_get_NFT use almaviewit_services to populate the SP. I have found that this causes the SP to display an access deadend of with View It and "No full text available" when there are no full text services (ie NFT), which was resolved by adjusting to almagetit_services for both.  This causes the expected Get It SP to display instead, with expected configured services such as document delivery via our Resource Sharing Partner broker in Alma.

     

    Code for the Primo Customization Package – to prevent direct linking for Journal resource type (affects both Alma and PCI)

    • app.controller('prmOpenJournalInFullController', [function () { var vm = this; vm.$onInit = function () { var resourceType = vm.parentCtrl.result.pnx.display.type[0] || ''; if (resourceType === 'journal') { vm.parentCtrl.isDirectLink = function () { return false; }; } }; }]); app.component('prmOpenJournalInFull', { bindings: { parentCtrl: '<' }, controller: 'prmOpenJournalInFullController' }); app.component('prmSearchResultAvailabilityLineAfter', { bindings: { parentCtrl: '<' }, template: '<prm-open-journal-in-full parent-ctrl="$ctrl.parentCtrl"></prm-open-journal-in-full>' });

     

    Troubleshooting

    • If clicking on the Availability Statement is opening a new tab titled ‘Home’ with a list of service/s
      • The resource is using the Alma Link Resolver and you need to make sure the Availability/Service link is set to Out@@activate, NOT Out@@display in the GetIT! Link 1 Configuration Mapping Table
      • Also check the Alma Direct Linking Configuration Menu and make sure that the “Enable direct linking when multiple services are available” is ticked
    • If the UI is not behaving as expected to add or remove the outlink to the Availability Statement, or in the display within new browser tabs
      • Check the GetIT! Link 1 Configuration Mapping Table entries, Save the table, and Deploy again
      • Close down all Primo sessions, reopen a fresh session and try again
      • Clear your cache.  Best way on Chrome is via the developer console by F12, click and hold the browser refresh icon, choose the last entry for ‘Empty Cache and Hard Reload’
      • Do a Deploy All, which sometimes helps ‘unstick’ Back Office changes
    • If you are having trouble with identifying the right mapping table row to adjust, then an easy way to figure out the code is to:
      • Using Chrome, open the Developer Console (F12), click on the element selector, then the Availability Statement
      • This will navigate you in the console to the code for this status, such as
        • <span class="availability-status viewit_getit_NFT" ng-class="{'text-rtl': $ctrl.switchToLtrString()}" translate="delivery.code.viewit_getit_NFT" translate-values="$ctrl.getPlaceHolders($ctrl.result)" translate-compile="">Check holdings</span>
      • You can then search for that status in the GetIT! Link 1 Configuration Mapping Table

     

     

    Ex Libris Relevant Guides and Release Notes

     

    Edit Log

    26.3.19 Added details in-line above for enabling direct linking also for Related Services

    31.3.19 Added details in-line above for enabling direct linking also for the Primo Services Page

    29.5.19 Added details in-line above for Alma impact of enabling direct linking, with loss of 'Test' Access in some scenarios

     

    Feedback or suggestions