Skip to main content
ExLibris
  • Subscribe by RSS
  •  

    Ex Libris Knowledge Center

    Link Resolver

    Translatable
    To work with electronic resources, you must have the following roles:
    • Electronic Inventory Operator
    • Electronic Inventory Operator Extended (required for delete operations)
    • Repository Manager

    Using the OpenURL Link Resolver Electronic Services Page

    On the Electronic Services page you can:

    Online Services Display

    The page displays the following metadata, when available, for a book:
    • Book title
    • ISBN
    • Author last name
    • Author first name (or initials)
    • Year information
    Electronic_Services_Page_Metadata_NewUI_02.png
    Electronic Services Page Metadata
    The page displays the following metadata, when available, for a journal:
    • Journal title
    • ISSN
    • Year

    Open Access

    A new link resolver service for Unpaywall Open Access articles is available. To enable the service, set the enable_open_access_services_from_unpaywall_api customer parameter to true (see enable_open_access_services_from_unpaywall_api in Configuring Other Settings (Fulfillment).
    Where the open access information is placed can be configured in the Online Services Order configuration (Configuration Menu > Fulfillment > Discovery Interface Display Logic > Online Services Order). See the section Configuring the Order of Online Services for more information. The default placement of the open access information is at the end.
    Open access rules can be configured to specify what appears or is hidden based on open access. See Configuring Display Logic Rules for more information.
    Direct linking for open access can also be configured. See Configuring Direct Linking for more information.
    Regarding search results for Unpaywall Open Access articles, note that Alma only checks for Unpaywall full-text access when opening the full view of a record from discovery (Primo VE). If the only available full-text source for an article or resource is through Unpaywall, it will not appear in search results unless the Include results with no online full-text to request through Inter-Library Loan filter is applied.

    Additionally, if there is no response for a PDF in the Unpaywall API Response, no Unpaywall Service will be displayed.

    Group Settings

    Group settings also determine what is available for patrons to view. For additional information regarding inventory management group settings see Configuring Distributed Access to Electronic Resources.

    Identifiers

    The link resolver searches for the resource based on the following identifiers, one by one:
    • EISSN
    • ISSN
    • EISBN
    • ISBN
    • LCCN
    • CODEN
    • OCLC unique number
    • OCLC
    When a resource (MMS record) is found, the search stops.
    For a digital file, the page displays a link to the file(s).
    Identifier prioritization:
    The identifiers are prioritized according to the genre (article/journal/issue genres give a higher priority to EISSN/ISSN; other genres give a higher priority to EISBN/ISBN). When genre is not present, priority is given to EISBN/ISBN over EISSN/ISSN. 

    When the Link Resolver searches for an ISSN, it performs an All Titles repository search using the ISSN index, searching for all titles that are not suppressed AND where ISSN equals the value sent in EISSN or ISSN of the OpenURL, according to the rules described on this page. For the subfields of the ISSN field that are considered by the Link Resolver, see the Mapping of MARC21 fields table below. 

    If an OpenURL includes both EISSN and ISSN:
    • The Alma Link Resolver searches for a match by EISSN first. If a match by EISSN is found, the search is stopped and an additional search for ISSN is not performed.
    • Important! If a match by EISSN is found, but it is filtered out from View It (for example, the dates are not covered) and the search stops as described above, an additional search for ISSN is not performed.

    How the search is conducted:

    The search is conducted as following:

    • If no match is found on the identifiers, a search is performed by title + author. If the search by title + author fails, the search is conducted by title only. 
    • If the genre is Journal, Article, or Issue, no further search is performed.

    If a match is found, the search stops. At times the match is inaccurate and can result in Get It services for the wrong title. You can configure Alma to limit the link resolver to display Get It services for titles that were matched only based on identifiers. See Using Standard Identifiers for more information.

    If there was no search by identifier (no identifier as part of the OpenURL), a search is performed by title only. When searching by title only, the genre plays a role in determining the material type to be retrieved. If the genre is Book, BookItem, Report, or Document, the material type to be retrieved is 'monograph'. If the genre is Issue, Journal, or Article, the material type to be retrieved is 'serial'.

    Mapping of MARC21 fields:

    MARC21 fields that are mapped to Author MARC21 fields that are mapped to Title MARC21 fields that are mapped to ISBN/EISBN MARC21 fields that are mapped to ISSN/EISSN 
    100 $$ a-d,j,q,u
    110 $$ a-e,g,n,u
    111 $$ a,c-e,g,n,q,u
    700 $$ a-d,g,j,q,u
    880 $$ a-d,g,j,q,u
    710 $$ a-e,g,i,n,u
    880 $$ a-e,g,i,n,u
    711 $$ a,c-e,g,i,j,n,q,u
    245 $$ a,b,k,n,p
    210 $a
    246 $a
    and their 880 fields and subfields

    020 $$a,e,z
    775 $z
    776 $z

    022 $$a,y,z,e     
    775 $x   
    776 $x

    For internal reference: Author and Title are respectively creator_contributor and extended_title from the search section of the Operational Record.

    Related Records:

    • If Alma Link Resolver finds a bibliographic record with electronic inventory AND there is related bibliographic record with a physical inventory, only View It is displayed, because Alma does not support Get It of the related record.
    • If Alma Link Resolver finds a bibliographic record with physical inventory, Alma always searches for additional electronic services. Therefore, if the resolved bibliographic record with physical inventory has a related bibliographic record with an electronic inventory, both Get It and View It are displayed.

    Message Customization

    When there are no full text services available for the OpenURL request, the Electronic Services page displays a message. An administrator can customize the wording of the message. 

    This configuration is applicable to Alma-Primo environments and does not apply to Primo VE.

    To customize the wording for the 'no full text' message:
    1. Open the Discovery Interface Labels code table (Configuration Menu > Fulfillment > Discovery Interface Display Logic > Labels).
    2. Locate the row with c.uresolver.emptyList in the Code column.
    3. Select Customize. The Description column cell in that row opens for you to enter your customized message text.
    4. Enter the text you want to appear on the Electronic Services page when no full text is available.
      If you prefer that no message be displayed when no full text is available, leave this option blank.
    5. Select Save.

    Restricting Access to E-Resources From the OpenURL Link Resolver

    You can associate a patron with a campus/library for the purpose of resolving electronic services based on inventory management group settings used by the OpenURL Link Resolver that appear on the Electronic Services page.
    You can associate a patron with campus/library information from the following sources:
    • Logged in user – The patron is associated with the campus with which his/her logged-in user ID is affiliated.
    • OpenURL base URL – The OpenURL base URL can include the campus/library and, using this, associate the patron with the campus/library that is part of the OpenURL.
      See the figure below where –MAIN in the OpenURL request is the campus. For information about the Alma delivery domain, see Your Alma Domain Names.
      http://<Alma delivery domain>/view/uresolver/01PRIN_INST/openurl-MAIN?& u.ignore_date_coverage=true&rft.mms_id=996706770000121&rfr_id= info:sid/primo.exlibrisgroup.com&svc_dat=viewit&test_access=true
      The above is an OpenURL request URI example where -MAIN is the campus.
    Once the patron is associated with a campus/library from the various sources, Alma can locate the relevant inventory management groups (see Configuring Distributed Access to Electronic Resources or more information regarding inventory management group settings) in order to determine the appropriate services to offer to the patron using the OpenURL Link Resolver (View It). The user is presented with only the electronic services that he/she can access.

    Link Resolving Examples

    See the tables below (Use Case Examples - Delivery from Third Party and Use Case Examples - Delivery from Primo) for examples where a patron uses an OpenURL-compliant third-party database (such as Google Scholar, EBSCO, or ProQuest) or Primo to search for and successfully find a title and how the OpenURL Link Resolver processes/determines the relevant services to present to the patron. The following are key pieces of information that enable the OpenURL Link Resolver to successfully identify the relevant services to present:
    Use Case Examples - Delivery from Third Party
    Use Case (See Figures Below) Patron Physical Location Logged In to Primo Third-Party Database Information Provided to Link Resolver Services Presented to the Patron
    1 Main Campus No (User is unknown) Accessing the Google Scholar account for the Main Campus IP=Main Campus
    OpenURL=Main Campus
    Services that are associated with the inventory management groups of which the Main Campus is a part
    2 Main Campus No (User is unknown) Accessing the Google Scholar account for the City Campus IP=Main Campus
    OpenURL=City Campus
    Services that are associated with the inventory management groups of which the Main Campus and City Campus are a part
    For a City Campus resource, the patron may be challenged with a proxy for the City Campus.
    3 Off Campus No (User is unknown) Accessing the Google Scholar account for the Main Campus IP=?
    OpenURL=Main Campus
    Services that are associated with the inventory management groups of which the Main Campus is a part
    Delivery_from_Third_Party_Use_Case_1.png
    Delivery from Third Party - Use Case 1
    Delivery_from_Third_Party_Use_Case_2.png
    Delivery from Third Party - Use Case 2
    Delivery_from_Third_Party_Use_Case_3.png
    Delivery from Third Party - Use Case 3
    Use Case Examples - Delivery from Primo
    Use Case (See Figures Below) Patron Physical Location Logged In to Primo Primo View Information Provided to Link Resolver Services Presented to the Patron
    1 Main Campus No (User is unknown) Accessing the Primo view for the Main Campus IP=Main Campus
    OpenURL=Main Campus
    Services that are associated with the inventory management groups of which the Main Campus is a part
    2 Main Campus No (User is unknown) Accessing the Primo view for the City Campus (not this user’s own view) IP=Main Campus
    OpenURL=Main Campus
    Primo also identifies the IP of the user which in this case is connected to the Main Campus.
    Services that are associated with the inventory management groups of which the Main Campus is a part
    3 Main Campus Yes
    His affiliation is with the City Campus
    Accessing the Primo view for the Main Campus User=City Campus
    IP=Main Campus
    OpenURL=City Campus
    Services that are associated with the inventory management groups of which the Main Campus and City Campus are a part
    For a City Campus resource, the patron may be challenged with a proxy for the City Campus.
    4 Off Campus No (User is unknown) Accessing the Primo view for the City Campus IP=?
    OpenURL=City Campus
    Services that are associated with the inventory management groups of which the City Campus is a part
    Delivery_from_Primo_Use_Case_1.png
    Delivery from Primo - Use Case 1
    Delivery_from_Primo_Use_Case_2.png
    Delivery from Primo - Use Case 2
    Delivery_from_Primo_Use_Case_3.png
    Delivery from Primo - Use Case 3
    Delivery_from_Primo_Use_Case_4.png
    Delivery from Primo - Use Case 4

    Using the OpenURL Link Resolver Debugger Tool

    You can use a debugger tool to troubleshoot the context services that are offered by the OpenURL Link Resolver. The tool enables you to enter an OpenURL input message and receive an XML debugger response from the OpenURL Link Resolver. From the XML response, you can:
    • Determine the service calculation:
      • View the context object that was calculated based on the OpenURL parsing, augmentation, and related service.
      • Understand how the context services object was generated:
      • What were the potential services?
      • Which services were added based on the calculation of related services?
      • Which services were filtered out based on coverage or rules for general electronic services and display logic?
    • Determine the link resolution and how the OpenURL was generated:
      • Which target parser was used?
      • Was a proxy used?
      • Was it a static URL on the portfolio level?
      • Is there a direct link?
      • View the generated targetURL.
    • View the original OpenURL in the debugging content provided.
    • Enriching the data (context object) from CrossRef using the DOI is handled before matching.
    • For information about debugging a citation's uResolver (OpenURL) link, see the knowledge article Debugging Citation uResolver Links.
    To run the debug tool:
    1. Search the repository for the electronic title or portfolio that you want to test access.

      For Primo VE environments, you can also use Primo VE to search for and display the electronic record's full display. Skip to step ii in the Primo VE section.

    2. Depending on your type of Primo environment, perform the following steps:

      • Alma-Primo:

        1. Depending on the type of results, select View It (electronic titles) or Test Access (electronic portfolios) for an item in the results list. You can also test access from the Portfolios List page and the Portfolios tab on the Electronic Service Editor page.

          Alma-Primo_ViewIT.png

          Display View It Tab
        2. In the View It tab, select Display in a new window.

          Primo_DisplayInNewWindow.png

          View It Tab
        3. Right-click the Electronic Services page and select the option to view the page or frame source. The options are somewhat different for each browser.

          Select_View_Page_Source_Option_NewUI_02.png

          Select View Page Source Option
        4. Locate the DEBUG section at the top of the source view and copy the URL.

          HighlightCopyDebug_URL.png

          Highlight and Copy the DEBUG URL
        5. Open a new browser page or tab, paste the debug URL that you copied in the previous step into the address bar of the new page or tab, and press enter to view the XML debugger output.

      • Primo VE:
        To debug, you will enable the Display CTO button, which is hidden in regular use. Selecting this button displays the Context Object (CTO) that provides you with additional information about the result, to help you troubleshoot the context services that are offered by the OpenURL Link Resolver. 

        1. For a record in the results list, select Display in Discovery to open its full display.

          PVE_DisplayInDiscovery.png

          View Full Display Page in Primo VE
        2. To enable the Display CTO button, add the following parameter to the end of the record's full display URL and then press enter: &displayCTO=true.
          CTO is the Context Object that provides you with additional information about the result, to help you troubleshoot the context services that are offered by the OpenURL Link Resolver. 

          For example:

          https://<Alma instance>/discovery/fulldisplay?docid=alma9926095600521&context=U&vid=PRIMO_OAP_INST:Alma&lang=en&displayCTO=true

          PVE_DisplayCTO_Button.png

          Display CTO Button Enabled on Full Display Page
        3. Select Display CTO to display the XML debugger output.

    3. Scroll through the XML to analyze/debug your search result issues. After the <context object> element is the <context services> element that contains information regarding service type, parsing, proxy, the target URL, and so forth.

      Notice that in cases where records were filtered out from displaying in the results, the XML output contains key IDs for Filter (true or false) and Filter reason. For example, if Filter reason contains Date Filter and the OpenURL input specified a data parameter of year=2010, this may indicate that the record was filtered because it was outside of the specified date range.

      <uresolver_content xmlns="http://com/exlibris/urm/uresolver/xmlbeans/u" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <context_object>
          <keys>
            <key id="rft.stitle">Test</key>
            <key id="rft.pub">Springer</key>
            <key id="rft.place">Berlin :</key>
            <key id="licenseEnable">true</key>
            <key id="sfx.sid">primo.exlibrisgroup.com</key>
            <key id="rft.jtitle">Test</key>
            <key id="available_services">viewit</key>
            <key id="available_services">getit</key>
            <key id="rft.genre">journal</key>
            <key id="Incoming_URL">http%3A%2F%2Fdocedu-na01.alma.exlibrisgroup.com%2Fview%2Furesolver%2FTRAINING_1_INST%2Fopenurl%3Fdebug%3Dtrue%26svc_dat%3DCTO%26debug%3Dtrue%26debug%3Dtrue%26%26u.ignore_date_coverage%3Dtrue%26rft.mms_id%3D9926095600521%26rfr_id%3Dinfo%3Asid%2Fprimo.exlibrisgroup.com%26svc_dat%3Dviewit%26u.ignore_af_filter%3Dtrue%26internalAccess%3Dtrue%26isInNewWindow%3Dtrue</key>
            <key id="institution">521</key>
            <key id="internalAccess">true</key>
            <key id="rft.oclcnum">62155677</key>
            <key id="u.ignore_af_filter">true</key>
            <key id="req.id" xsi:nil="true"/>
            <key id="rft.mms_id">9926095600521</key>
            <key id="user_ip" xsi:nil="true"/>
            <key id="debug">true</key>
            <key id="inventory_id">519285510000521</key>
            <key id="rfr_id">info:sid/primo.exlibrisgroup.com</key>
            <key id="rft.inventory_id">519285510000521</key>
            <key id="publication_place">Berlin :</key>
            <key id="rft.object_type">JOURNAL</key>
            <key id="isInNewWindow">true</key>
            <key id="rft.publisher">Springer</key>
            <key id="ctx_id">1325448060000521</key>
            <key id="rft.pubdate">Began with: Vol. 1, no. 1 (Dec. 1992).</key>
            <key id="full_text_indicator">true</key>
            <key id="u.ignore_date_coverage">true</key>
            <key id="rft.title">Test</key>
            <key id="rft.lccn">2009252997</key>
            <key id="customer">510</key>
            <key id="rfr.rfr">primo.exlibrisgroup.com</key>
            <key id="rft.eissn">1863-8260</key>
            <key id="rft.eissn">1133-0686</key>
          </keys>
        </context_object>
        <context_services>
          <context_service service_type="getFullTxt" context_service_id="1325447980000521">
            <keys>
              <key id="package_name">ProQuest New Platform</key>
              <key id="package_public_name">ProQuest Pharma Collection New Platform</key>
              <key id="package_display_name">ProQuest Pharma Collection New Platform</key>
              <key id="package_internal_name">PROQUEST_PHARMA_COLLECTION_NEW_PLATFORM</key>
              <key id="interface_name">ProQuest New Platform</key>
              <key id="package_pid">619246910000521</key>
              <key id="service_type_description">Full text available via</key>
              <key id="character_set">iso-8859-1</key>
              <key id="Is_free">0</key>
              <key id="portfolio_PID">5310098520000521</key>
              <key id="cz_link_id">532670000001098994</key>
              <key id="electronic_material_type">JOURNAL</key>
              <key id="Availability">Available from 1997&lt;br> Most recent 1 year(s) not available&lt;br></key>
              <key id="static_url">true</key>
              <key id="parser_program">PROQUEST::open</key>
              <key id="parse_parameters">url=http://gateway.proquest.com/openurl &amp; clientid= &amp; url2=http://search.proquest.com&amp;jkey=1486339</key>
              <key id="Authentication_note"/>
              <key id="public_note"/>
              <key id="proxy_enabled">false</key>
              <key id="proxy_selected">DEFAULT</key>
              <key id="related_title">@TITLE (@RelationType)</key>
              <key id="is_related_service">false</key>
              <key id="is_closly_related">false</key>
              <key id="license_exist">false</key>
              <key id="crossref_enabled">no</key>
            </keys>
            <resolution_url>https://docedu-na01.alma.exlibrisgro...customerId=510</resolution_url>
            <target_url>http://gateway.proquest.com/openurl?...%2Fsid%3Aprimo</target_url>
            <is_error>false</is_error>
            <error_code>null</error_code>
          </context_service>
        </context_services>
        <performance_counters>
          <performance_counter name="TOTAL" duration="0.0"/>
          <performance_counter name="MMS_LOOKUP" duration="0.0"/>
          <performance_counter name="ENRICH" duration="0.0"/>
          <performance_counter name="PARSE" duration="0.0"/>
          <performance_counter name="GET_SERVICES" duration="0.01"/>
          <performance_counter name="FILTER" duration="0.003"/>
          <performance_counter name="SAVE" duration="0.005"/>
          <performance_counter name="GET_ZERO_TITLE_SERVICES" duration="0.0"/>
          <performance_counter name="FETCH_SERVICE_THRESHOLD_RULES" duration="0.0"/>
          <performance_counter name="CREATE_ZERO_TITLE_SERVICES" duration="0.0"/>
          <performance_counter name="SAVE_ZERO_TITLE_SERVICES" duration="0.0"/>
          <performance_counter name="GET_SINGLE_SERVICE" duration="0.0"/>
          <performance_counter name="EXECUTE_TARGET_PARSER" duration="0.0"/>
          <performance_counter name="GET_URESOLVER_CONTENT" duration="0.0"/>
          <performance_counter name="UPDATE_SELECTED" duration="0.0"/>
        </performance_counters>
      </uresolver_content>
      Example XML Debugger Output

    OCLC Control Number Matching with the OpenURL Link Resolver

    The OpenURL Link Resolver provides comprehensive matching on OCLC control numbers when processing an OpenURL with rft.oclcnum in the statement, as in the following example:
    http://<Alma delivery domain>/openurl/EX/example_services_page&rft.oclcnum=12345678
    This is achieved by separately indexing the 035 $a and 035 $z subfields. For information on the Alma delivery domain, see Your Alma Domain Names.

    Display Condition Rules

    Translatable

    The Alma Link Resolver (and Primo View It) supports rules that determine the conditions in which an electronic collection is presented to an end user. Display condition rules are defined in the Community Zone knowledge base and include, for example, a requirement that the incoming OpenURL includes article-level metadata elements. Condition rules are available for newspaper electronic collections and electronic collections like CCC Get It Now.

    After you activate or edit the electronic collection, you can view the display condition information and rules. Note that display condition rules cannot be edited or locally created. To view this information, select the Linking tab on the Electronic Service Editor page; and next to Availability rules, select the Service display condition rules link (for newspaper electronic collections) or the Service filter condition rules link (for the CCC Get It Now electronic collection).

    Service_Display_Condition_Rules_Link_02.png

    Service Display Condition Rules Link

    Electronic service editor - Service filter condition rules.png

    Service Filter Condition Rules Link

    This opens the Service Display Condition Rules page (for newspaper electronic collections) or the Service Filter Condition Rules page (for the CCC Get It Now electronic collection).

    Service display condition rule.png

    Service Display Condition Rules for Newspaper Electronic Collections

    Service filter condition rules.png

    Service Filter Condition Rules for CCC Get It Now Electronic Collections

    By default, there is OR logic applied between the rules identified in the Rule Name column. This means that when any of the rules in these examples are met, the newspaper electronic collection or the CCC Get It Now electronic collection appear when using the Alma Link Resolver or Primo View It. If none of the rules are met the newspaper electronic collection or the CCC Get It Now electronic collection does not appear in Alma Link Resolver or Primo View It.

    To view the details of each rule, select the rule number link in the Rule Name column. See below for examples of these rules.

    Rule_Details_Example_for_a_Newspaper_Electronic_Collection_02.png

    Rule Details Example for a Newspaper Electronic Collection

    Rule_Details_Example_for_a_CCC_Get_It_Now_Electronic_Collection_02.png

    Rule Details Example for a CCC Get It Now Electronic Collection
    • Was this article helpful?