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

    Access to Services

    TranslatableLinking Program (Target Parser)

    Refer to the documents under Alma and SFX that provides specific linking parameters which are required to enable full text linking.

    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

    Configuring Dynamic URLs for Electronic Collections and Portfolios

    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
    Instead of managing static links for local electronic collections and portfolios, you can create sophisticated dynamic URLs for local electronic collections and portfolios and embed OpenURL metadata information dynamically. In addition, you can use dynamic URLs to override linking provided by the community knowledge base.
    The Electronic Service Editor and Electronic Portfolio Editor pages enable you to define a list of conditions that are used to select a linking URL for the service or portfolio, respectively.
    Dynamic_URL_Linking_Information_Conditions_Example_NewUI_06_TC.png
    Dynamic URL Linking Information Conditions Example
    When using dynamic URLs, each condition must start with an IF statement that checks for the existence of ContextObject and OpenURL parameters. If all parameters exist for a condition starting at the top of the list, the specified URL for that condition is used for linking. Otherwise, the next condition will be checked, and so forth. To catch any case (use this to match if all other checks fail), use IF () <url>.
    For example:
    IF (rft.issn, rft.year, rft.volume)
    http://www.publisher.com/{rft.issn}/{rft.year}/{rft.volume}
    IF (rft.issn, rft.year)
    http://www.publisher.com/{rft.issn}/{rft.year}
    IF (rft.issn) http://www.publisher.com/{rft.issn}
    IF ()
    http://www.publisher.com
    If the first condition is met in the above example, the resulting dynamic URL may look something like the following:
    http://www.publisher.com/1364-0321/2010/2
    In addition to rft.year, you can also use rft.month, rft.day, and rft.date attributes.
    Test dynamic URL syntax enables you to verify the syntax of your conditions.
    For more information about configuring dynamic URLs for electronic collections, see the Dynamic URLs For Electronic Collections video (2:33 mins).

    See Commonly Used OpenURL Attributes for the URL Template for more information.

    URL Functions

    In addition, the dynamic URL may include any of the following functions to manipulate the values returned in the specified parameters:
    • SUBSTR (string, from, length) - Return a substring of the specified string, based on the starting position and length of the string. If {rft.date} contains 2010-08-01, and the first four characters from the beginning of the string are specified, as follows:
      http://www.publisher.com/{rft.issn}/SUBSTR({rft.date},0,4)
      Alma uses the following URL:
      http://www.publisher.com/1824-6321/2010
    • REPLACE (string, search, replace) - Replace text in the specified string, based on search and replacement text. If {rft.isbn} contains dashes (for example, 978-1-285-13563-2) and no replacement text is specified, as follows:
      IF (rtf.isbn)
      http://www.publisher.com/REPLACE({rft.isbn},-,"")
      Alma uses the following URL:
      http://www.publisher.com/9781285135632

    To replace a special character, use the encoded value of the replacement string.

    For example:

    REPLACE({rft.isbn},%3F,"")

    Instead of

    REPLACE({rft.isbn},?,"")

    • URLENCODE (string) - Encode special characters in the specified string. If {rft.atitle} contains the title The Grapes of Wrath, and encoding is requested, as follows:
      http://www.publisher.com/URLENCODE({rft.atitle})
      Alma uses the following URL:
      http://www.publisher.com/The%20Grapes%20of%20Wrath
    Electronic collections are available (to be published to Primo) after they have been activated. The exception to this is database type electronic collections, which are available to be published as soon as they are defined by a URL and an associated unsuppressed bibliographic record.
    You can define portfolios as standalone entities or as part of an electronic collection. The procedure for adding electronic collections and their associated portfolios is provided in Adding a Local Electronic Collection. The procedure for adding a portfolio independent of adding an electronic collection is provided in Managing Local Portfolios.

    Resolver Proxies

    Translatable
    To configure a resolver proxy profile, you must have the following role:
    • General System Administrator
    To enable off-campus users to access full text services at different vendor sites, you must define a proxy server, which is used to authenticate these users.

    The Alma Link Resolver responds to an incoming OpenURL and changes it to an electronic link by automatically including additional proxy information in the resolved URL. Some institutions use a single proxy server, in which case one proxy profile should be defined. If an institution uses several proxy servers, a proxy profile should be defined for each proxy server. You must then define the relevant proxy for each electronic collection, service, or portfolio.

    When distributing access to electronic resources through the Network Zone to members, proxies must be managed in the Institution Zone rather than the Network Zone. The Institution Zone proxy will override any proxy defined in a Network Zone collection.

    See the following for additional proxy information:

    Proxy Relationships

    The following table presents the relationships between the proxy-enabled setting for electronic collections, services, and portfolios. Portfolios inherit the proxy-enabled setting from the service-level setting to which they are attached. As a result, set a portfolio-level proxy-enabled setting only when you want it to be different from the service-level setting (in which case, leave the Proxy selected field on the service level blank). The electronic collection proxy-enabled settings are not inherited by portfolios.
    Proxy Relationships
    Proxy Enabled for Electronic Collection Level Proxy Enabled for Service Level Proxy Enabled for Portfolio Level Proxy Enabled Setting Results
    N N N Redirected to resource
    N N Y Redirected to proxy login
    N Y N Redirected to proxy login
    Portfolio inherits service setting
    N Y Y
    The electronic collection does not inherit proxy settings from the service or portfolios. If a proxy profile is selected on the service level, portfolios inherit the proxy setting from the service level. To set the proxy for the portfolio level, leave the Proxy selected field of the service-level setting blank.
    Y N N Redirected to the resource
    The Electronic Collection proxy is not inherited by the service or portfolio level
    Y N Y Redirected to proxy login
    Y Y N Redirected to proxy login
    Portfolio inherits the service setting
    Y Y Y Redirected to proxy login
    • To apply a 'Group Settings' Proxy for Portfolios, the Proxy needs to be applied in the' Group Settings' tab of the Electronic Service.
    • To apply a 'Group Settings' Proxy for the Electronic Collection, the Proxy needs to be applied in the 'Group Settings' tab of the Electronic Collection Editor.

    Configuring a Proxy

    To configure an integration profile of Resolver Proxy type:
    1. On the Integration Profile List page (Configuration Menu > General > External Systems > Integration Profiles), select Add Integration Profile. The first page of the integration profile wizard appears.

    2. Select Resolver Proxy for Integration Type.

    3. Enter a name (Code) for the profile you are defining and, optionally, enter a description.

    4. Select Default if you want the profile you are defining to be the default proxy definition profile. (If you previously defined another profile as the default profile, clear the Default selection in the other profile before selecting Default in this profile). If the proxy is set as the default, and Actions (see below) is set to Always, then this proxy is used for resolving any resource, even resources that do not have ProxyEnabled=Yes.

    5. Select Next. The second page of the wizard appears.

      Resolver_Proxy_Integration_Profile_2.png

      Resolver Proxy Integration Profile – Step 2 (Proxy Definitions)
    6. Select the type of proxy server that you want to configure for this profile.

      There is no option to enter multiple IP addresses. The "Proxy IP" field should hold the proxy server IP address and not some allowed IP range. In case the OpenUrl request will come from this IP address, the proxy will not be added to the target Url, and this is to avoid looping. 

      The following options are available:

      • Biblio-Pam – This server proxy uses the following URL structure:

        The <Biblio-PAM URL> portion of the structure is the vendor-provided URL from Biblio-PAM.

        The <shortened target URL> is the target URL without the http:// or https://.

        • https://<Biblio-PAM URL>/http/<shortened target URL>

        • https://<Biblio-PAM URL>/https/<shortened target URL>

      • EZProxy – This option uses the following URL structure where $@ is the placeholder for the target URL:
        • https://www.ezproxy.unibo.it/login?
        See EZProxy URL Database for more information.
      • HAN – This option uses the following URL structure:
        • http://<HAN server>/hanapi/?hash=<HASH>
        Enter the http://<HAN server> portion for the Proxy url parameter.
        The remainder of the URL structure is constructed by Alma and appended to the portion of the URL that you entered in the Proxy url parameter.
        For the HAN proxy server type, you need to enter a Salt parameter. The Salt parameter is a free text field that may contain any alpha-numeric value. The value that you enter must identically match the salt value in the HAN proxy server configuration in your HAN account. When you create the HAN salt value in your HAN account, copy it to the Salt parameter in Alma.
      • LIBProxy

      • OpenAthens Redirector – This option uses the following URL structure:
        • https://<OpenAthens Redirector URL>?url=<encoded target URL>
        The <OpenAthens Redirector URL> portion of the structure is the vendor-provided URL from OpenAthens.
        Enter https://go.openathens.net/redirector/<your domain> for the Proxy url parameter.
        The ?url= portion of the URL is added by Alma.
        The <encoded target URL> is the target URL in its encoded form.
        Note that even though Redirector is not a proxy server, the Alma proxy server configuration can be used.
      • WAM
        Note that you should omit the 0- at the beginning of your proxy URL.
      • RemoteXS
        Institutions utilizing the RemoteXS proxy have the capability to configure Alma's link resolver to seamlessly integrate with this proxy.
    7. Enter the proxy URL as provided by the vendor (including http:// or https://) and the proxy IP address.

    8. Select one of the following values for Use Proxy:

      • Always – The proxy is used for any resolving.

        If this proxy is selected as default, it is used for any resolving, even for resources (services, collections, or portfolios) with EnableProxy=No.

        If this proxy is not selected as default, it is used for resources where EnableProxy=Yes and this proxy is selected.

        This configuration overrides the configuration in the Network Zone.
      • Never – This proxy is never used for resolving, even if it is enabled and selected for a particular resource.

      • Selective – This proxy is used for resources where EnableProxy=Yes and this proxy is selected (this is equivalent to selecting Always for a non-default proxy).

        Even if this proxy is selected as the default, it must be added to the resource explicitly.

    9. Select Save. The profile is saved.

    Translatable
    Translatable

     

    Configuring General Electronic Services

    To configure general electronic services, you must have one of the following roles:

    • General System Administrator

    • Fulfillment Administrator

    In addition to services found in your own collection (such as full text, requests, and so forth), Alma enables you to define general HTTP services (such as searches in ProQuest dissertations and Amazon.com, Ask a Librarian, and so forth) to present to patrons in the View It, Get It, and How to Get It sections on the record's full display page. Services that allow users to access or purchase the materials are considered delivery-related and will appear in the View It, Get It, and How to Get It sections on the record's full display page.

    To have these services appear in Leganto, see Enabling General Electronic Services in Leganto.

    AlmaP_GES_Example_newUI.png

    Electronic Service Example (Primo View It)

    In order to create a general electronic service, you must be familiar with the syntax of the service’s URL, which includes any parameters that are required to query or access specific information from the service. The service’s URL along with OpenURL context object attributes returned from Alma’s link resolver are used to define the URL template, which Alma uses to create the service link that appears in View It and/or Get It.

    In addition, you can configure the following display settings for general electronic services:

    You can also share your general electronic services in the Community Zone, and use general electronic services defined by other institutions. See Sharing General Electronic Services in the Community Zone

    To add a general electronic service:

    It is recommended to use ExLibris' Unpaywall service in View It and not an externally used customer Unpaywall GES. This is because the open access in ExLibris' Unpaywall service is 100% available. 

    1. Open the General Electronic Services Configuration page (Configuration Menu > Fulfillment > Discovery Interface Display Logic > General Electronic Services).

      GES_NewUI.png

      General Electronic Services List (Alma-Primo)
      • The Item Level column is hidden by default; you can add it to the table by selecting the Manage Column Display icon above the table.

      • The Is this a Document Delivery/ILL Service column is available only with Primo VE and Alma-Summon environments.

    2. Select Add Service. The Add Service dialog box opens.

      Alma Summon/Primo VE Add Service dialog box

      Add Service Dialog Box

      Unless otherwise noted, all fields are supported in the following environments: Alma-Primo, Primo VE, and Alma-Summon.

    3. Enter the following service information:

      • Service Code – The internal code for the service.

      • Service Name – The internal name used for the service.

      • Service Description – The description of the service.

      • Public Name – The label for the link that displays in View It and/or Get It.

      • Public Note – The note or description of the service that displays below the link in View It and/or How To GetIt.

      • Is this a Document Delivery/ILL service – Select Yes to indicate that this service is delivery-related and provides access to the resource. Select No to indicate that this service is not delivery-related and will appear under the Links section.

        This field is not available with Alma-Primo environments.

      • Display Location – Specify the section on a record's full display to which you want to display the GES link. The following table lists the available options per customer environment:

        The Display Location is only displayed if Is this a Document Delivery/ILL service is selected Yes.
        The Display Location is not displayed if Is this a Document Delivery/ILL service is selected No.
        Alma-Primo Primo VE and Alma-Summon
        • Getit
        • Viewit
        • Getit & Viewit
        • None – Services appear under the Links section in the record's full display.
        • Getit & How to Getit
        • Viewit & How to Getit
        • Getit, viewitand How to Getit
        • None – Services appear under the Links section in the record's full display.

        The How to Get It section displays only when a record has no inventory. Typically, the How to Get It section is used for resource sharing and relevant ILL service links.

        • For Primo VE and Alma-Summon only, this field appears only when the Is this a Document Delivery/ILL Service field is set to Yes.

        • The display of general electronic services is based on the service's availability rules that are defined with the Service Availability Rules tab, which appears while editing a general electronic service. For more details, see step 5. See Configuring Display Logic Rules if you want to hide the general electronic service based on additional criteria (such as the existence of another type of service or the type of user).

      • URL Template – The URL where the patron is redirected when the external service link is selected. The external service link is comprised of the base URL of the service, and any parameters that are required to query or access specific information from the service. It is formatted according to the syntax of the URL of the service. For more information, see  URL Template.

      • Item Level – Select Yes to show the link next to each item that matches the input rules. Select No to show the link at the holding level.

        • This option displays only when the value of the Display Location field includes GetIt.
        • To prevent potential performance issues, Item-level General Electronic Services cannot be used for the If Exists portion of Display Logic Rules.

        For more information, see Item-Level General Electronic Service.

    1. Select Add and Close. The new service appears on the General Electronic Service page with the following row actions: Remove and Edit.

    2. Edit the new row to configure additional service details.

      The Service Details page appears.

      AlmaPrimo_ServiceDetails_ProQuest.png

      Service Details Page (Service Details Tab)
    3. To display this service to signed-in users only, select No in the Enable without login field.

    4. To hide this service based on the availability of the physical resource in the institutional repository, select one of the following options for Disable Service:

      When a guest user or a user without a configured campus performs any of the campus-level disabling activities, Alma disables/hides the service based on a self-ownership check done at the institution level.

      • Never – The service is never disabled.

      • When resource is owned by the campus – The service is disabled when physical items for the resource are owned by the campus.

      • When resource is owned by the campus and available – The service is disabled when physical items for the resource are owned by the campus and are available (that is, they are not involved in a process).

      • When resource is owned by the institution – The service is disabled when there are physical items for the resource that are owned by the institution.

      • When resource is owned by the institution and available – The service is disabled when there are physical items for the resource that are owned by the institution, are in place, and are in an open location. Note that if a physical location is set to Unavailable (see Adding a Physical Location) and this option is selected, the service is enabled. You may want to use this option when items in a certain location (such as a reading room) cannot be requested. Setting this location to Unavailable will enable the display of the service.

    5. Select the Service Availability Rules tab.

      The Service Availability Rules tab displays the rules that the system uses to determine whether a service should be hidden from the user. Each service has a default rule that is applied when none of the other rules apply. The Default general electronic service rule hides the service by default (IsDisplay=False). You can edit the default rule and add rules as needed.

      GES_ServiceAvailabilityRules_NewUI.png

      Service Availability Rules Tab
    6. Add rules regarding the OpenURL context object attributes (which may be returned by Alma’s link resolver during the user’s search) to ensure that Alma has the necessary information to display the service.

      • The available attributes are standard OpenURL attributes. For more information, see Commonly Used OpenURL Attributes for the URL Template.

      • The following item level attributes may be used when item level services are configured:

        • material_type

        • item_policy - values are populated from the institution's Item Policy table. See Configuring Item Policies.

        • process_type

        • base_status - values are Item not in place and Item in place.

        • storage_location_id

        • item_call_number 

      • Adding parameters within a rule will cause the parameters to have an AND relationship with each other, meaning that all values must be true before the rule is considered true. For OR conditions, where only one value must be true, parameters should be entered separately in a new rule.

      • If multiple rules evaluate to true, the output parameter will be applied based on the first rule that is true.

      1. To add a new rule, select Add Rule. The Edit Rule page opens.

        AddGES_Rule_NewUI.png

        Edit Rule Page
      2. In the Edit Rule section, enter the rule name (required) and description (optional).

      3. In the Input Parameters section, select Add Parameter. The Add Parameter dialog box opens.

        GES_AddParameter_NewUI.png

        Edit Rule Page
      4. Enter the following fields:

        • Name – The name of the attribute in the OpenURL context object. For more information about these attributes, see Commonly Used OpenURL Attributes for the URL Template.

        • Operator – The comparison operator to use with this context object attribute.

        • Value – An accepted value for this parameter. To match multiple values, create a separate rule for each value. Note that not all operators require a value.

      5. Select Add Parameter. The parameter is added to the input parameter list.

      6. In the Output Parameters section, set IsDisplay to true.

      7. Select Save. The Service Availability Rules page displays the new rule.

    7. Select Save. The General Electronic Services page displays the new service.

    In a collaborative network, you can create general electronic services in the Network Zone and then distribute them to member institutions. The member institutions have view permission to the distributed records but are not able to edit or delete them. When the Network Zone general electronic service has been distributed, the local list will show either the distributed records only or both the distributed records and the previous local general electronic service records, depending on the configuration in the customer parameter, network_ges_distribution_members_behavior.

    General Electronic Services New UI.png

    General Electronic Services List for a Member Institution

    For more information, see Configuring Fulfillment Information in the Network Zone.

    URL Template

    The URL substitutes OpenURL fields that are enclosed in brackets ( "{" and "}") with the relevant values. For example, the referring URL’s ISBN is substituted into a URL containing: ...&isbn={rft.isbn}&...

    For example, the URL for an Amazon search for a specific ISBN:

    http://www.amazon.com/s/ref=nb_sb_ss_c_0_12?url=search-alias%3Dstripbooks&field-keywords={rft.isbn}

    When connecting to a resource sharing broker, ensure that this field contains an attribute corresponding to the broker in use. For example, when using the OCLC broker:

    http://xxx.worldcat.org/oclc/{rft.oclcnum}

    ILLiad - Books/Book Items (based on your institution’s base URL). For example:

    http://libill.XXX.edu/illiad/illiad.dll?Action=10&Form=30&rft.genre={rft.genre}&rft.title={rft.btitle}&rft.stitle={rft.stitle}&rft.atitle={rft.atitle}&rft.date={rft.pubdate}&rft.month={rft.month}&rft.volume={rft.volume}&rft.issue={rft.issue}&rft.number={rft.number}&rft.epage={rft.epage}&rft.spage={rft.spage}&rft.edition={rft.edition}&rft.isbn={rft.isbn}&rft.eisbn={rft.eisbn}&rft.au={rft.aulast},{rft.aufirst}&rft.auinit={rft.auinit}&rft.pub={rft.pub}&rft.publisher={rft.publisher}&rft.place={rft.place}&rft.doi={rft.doi}&rfe_dat={rft.oclcnum}&rfr_id={rfr_id}

    ILLiad - Articles/Journals (based on your institution’s base URL). For example:

    http://libill.XXX.edu/illiad/illiad.dll?Action=10&Form=30&rft.genre={rft.genre}&rft.title={rft.title}&rft.stitle={rft.stitle}&rft.atitle={rft.atitle}&rft.jtitle={rft.jtitle}&rft.au={rft.au}&rft.date={rft.year}&rft.month={rft.month}&rft.volume={rft.volume}&rft.issue={rft.issue}&rft.number={rft.number}&rft.spage={rft.spage}&rft.epage={rft.epage}&rft.edition={rft.edition}&rft.issn={rft.issn}&rft.eissn={rft.eissn}&rft.aulast={rft.aulast}&rft.aufirst={rft.aufirst}&rft.auinit={rft.auinit}&rft.pub={rft.pub}&rft.pubdate={rft.pubdate}&rft.pubyear={rft.pubyear}&rft.publisher={rft.publisher}&rft.place={rft.place}&rft.doi={rft.doi}&rfe_dat={rft.oclcnum}&rfr_id={rfr_id}

    ProQuest - Dissertation Service. For example:

    http://gateway.proquest.com/openurl?res_dat=xri%3Apqm&title={rft.btitle}&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adissertation&url_ver=Z39.88-2004&genre=dissertation

    The following values can be specified in the URL Template parameter between the curly brackets used for normalizing the ISBN, ISSN, eISBN, or eISSN:

    • rft.normalized_isbn

      This normalization removes the text after digits and the hyphen (-) and converts ISBN 10 to ISBN 13

    • rft.normalized_issn

      This normalization removes the text after digits and changes text to lower case.

    • rft.normalized_Eisbn

      This normalization removes the text after digits and the hyphen (-) and converts ISBN 10 to ISBN 13.

    • rft.normalized_Eissn

      This normalization removes the text after digits and changes text to lower case.

    For more information regarding OpenURL, refer to the following:

    Commonly Used OpenURL Attributes for the URL Template

    The following table describes general categories by which the OpenURL attributes returned from Alma’s link resolver are grouped.

    OpenURL Attribute Categories
    Category Prefix Description
    Requester req. Information about the requesting entity, that is, the patron. Not used when creating service availability rules for general electronic services.
    ReferringEntity rfe. Information about the referring entity, i.e. Primo. Not used when creating service availability rules for general electronic services.
    Referent rft. Information about the requested item.
    ServiceType svc. Whether a particular format of the Referent is available: "yes" or "no". For example, whether the requested target is available as an abstract or as full text. Multiple service types may be available.
    Other various Other returned values are unused, unless noted below.
    Any attributes returned by the link resolver, that do not belong to any of the 4 categories above, are unused; they should not be selected when creating an input parameter for a Service Availability Rule. For additional information about OpenURL attribute categories see the related knowledge article.
    The following are commonly returned attributes that can be used to create service availability rules. Some of these attributes are taken from the MARC 21 fields of the relevant records. For these attributes, the MARC 21 sources appear in the MARC 21 Fields column. Attributes that are not taken from MARC 21 fields are retrieved from various other sources, including CDI records, Primo, OpenURL, and other external sources.
    Commonly Returned OpenURL Attributes from Alma’s Link Resolver
    Attribute PNX Mapping MARC 21 Fields Description
    req_id     The PDS handle (see Identify Patrons to Provide Relevant Services)
    rft.advisor     Advisor, for a dissertation
    rft.applcc     Application country code in ISO two-character format, for a patent. The country in which the patent application was main.
    rft.appldate     Date of application for a patent
    rft.applyear     Year of application for a patent
    rft.artnum addata/artnum   Article number. Assigned by the publisher. A URL may be the only usable ID for an online article.
    rft.assignee     Assignee, for a patent: "Smith, John J.", "IBM"
    rft.atitle addata/atitle   Article or chapter title
    rft.au addata/au 100 or 110 or 111 One author's full name: "Smith, Fred James Jr."
    rft.aucorp addata/aucorp   Organization or corporation that created document: "Mellon Foundation"
    rft.aufirst     First author's given name: "Fred James" May have spaces and punctuation.
    rft.auinit addata/auinit   First author's first and middle initials
    rft.auinit1 addata/auinit1   First author's first initial
    rft.auinitm addata/auinitm   First author's middle initial
    rft.aulast addata/aulast   First author's last name: "Smith" May have spaces and punctuation.
    rft.ausuffix addata/ausuffix   First author's name suffix: "Jr." etc.
    rft.bici addata/bici   Book Item and Component Identifier (BICI code)
    rft.btitle addata/btitle For the LDR positions, see Fields that Identify the Bibliographic Material Type. Book title, if the LDR material_type = BK. See rft.jtitle.
    rft.cc     Publication country code, in ISO two-character format: "US". See co.
    rft.chron     Enumeration or chronology not in standard format: "1st quarter". Where possible, use date. See ssn and quarter.
    rft.co     Publication country: "United States". See cc.
    rft.coden addata/coden 030 a CODEN (alphanumeric code)
    rft.date addata/date   Publication date. For a patent, this is the date that the patent was issued. Format is YYYY, YYYY-MM, or YYYY-MM-DD.
    rft.day     Publication day
    rft.dcContributor     Dublin Core contributor: person, organization, or service
    rft.dcCreator     Dublin Core creator: person, organization, or service
    rft.dcDescription     Dublin Core description: abstract, table of contents, graphical representation, or free text
    rft.dcFormat     Dublin Core format: File format, physical medium, or dimensions, such as MIME type
    rft.dcIdentifier     Dublin Core identifier: Unambiguous resource identifier
    rft.dcLanguage     Dublin Core language: Resource language
    rft.dcPublisher     Dublin Core publisher: person, organization, or service
    rft.dcRelation     Dublin Core relation: A related resource
    rft.dcRights     Dublin Core rights: Rights information
    rft.dcSource     Dublin Core source: A related resource from which this resource was taken
    rft.dcSubject     Dublin Core subject: keywords and classification codes
    rft.dcTitle     Dublin Core title: Resource title
    rft.dcType     Dublin Core type: nature and genre, such as described by DCMITYPE. For format, see dcFormat.
    rft.degree     Degree issued, for a dissertation
    rft.doi addata/doi   DOI (digital object identifier) field
    rft.edition display/edition 250 a Book edition, typically a phrase, with or without numbers: "First edition", "4th ed.".
    rft.eisbn addata/eisbn 020 a if there is no 020 e and the record is not physical; otherwise, 020 e International Standard Book Number for electronic version. May be multiple ISBN, separated by commas. May contain a hyphen. May or may not be distinct from rft.isbn.
    rft.eissn addata/eissn 022 a if there is no 022 e and the record is not physical; otherwise, 022 e International Standard Serial Number for electronic version. May be multiple ISSN, separated by commas. May contain a hyphen. May or may not be distinct from rft.issn.
    rft.epage addata/epage   End page of article/chapter within volume/issue.
    rft.format addata/format   MIME type of the format
    rft.genre addata/genre   One of:
    • article: document published in a journal
    • book: complete in a single part, often identified by an ISBN
    • bookitem: section of a book, usually with a title or number
    • conference: record of a conference (one or more conference papers)
    • issue: single issue
    • preprint: paper or report published in print or electronically prior to publication in journal or serial
    • proceeding: conference presentation published in a journal or serial publication
    • report: report or technical report published by an organization, agency, or governmental body
    • unknown
    • document
    • dissertation
    • journal
    • patent
    • audio
    • series
    • score
    • video
    • videorecording
    rft.inst     Issuing institution, for a dissertation
    rft.inventor     Inventor’s full name: "Smith, John J.". For a patent.
    rft.invfirst     Inventor’s given names: "John J.". For a patent.
    rft.invlast     Inventor’s last name: "Smith". For a patent.
    rft.isbn addata/isbn 020 a if there is an 020 e; otherwise, 776 z if the record is not physical or 020 a if there is no 020 e and the record is physical International Standard Book Number. Nine digits plus a check digit. May contain hyphens.
    rft.issn addata/issn 022 a if there is no 022 e and the record is physical; otherwise, 022 a if there is an 022 e or 776 x if the record is not physical International Standard Serial Number. May contain a hyphen. ISSN for a book may be associated with the series.
    rft.issue addata/issue   Journal issue: "Spring 1998". Typically numeric.
    rft.jtitle addata/jtitle For the LDR positions, see Fields that Identify the Bibliographic Material Type. Full journal title, if the LDR material_type = CR. See rft.btitle. For example, "Journal of the American Medical Association". For short title, use stitle.
    rft.kind     Patent kind code, for a patent: "AU A1". Kind codes are meaningful within the country of origin.
    rft.lccn addata/lccn 010 a,z Library of Congress control number
    rft.mms_id     MMS ID of the item
    rft.month     Publication month
    rft.number     Application number, for a patent
    rft.object_type   For the LDR positions, see Fields that Identify the Bibliographic Material Type. The LDR material_type. The default is BOOK.
    rft.oclcnum addata/oclcid 035 a,z OCLC control number or journal level OCLC number. May be multiple OCLC control numbers, separated by commas.
    rft.pages addata/pages   Start and end pages of article/chapter within volume/issue: "53-58". Can also contain pages not in sequence, e.g. "12-6,64-67". See spage and epage.
    rft.part addata/part   Either a subdivision of, or in place of, volume. Examples: "B", "Supplement".
    rft.place addata/cop 260 a or 264 a Publication place: "New York".
    rft.prioritydate     Priority date for a patent
    rft.pub addata/pub 502 a,c or 260 b or 264 b Publisher name: "Harper and Row".
    rft.pubdate   260 c or 260 g or 264 c or 362 a or 008(date1) Publication date, for a patent
    rft.publisher   502 a,c or 260 b or 264 b Publisher name
    rft.pubyear     Year of publication
    rft.quarter addata/quarter   Chronology: "1", "2", "3", or "4". For non-standard chronology, use chron.
    rft.series addata/seriestitle   Title of the series that contains this book. There may also be an ISSN associated with the series.
    rft.sici addata/sici   Serial Item and Contribution Identifier (SICI code)
    rft.spage addata/spage   Start page of article/chapter within volume/issue
    rft.ssn addata/ssn   Season: "winter", "spring", "summer", or "fall". For non-standard season, use chron.
    rft.stitle addata/stitle 245 a Short journal title: "J Am Med Assn". For full title, use jtitle.
    rft.title   245 a,b Book title (deprecated: use btitle), journal title (deprecated: use jtitle), dissertation title, patent title
    rft.tpages     Total pages: "392". Typically only for monographs (books and printed reports). May not be numeric: "F96".
    rft.volume addata/volume   Journal volume: "124". Typically numeric, but may be roman numerals, etc.
    svc.abstract     Abstract
    svc.any     Any format
    svc.citation     Citation
    svc.fulltext     Full text
    svc.holdings     Holdings information. This field is not used to hide services based on whether the record has holdings. If it is included in the OpenURL, it will be saved in the Context Object for use in the GES.
    svc.ill     Interlibrary loan

    Item-Level General Electronic Services

    When the General Electronic Service is added as an item-level service, you can configure the URL template to include the following Holdings and item-level information:

    Holdings/Item Element Name of Placeholder
    Current Library (Code) library
    Current Location (Code) location
    Current Call Number call_number
    Barcode barcode
    Material Type (Code) material_type
    Current Item Policy (Code) item_policy
    MMS ID mms_id
    Process Type (Code) process_type
    Item description description
    Storage Location ID storage_location_id
    Item Call Number item_call_number

    In addition, it is possible to add fields from the Holdings record to the URL template. The placeholder syntax is HOL_{field}_{indicators}_{subfields}. The use of indicators is optional. For example:

    • HOL_506_ab - Alma will extract subfields a and subfield b from 506 field. Each subfield will be delimited from the next one with a space. The indicators are not taken into account.

    • HOL_506_12_df - Alma will extract subfields d and subfield f from 506 field only when indicators 1 and 2 exists. Each subfield will be delimited from the next one with a space.

    • HOL_506_1#_g - In this scenario, Alma will extract subfields g from 506 field only when the first indicator value is 1 with no dependency on the second indicator.

    A sample URL template may be : <baseURL>?LIB={library}&BARCODE={barcode}&FIELD1={HOL_506_ab}.

    Allow any Field from the Bibliographic Record to be Used when Defining a General Electronic Service

    The "General Electronic Services Bib Fields Enrichment" configuration screen (Configuration > Fulfillment > Discovery Interface Display Logic) enables institutions to define which field will be extracted from the record's metadata and be available for use when defining an "Availability Rule" or enhancing the "URL template" field upon definition of a "General Electronic Service" (Configuration > Fulfillment > Discovery Interface Display Logic > General Electronic Services).

    Below is an example workflow:

    1. Access the new configuration screen and add a new row to point to the specific bibliographic field (020_a in the example).

    Define the Bib field.

    Define the Bib Field

    2. You can find the newly defined bibliographic field in the input parameters section of a rule.

    Define GES Rule.

    Define GES Rule

    3. You can also utilize the newly defined field in the URL Template field of the general electronic service.

    Add New Name to URL Template.

    Add New Name to URL Template

    4. Below is an example of how this will appear to patrons in the Discovery (Primo) system, as well as how the actual URL will be constructed.

    GES in Search Results.

    Constructed URL

    When adding a row to the "General Electronic Service Bib Fields Enrichment" configuration screen, you need to define the Record format, Bibliographic field and subfield. The defined value within the "Field Name in General Electronic Service" will be the one that appears when defining the General Electronic Rule/URL template.

     

    1. When 2 bibliographic records are matched, the logic will only apply on the "Selected" bibliographic record.

    2. In case the URL template field starts with a parameter place holder with no text or URL before it (and regardless of what comes after it), no decoding will be done
        to the first parameter's information.
     

    3. For Network Zone members, General Electronic Services that use values from the "General Electronic Service Bib Fields Enrichment" page, it is recommended to 
        use the same names as in the network zone. This is in order to display the General Electronic Service for institution or network zone resources. 

    For more information, see General Electronic Services.

    Sharing General Electronic Services in the Community Zone 

    To share and copy shared General Electronic Services, you must have one of the following roles:

    • Fulfillment Administrator
    • General System Administrator

    Institutions spend many hours creating general electronic services. In order for these institutions to save time and effort, librarians can contribute their general electronic services to the Community Zone and copy and use the general electronic services that other institutions contributed to the Community Zone. Once the general electronic service has been copied to the institution, the institution can make changes to it in order to customize it for its needs. 

    When a general electronic service is contributed, all its related rules are contributed as well.

    Contributed general electronic services appear in the Community tab on the General Electronic Services page (Alma Configuration > Fulfillment > Discovery Interface Display Logic > General Electronic Services). Copied general electronic services appear in the Institution tab. 

    The general electronic services set by the network institution also appear in the Institution tab. To distribute the general electronic service to consortia members, the Distribute Fulfillment Network Configuration job is used (see Configuring Fulfillment Information in the Network Zone). This is since these general electronic services are managed by the network institution and therefore, cannot be edited or contributed by the member institution. 

    To contribute general electronic services to the Community Zone:
    1. From the row actions, select Contribute for a general electronic service on the Institution tab of the General Electronic Services page (Alma Configuration > Fulfillment > Discovery Interface Display Logic > General Electronic Services).

      General electronic services page.jpg

      A confirmation message appears.

      confirm message for sharing GES.jpg

    2. You can optionally change the Service Code and Service Name.
    3. It is recommended that you change the Description to include detailed information for institutions that will copy the GES. 
    4. You can optionally enter or change the name and email address for the Contact person.
    5. Select Confirm. The service appears in the Community tab and can be copied by any institution.

    In case the general electronic service has been already contributed by the institution to the CZ, you may also edit and re-contribute an edited general electronic service. The latest general electronic service overwrites the previous general electronic service. This action has no effect on local copies of the general electronic services used by other institutions. 

    To view contributed general electronic services and/or copy a contributed services:
    1. Open the Community tab on the General Electronic Services page (Alma Configuration > Fulfillment > Discovery Interface Display Logic > General Electronic Services).

      To view more information about the general electronic services, from the row actions, select View. The profile details appear.

    2. Select Copy in the row actions list of the general electronic service. The general electronic service is copied to your institution and the new general electronic service is opened for editing. The general electronic service is copied and Its status is Inactive by default.
    3. Edit the general electronic service details to match your requirements.
    4. When you are done, select Save.
    5. Select the Institution tab to view the general electronic service that you copied.
    To remove (unshare) a general electronic service you contributed from the Community Zone:
    • Select Delete in the row actions list of the general electronic service and select Confirm in the confirmation dialog box.

      The general electronic service is no longer available to other institutions. However, it is not deleted; you can continue using it in the Institution tab. Also, if another institution already copied this general electronic service, the deletion of your general electronic service has no effect on their local copy.

    Configuring the Order of General Electronic Services

    To configure the order of general electronic services, you must have one of the following roles:
    • General System Administrator
    • Fulfillment Administrator

    With the General Electronic Services Order page, you can configure the order in which general electronic services appear in Primo. Like other services, you can also assign services to appear in the first or last group in the list.

    You can only configure the order of general electronic services at the institution level. Select the required institution from the Configuring filter on the Fulfillment Configuration page.

    General electronic services page.jpg

    General Electronic Services Order Page

    This page does not have a Save button. Every selection made here is saved in Alma automatically. 

    To configure the display order of general electronic services:
    1. Open the General Electronic Services Order page (Configuration Menu > Fulfillment > Discovery Interface Display Logic > General Electronic Services Order). 

    2. Select Add to top or Add to last services to configure the order of services at the top and bottom of the list of results, respectively.
      PVE_DefineOrderForService.png

    3. In the Service type field, select General Electronic Service.

    4. In the Service name field, select Service.

    5. In the Service value field, select a service value.

    6. Depending on which list you are defining, select either Add to topAdd to last services. The service appears in the list that you are defining.

    7. For each list, select the arrows in the Move Up and Move Down columns to order the services.

    Translatable

    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.
    Translatable

    Troubleshooting - 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 get the following information:
    • 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 debug the Open URL:
    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

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

        3. Right-click the Electronic Services page and select the option to view the page source 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. Select and and copy the URL.

          HighlightCopyDebug_URL.png

        5. Open a new browser page or tab, paste the debug URL that you copied into the address bar, 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

        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.

          For example:

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

          PVE_DisplayCTO_Button.png

        3. Select Display CTO to display the XML debugger output.

    3. Scroll through the XML output to analyze/debug your search result issues.

    The XML Output

    The XML output is comprised of two elements:

    • The <context object> element - this is the container for the metadata information about the OpenURL object. This element is a container of all the metadata information, such as the ISSN, the title, the publication date, etc. This is the metadata that Alma collected as part of the analysis of this OpenURL.
    • The <context services> element - contains information regarding service type, parsing, proxy, the target URL, and so forth. Alma calculated these services as relevant for this OpenURL. This element also contains the target_url.

    This is an example of XML Debugger Output:

    <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>

            Note: to get the <target_url> result in Primo VE, it's not sufficient to use         showCTO=true. You must open the CTO, take the "incoming URL" and add         debug=true&svc_dat=CTO to it (debug=true is needed for the target URL to be         displayed). 

          <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>

    Analyzing / Debugging Search Result Issues

    The debugger provides information about the processing of the OpenURL, about the calculation of services, and also provides the target_url that was created in order to link to a title. 

    Looking at the <context services> element, we can see all services that Alma calculated as being relevant to this OpenURL. This can help in the following ways:

    • The target_url key displays the link that was generated by Alma. This can help you see if this is a problem with the URL that was created by Alma, or a problem with the vendor side. This link has information that can help you debug some of the issues you are facing. 
    • You can also better understand the Linker Service page. For example, if you expected a certain service to appear, but it is not appearing, check the following:
      • Coverage information. It may be that the expected service does not fit the coverage information. For example, you may be looking for vol. 1, issue 1, but the library only purchased access as of vol. 2. Thus, Alma filtered out this specific service.
      • ISBN/ISSN number. The link might be one that requires an ISBN. Your citation might be one that has an ISSN. Thus, the link to Alma is not appearing.
      • Display logic rules. Services might also be filtered out due to display logic rules that were defined.

    Note 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 out because it was outside of the specified date range.

    Link Resolver Usage Analytics Reports

    For information about the fields available in Alma Analytics with which you can create analytics reports concerning link resolver usage, see Link Resolver Usage. For general information on Alma Analytics, see Analytics.

    Alma Link Resolver Special Services

    Open Access

    Users can enable a link resolver service for Unpaywall Open Access articles:
    • 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.
    • Unpaywall service limits calls based on the email sent in the API request. If the institutional email is not defined, create an institution-specific general invalid email and include it in the API. Go to Configuration > General > Add a Library or Edit Library Information > Contact information
    • Indication added to verify no proxy used in CDI Links for OA Links.  Alma verifies that links returned by CDI do not use a proxy for OA links. This is especially useful for customers that have a proxy set up but do not want to use the proxy for OA links.

      To verify the proxy is not used, an OA indication is added. The indication is applied to the following links returned by CDI:
      • linktorsc (regular 'Link in record' links)
      • linktorsradditional (All links)
      • linktopdf (Quicklinks)
      • linktohtml (Quicklinks)
    CDI provides information to OA per link in the linktorsc /linktorsradditional section as follows:
    <links>
    <linktorsradditional>$$U<link>$$G<Provider>$$H<OA></linktorsradditional>
    <linktorsradditional>$$U<link>$$G<Provider>$$H<OA></linktorsradditional>
    <linktorscr>$$U<link>$$G<Provider>$$H<OA></linktorscr>
    </links>
    $$H contains the string "free_for_read" indication for OA links. If OA link is not detected, $$H is left blank or does not exist. If a link includes the "free_for_read" indication, this is taken into account when deciding to prepend/not prepend the proxy URL.
    Examples:
    <linktorscr>$$Uhttps://www.doaj.org/ABC/123.pdf$$EPDF$$P1$$GDOAJ$$Hfree_for_read</linktorscr>
    <linktorscradditional>$$Uhttps://www.doaj.org/ABC/123.pdf$$EPDF$$P1$$GDOAJ$$Hfree_for_read</linktorscradditional>
    <linktorsrcadditional>$$Uhttp://api.digitalnz.org/records/43...n_$$GDigitalNZ$$Hfree_to_read</linktorsrcadditional>
    <linktohtml>$$Uhttps://www.proquest.com/docview/18...P50$$Gproquest$$Hfree_for_read</linktohtml>
    <linktopdf>$$Uhttps://www.sciencedirect.com/scien...hub$$GElsevier$$Hfree_for_read</linktopdf>

    Link Resolver - Services for Related Records

    Configuring Related Records for Electronic Services

    This section applies only to Primo. For information on how to configure related records in Primo VE, see Configuring Related Record Services for Primo VE

    Related records indicate to the OpenURL link resolver that, when a user receives a certain record in the search results, another record should also be returned as related. Certain MARC fields, called linking entries (such as MARC fields 76X-78X), allow records to link to related bibliographic records and to differentiate their relationships to users. For a full list of MARC fields that are used as linking entries, see Modifying the Display Labels for Related Electronic Services. For additional information regarding physical resources, see Configuring Related Records for Physical Inventory.
    For electronic services, the configuration of related records is useful for the following reasons:
    • Articles sought by users may be available only in related versions of the journal.
    • Metadata in the OpenURL can be for one publication, but in fact, a related journal by another name is what the end user sought.
    • Vendors may list previous or newer versions in their holdings, causing inconsistencies in the Community Zone. For example, the journal Civil Engineering Systems is now named Civil Engineering and Environmental Systems.
    In the following example, View It displays the available services for the discovered record and the related record:
    ViewIt_Img1.png
    Related Records as Shown in View It
    A close relation indicates that the two records should be considered identically useful in the search results. If the record requested in the OpenURL has close relations (MARC 773 and 774) with another record, electronic services for the related record are included in View It, with no indication that these services are for the related record. To the user, it seems as if these services are for the record sent in the OpenURL. Since the relation type is very close, it can be considered equivalent; and as far as the user is concerned, no distinction needs to be made. Other types of relations are considered remote and are listed under the Services for Related Titles section in View It.

    To configure close relations to appear in the same section as the related titles in View It, see the Display closely related record services option in Enabling the Display of Related Records in Primo.

     If there is a filter in 773$g and the corresponding item field is empty, the item fulfills the filter condition.

    Modifying the Display Labels for Related Electronic Services

    The Discovery Interface Labels code table (Configuration > Fulfillment > Discovery Interface Display Logic > Labels) enables you to customize and translate the following labels in View It:
    • Title – The label that displays above the list of related records in View It:
    • Relationship – The label that appears for each related entry in View It and Get It. To modify a label, see the relevant relationship in the table below.
    ViewIt_Img2.png
    Related Records as Shown in View It
    For the example above, you can customize the labels for the title and relationship by modifying the Description field for the following codes in the Discovery Interface Labels code table:
    Discovery Interface Labels Code Table
    Code Description
    c.uresolver.ServicesForRelatedTitles Services for Related Titles
    c.uresolver.viewit.related_type_list.PRECEDES Precedes

    The following table presents the correlation between the MARC fields defined in the bibliographic record and the out-of-the-box labels that appear for each type of relation in View It. For information on modifying labels, see Configuring Service Labels in the Discovery Interface.

    The labels and information that appear in the Primo's Details section is determined by the normalization rules that are defined in Primo.

    Related Record Types
    Relation/Type MARC Field UNIMARC Field Location in Primo
    Main series entry (remote) 760 410 View It: c.uresolver.viewit.related_type_list.MAIN_SERIES = Main Series
    Indicators 0#  
    $w, $x $1 and starts with 001
    Subseries entry (remote) 762 411 View It: c.uresolver.viewit.related_type_list.SUBSERIES = Subseries
    Indicators 0#  
    $w, $x $1 and starts with 001
    Original language entry (remote) 765 454 View It: c.uresolver.viewit.related_type_list.ORIGINAL_LANGUAGE = Original Language
    Indicators 0#  
    $w, $x, $z $1 and starts with 001
    Translation entry (remote) 767 453 View It: c.uresolver.viewit.related_type_list.TRANSLATION = Translation
    Indicators 0#  
    $w, $x, $z $1 and starts with 001
    Supplement entry (remote) 770 421 View It: c.uresolver.viewit.related_type_list.SUPPLEMENT = Supplement
    Indicators 0#  
    $w, $x, $z $1 and starts with 001
    Supplement parent entry (remote) 772 422 View It: c.uresolver.viewit.related_type_list.SUPPLEMENT_PARENT = Supplement Parent
    Indicators 00  
    $w, $x, $z $1 and starts with 001
    Host item entry (close) 773 461

    View It and Get It: c.uresolver.viewit.related_type_list.PART_OF = Part Of

    Details: Display/Is Part Of (defined in Primo normalization rules

    For Primo VE, Get It does not display the type of relation after the title, and closely related items will always appear under the Locations for Related Titles section.

    Indicators 0#  
    $w, $x, $z $1 and starts with 001
    Constituent unit entry (close) 774 462-464

    View It and Get It: c.uresolver.viewit.related_type_list.CONTAINS = Contains

    For Primo VE, Get It does not display the type of relation after the title, and closely related items will always appear under the Locations for Related Titles section.

    Indicators 0#  
    $w 462 $1 and starts with 001
    463 $1 and starts with 001 
    464 $1 and starts with 001
    $x  
    $z  
    Other edition entry (remote) 775 451 View It: c.uresolver.viewit.related_type_list.OTHER_EDITION = Other Edition
    Indicators 0#  
    $w, $x, $z $1 and starts with 001
    Additional physical form entry (remote) 776 452 View It: c.uresolver.viewit.related_type_list.ADDITIONAL_FORM = Additional form
    Indicators 0#  
    $w, $x, $z $1 and starts with 001
    Issued with entry (remote) 777 423 View It: c.uresolver.viewit.related_type_list.ISSUED_WITH = Issued With
    Indicators 0#  
    $x $1 and starts with 001
    $w  
    Preceding entry (remote) 780 430
    431 
    432 
    433 
    434 
    435 
    436 
    437
    View It: c.uresolver.viewit.related_type_list.PRECEDES = Precedes

    Details: Display/Relation – Related Titles: Earlier Title (defined in Primo normalization rules)

    Indicators 00, 01, 02, 03, 04, 05, 06, 07  
    $w, $x, $z $1 and starts with 001
    Succeeding entry (remote) 785 440 
    441 
    442 
    443 
    444 
    445 
    446 
    447
    View It: c.uresolver.viewit.related_type_list.SUCCEEDS = Succeeds

    Details: Display/Relation – Related Titles : Later Title (defined in Primo normalization rules)

    Indicators 00, 01, 02, 03, 04, 05, 06, 07, 08  
    $w, $x, $z $1 and starts with 001
    Data source entry 786

    $w, $x, $z

      View It: c.uresolver.viewit.related_type_list.CONTAINS = Contains
    Other relationship entry (remote) 787 412
    413
    424
    425
    455
    456
    470
    481
    482
    488
    View It: c.uresolver.viewit.related_type_list.OTHER_RELATIONSHIP = Other Relationship
    Indicators 0#  
    $w, $x, $z $1 and starts with 001
    Series added entry-personal name 800

    $w, $x

      View It: c.uresolver.viewit.related_type_list.CONTAINS = Contains
    Details: Display/Relation – Series: (defined in Primo normalization rules)
    Series added entry-corporate name 810

    $w, $x

      View It: c.uresolver.viewit.related_type_list.CONTAINS = Contains
    Details: Display/Relation – Series: (defined in Primo normalization rules)
    Series added entry-meeting name 811

    $w, $x

      View It: c.uresolver.viewit.related_type_list.CONTAINS = Contains
    Details: Display/Relation – Series: (defined in Primo normalization rules)
    Series added entry-uniform title 830

    $w, $x

      View It: c.uresolver.viewit.related_type_list.CONTAINS = Contains
    Details: Display/Relation – Series: (defined in Primo normalization rules)
    Valid ISBN, ISSN, or other standard number (remote) 020 $a, $e 010 $a View It: c.uresolver.viewit.related_type_list.REPLACED_BY = Replaced By
    022 $a, $e 011 $a
    024 $a 013 $a, 014 $a, 015 $a, 016 $a, 017 $a, 072 $a, 073 $a
    Cancelled/invalid ISBN, ISSN, or other standard number (remote) 020 $z 010 $z View It: c.uresolver.viewit.related_type_list.REPLACES = Replaces
    022 $y, $z 011 $g, 011 $y, 011 $z
    024 $z 013 $z, 014 $z, 015 $z, 01 $z, 017 $z, 072 $z, 073 $z
    Linking ISSN (remote) 022 $l 011 $f View It: c.uresolver.viewit.related_type_list.LINKS_TO = Links To
    For more information about configuring related records, see Configuring Related Records for Electronic Services.

    Enabling the Display of Related Records in Primo

    To configure related records, you must have one of the following roles:
    • General System Administrator
    • Fulfillment Administrator
    The Related Record Services Configuration page enables you to configure the electronic services and physical inventory for related titles that appear in View It and Get It for Primo/Primo VE.
    To enable related record services:
    1. Open the Related Record Services Configuration page (Configuration Menu > Fulfillment > Discovery Interface Display Logic > Related Records).

      Related_Record_Services_Configuration_04.png
      Related Record Services Configuration Page
    2. For electronic inventory, refer to the following table to configure how related records display in View It. For more information, see Configuring Related Records for Electronic Services and Modifying the Display Labels for Related Electronic Services.

      Related Record Services Configuration Options – View It Section
      Parameter Description

      Enable related record services

      Select Yes if you want to display a record's related titles in View It. If enabled, the remaining fields allow you to restrict or modify the display of related titles for specific types of records.

      Display related services if full text is available

      Display services for related records if full text is available. Services for related records are not shown if there is a full-text service for the original record in the OpenURL.

      Display related services for serials

      Display related services for serials (which have a Journal material type).

      Display related services for monographs

      Include related services for monographs (which have a Book material type).

      Deduplicate electronic collection services

      Use deduplication of electronic collection services for remote related services. This causes Primo to display only one service if related records are associated with the same electronic collection.

      Enable direct link for related services

      Turn on the direct-linking feature.

      Disable Related Record Services for Digital

      Disable the display of related records for digital records.

      Display closely related record services

      How closely related services (defined with MARC 773 or 774 fields in the bibliographic record) should appear in View It:

      • As part of the original services – Closely related services are placed in the list of regular services in View It with no indication that these services are for related titles.

      • Separately from the original record services – Closely related services are placed under the Services for Related Titles section in View It.

    3. For physical inventory, refer to the following table to configure how related records display in Get It. For additional information, see Configuring Related Records for Physical Inventory.

      Related Record Services Configuration Options – Get It Section
      Parameter Description

      Enable related record services

      Select Yes if you want to display a record's related titles in Get It. If enabled, the remaining fields allow you to restrict or modify the display of related titles for specific types of records.

      Display related holdings for serials

      Select this option to display the related holdings records for serials.

      Display related holdings for monographs

      Select this option to display the related holdings records for monographs.

      Note that for monographs, related inventory appearing in Get It is considered when fulfilling title-level requests placed by the patron. If you disable the display of related records for monographs, the related records’ inventory that isn’t displayed is not considered when fulfilling title-level requests.

      Display closely related records holdings

      Select one of the following options to indicate how you want the closely related records (which are defined with MARC 773 or 774 fields in the bibliographic record) to appear in Get It:

      • As part of the original holdings – Closely related records are placed in the list with the original holdings in Get It with an indication that these are related holdings, including title and relation type.

      • Separately from the original record holdings – Closely related records are placed under the Locations for Related Titles section in Get It. See c.uresolver.getit2.display_related_holding_separately_from_original_record in the table above for more information.

      For Primo VE, related records are displayed separately, regardless of this setting.

    4. Select Save.