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

    SRU/SRW Search

    Translatable
    To enable SRU/SRW searches, you must have the following role:
    • General System Administrator
    Alma enables you to open your institution to SRU/SRW (search retrieval via URL/Web service, an XML based protocol) searches for the purpose of integration with external systems that want to search the Alma repository. To activate this capability, each institution must define and activate its own SRU Server integration profile and also indicate whether to return availability information in the response to SRU queries.
    When doing an external search using SRU (Search/Retrieve via URL) and retrieving 10,000 or more records, Alma responds with an error message when it retrieves the next bulk of records exceeding the 10,000 limit. SRU integration is intended for integrating Alma search with other automated systems for the purposes of interlibrary loan, copy catalog, or selection. Using SRU integration for other workflows, such as performing bulk exports of records, is not supported.
    For details on performing SRU requests, see the following page in the Alma Developer Network: https://developers.exlibrisgroup.com/alma/integrations/SRU.

    Configuring an SRU Server Type Integration Profile

    For each institution, there can be only one SRU Server integration profile.

    To configure the SRU Server integration profile for your institution:
    1. On the Integration Profile List page (Configuration Menu > General > External Systems > Integration Profiles), select Add Integration Profile. Page 1 of the External System wizard opens.
    2. Enter a unique code for the new integration type.
    3. Enter a unique name for the new integration type.
    4. Select SRU Server for Integration Type.
      The Default check box is not functional for this integration type.
    5. Select Next.
    6. Confiigure the SRU integration profile using the parameter explanations in the table below.
      SRU Integration Profile Settings
      Parameter Description
      Bibliographic Options
      Active Select this parameter to enable the bibliographic options.
      Add Availability Whether to include the availability information—which is stored in the AVA (physical availability), AVE (electronic availability), and and AVD (digital availability) fields—in responses to SRU query requests. For more information, see The Retrieve Bib API.

      Enrich with Members Availability (for the Network Zone)

      Whether to retrieve holdings availability for each member of the network when the network institution uses the SRU protocol to complete a search.

      • Dublin Core (simple and qualified) format and all MARC schemas (including UNIMARC and CNMARC) are supported for SRU/SRW. The following crosswalk are supported:
        • From Dublin Core and MARCXML to every other format (Dublin Core, MARCXML, CNMARCXML, KORMARCXML, and UNIMARCXML)
        • From every format (Dublin Core, MARCXML, CNMARCXML, KORMARCXML, and UNIMARCXML) to Dublin Core and MARCXML.
          Crosswalks between CNMARCXML, KORMARCXML, and UNIMARCXML are not supported.
          When the conversion from the original record's format to the requested format is unavailable, Alma returns the original record. For more information, see the Developer Network.
      • For Dublin Core records with representations, the DC identifier field is added with a URL for each representation.

      For MARCXML, the holdings availability indication is handled using the following MARCXML format:

      • MARC 852 field
      • $a Location – Institution code
      • $6 Linkage – MMS ID
      • $9 Local field – P (print) / E (electronic) / D (digital)

      When more than one material type is available for one institution such as print and electronic, the 852 field contains multiple $9 entries.

      Add Representation Information Whether to have non-remote representation information exposed to the external system.
      Add Remote Representation Information Whether to have remote representation information exposed to the external system.

      Apply Normalization

      Select this parameter to normalize Alma bibliographic records prior to any additional enrichment and being presented to an external system as a result of a Z39.50 request. Normalization can be applied to MARC 21, KORMARC, UNIMARC, CNMARC, and Dublin Core bibliographic records using the following normalization processes provided out of the box or by customizing these processes with normalization rules that you create: Marc21 Bib normalize on external search, KORMARC Bib normalize on external search, UNIMARC Bib normalize on external search, CNMARC normalize on external search, and Qualified Dublin Core Bib normalize on SRU search.

      Example_Normalization_Rule_from_the_CNMARC_Bibliographic_Metadata_Configuration_Profile_04_TC.png

      Example Normalization Rule from the CNMARC Bibliographic Metadata Configuration Profile

      The normalization rules that are provided remove the following information from the bibliographic record: 590 local note (MARC 21), 590 local note (KORMARC), 900 local field (UNIMARC), and 300 general note (CNMARC). See Working with Normalization Rules for more information.

      Since the enrichment process is performed after the normalization process has completed, the normalization process will not affect fields added by enrichment.

      These normalization rules use the following drools files (specified on the Task Parameters tab): drools/remove590.dslr, drools/remove900.dslr, and drools/remove300.dslr.

      Example_Drools_File_from_the_Cnmarc_Bib_normalize_on_Z39.50_SRU_search_Normalization_Rule_04_TC.png

      Example Drools File from the Cnmarc Bib normalize on Z39.50/SRU search Normalization Rule

      For more information, see Working with Normalization Processes.

      Holdings Options (ISO 20775)
      Your ISIL code needs to be configured to work with the Holdings Options for SRU responses. See ISIL Code for configuration information.
      There is a known issue with portfolios activated from the community zone. These are sometimes considered as non-serial; and therefore, the SRU response does not include their coverage and other related information.
      Active
      Select this parameter to enable the SRU ISO 20775 holdings schema. The Availability Calculation Options appear. Select one or more of the following Availability Calculation Options if you want them excluded from the availability calculations:
      • Exclude Items Not On Shelf
      • Exclude Items Not Requestable For Resource Sharing
      • Exclude Electronics and Digital Resources
      Availability_Calculation_Options_06_TC.png
      Availability Calculation Options
      With holdings SRU, you get more inventory detail on your queries. See an example of query results below.
      Example_Query_Results_02.png
      Example Query Results
      Availability Calculation Options
      Select one or more of the options below to identify what should be presented in the search results as available inventory. The search results will show the number of items (copies count) and a calculated availability count determined by the options you select for this parameter (see the illustration below). If none of the following options are selected, the query results will indicate that all items are available all of the time.
      • Exclude Items Not On Shelf – Select this option to have the query result consider only the inventory that is on the shelf as available.
      • Exclude Items Not Requestable For Resource Sharing – Select this option to have the query result consider only the inventory that is requestable for resource sharing as available.
      • Exclude Electronics and Digital Resources (For Future Use) – This feature will be implemented in a later release.
      SRU_Copy_Information_02.png
      SRU Copy Information
    7. Select Save.
      After you have saved the SRU Server integration profile, the following row actions are available for this profile:
      • Edit
      • Manage in Network – This action is only available in the Network Zone. Select this action to distribute this configuration to member institutions using the Distribute network administration changes to members job. See Centrally Managing Configurations in a Network Zone and Distribute Network Administration Changes to Members for more information.
      • Stop Network Management – This action is only available in the Network Zone. Select this action to disable distribution of this configuration to member institutions when using the Distribute network administration changes to members job. See Centrally Managing Configurations in a Network Zone and Distribute Network Administration Changes to Members for more information.
      • Unlink from Network – This action is only available for member institutions. When the SRU Server integration profile is distributed to a member institution (that is, the integration profile is linked to the Network), the member institution may select the Unlink from Network action to disconnect from the Network Zone version of the integration profile and modify it for local use.
      • Job History
      • Delete
    .
    • Was this article helpful?