Skip to main content
  • Subscribe by RSS
  • ExLibris Dev

    Adding a General Electronic Service

    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, Ask a Librarian, and so forth) to present to patrons in the Primo View It and Get It tabs.
    Electronic Service Example (View It Display)
    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 the View It and/or Get It tabs.
    In addition, you can configure the following display settings for general electronic services:
    To configure general electronic services in Alma:
    1. On the General Electronic Services page (Fulfillment > Fulfillment Configuration > Configuration Menu > Discovery Interface Display Logic > General Electronic Services), click Add Service. The Add Service dialog box appears.
      Add Service Dialog Box
    2. Enter the following service information:
      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:{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:{rft.oclcnum}
      ILLiad - Books/Book Items (based on your institution’s base URL). For example:{rft.genre}&rft.title={rft.btitle}&rft.stitle={rft.stitle}&rft.atitle={rft.atitle}&{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.aulast},{rft.aufirst}&rft.auinit={rft.auinit}&{}&rft.publisher={rft.publisher}&{}&rft.doi={rft.doi}&rfe_dat={rft.oclcnum}&rfr_id={rfr_id}
      ILLiad - Articles/Journals (based on your institution’s base URL). For example:{rft.genre}&rft.title={rft.title}&rft.stitle={rft.stitle}&rft.atitle={rft.atitle}&rft.jtitle={rft.jtitle}&{}&{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.pubdate={rft.pubdate}&rft.pubyear={rft.pubyear}&rft.publisher={rft.publisher}&{}&rft.doi={rft.doi}&rfe_dat={rft.oclcnum}&rfr_id={rfr_id}
      ProQuest - Dissertation Service.  For example:{rft.btitle}&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adissertation&url_ver=Z39.88-2004&genre=dissertation
      For more information regarding OpenURL, see:
      • 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 the Primo View It and/or Get It tabs.
      • Public Note – The note or description of the service that displays below the link in the Primo View It and/or Get It tabs.
      • Display Location – The Primo tabs in which the link displays: None, Getit, Viewit, or Getit & viewit.
      • The URL Template – The URL where the patron is redirected when the external service link is clicked.
      • Specific vendor web sites for OpenURL details
    3. Click Add and Close.
      The new service appears on the General Electronic Service page with the following action options: Remove and Edit.
      Electronic Service Added
    4. Click Actions > Edit to configure additional service details.
      The Service Details page appears.
      Service Details Page (Service Details Tab)
    5. To display this service to signed-in users only, select No in the Enable without login field.
    6. To display 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.
    7. Click the Service Availability Rules tab.
      The Service Availability Rules tab displays the rules that the system uses to determine whether a service should appear for the user. Each service has a default rule that is applied when none of the other rules apply. By default, the system does not display the service (IsDisplay=False). Click Edit to modify the default rule for the service.
      Service Availability Rules Tab
    8. 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 or
      For example, to add a rule to the Amazon service to indicate that an ISBN must be returned in the OpenURL context object in order to display the service in the Primo View It and/or Get It tabs:
      1. Click Add Rule. The Edit Rule page opens.
        Edit Rule Page
      2. In the Edit Rule section, enter the rule name (required) and description (optional).
      3. In the Input Parameters section, 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 or the OpenURL Standard (versions 0.1 and 1.0; see also the list of Metadata Formats).
          In the example, the rft.isbn attribute was selected.
        • Operator – The comparison operator to use with this context object attribute. For the Amazon example, the Is not empty operator has been selected to make sure that the Amazon search contains an ISBN.
        • Possible 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.
      4. Click Add Parameter. The parameter is added to the list.
      5. In the Output Parameters section, set IsDisplay to true.
        The completed input and output parameters appear as in the figure below.
        Amazon Input/Output Parameters Entered
      6. Click Save. The Service Availability Rules page displays the new rule.
    9. Click Save. The General Electronic Services page displays the new service.
    • 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 of values 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.

    Commonly Used OpenURL Attributes for the URL Template

    The OpenURL attributes returned from Alma’s link resolver are grouped by the following general categories:
    OpenURL Attribute Categories
    Category Prefix Description
    Requester req. Information about the requesting entity, that is, the patron.
    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.
    The following are commonly returned attributes that can be used to create service availability rules:
    Commonly Returned OpenURL Attributes from Alma’s Link Resolver
    Attribute PNX Mapping Description
    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 addata/au 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 Book title   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.   Publication country: "United States". See cc.
    rft.coden addata/coden CODEN (alphanumeric code) 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.   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.   Degree issued, for a dissertation
    rft.doi addata/doi DOI (digital object identifier) field
    rft.edition display/edition Book edition, typically a phrase, with or without numbers: "First edition", "4th ed.".
    rft.eisbn addata/eisbn International Standard Book Number for electronic version. May be multiple ISBNs, separated by commas. May contain a hyphen. May or may not be distinct from rft.isbn.
    rft.eissn addata/eissn International Standard Serial Number for electronic version. May be multiple ISSNs, 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
    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 International Standard Book Number. Nine digits plus a check digit. May contain hyphens.
    rft.issn addata/issn 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 Full journal title: "Journal of the American Medical Association". For abbreviated title, use stitle.
    rft.kind   Patent kind code, for a patent: "AU A1". Kind codes are meaningful within the country of origin.
    rft.number   Application number, for a patent
    rft.month   Publication month
    rft.oclcnum addata/oclcid 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". addata/cop Publication place: "New York".
    rft.prioritydate   Priority date, for a patent addata/pub Publisher name: "Harper and Row".
    rft.pubdate   Publication date, for a patent
    rft.publisher   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 Abbreviated journal title: "J Am Med Assn". For full title, use jtitle.
    rft.title   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   Holdings information
    svc.ill   Interlibrary loan
    // feedback widged