Skip to main content
ExLibris
  • Subscribe by RSS
  • ExLibris Dev

    Setting Up OAI Integration

    Translatable
    The Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH) is a low-barrier mechanism for developing and promoting interoperability standards that aim to facilitate the efficient dissemination of content across repositories. Data Providers are repositories that expose structured metadata through OAI-PMH. Service Providers then make OAI-PMH service requests to harvest that metadata. OAI-PMH uses six request types (“verbs”) that are invoked within HTTP. Using this functionality, Alma can publish metadata (as a Data Provider) which can then be harvested by external tools/repositories (Data Harvesters).
    Configuring the OAI integration is the first step toward publishing through OAI. Once you have finished this task, you can set up a publishing profile through Resource Management configuration. When that is complete, your OAI setup should be complete and your database ready to load.
    This section shows you how to configure OAI as an integration point for Alma. This allows Alma to expose the records as OAI types and harvest them accordingly. For information on setting up a publishing OAI profile, see Publishing and Inventory Enrichment.
    If your institution already has an OAI integration profile, you cannot add a second one (though you can edit the existing one).
    To set up an OAI integration profile:
    1. Open the Integration Profile List page (Administration > General Configuration > Configuration Menu > External Systems > Integration Profiles) and click Add Integration Profile.
      The first step of the two-step integration wizard appears.
      External Integration Profile Wizard, Step 1a
    2. From the Integration Type drop-down menu, select OAI Repository Definition.
      The Default check box is not functional for this integration type.
    3. The page refreshes with relevant fields for the profile.
      Refreshed Page One of the Integration Profile for OAI
    4. Enter an optional Description of the integration profile.
    5. Click Next.
      Step 2 of the integration profile wizard appears.
      If you have already entered an OAI integration profile in the system, you will be returned to this External System page with the values entered from your first OAI integration profile. You will then be prompted to enter the profile in edit mode, which is the only way you can update the profile if one has already been created.
      Integration Profile Wizard Page 2 (Parameters)
    6. Enter OAI Repository Definitions as required:
      • Active/ Non Active (required) - In order to be used, the repository must be set to Active. Leave it as the default value, Non Active, to save your settings without activating the repository.
      • Repository Name - The repository when calling the OAI API.
      • Repository Base URL - The fixed, auto-generated base URL for all OAI links, not editable.
      • Admin Email - The email address where you want communications related to the integration profile to be sent.
      • Earliest Datestamp - The first date stamp of the repository records (which can be used, for example, when querying the repository by date).
      • Metadata Prefixes - Currently, only Marc21 is supported.
        Configuring Metadata Prefixes
      • Allowed IPs - IP information for users/locations who can access the repository, . For more information, see Mapping Tables. Click Customize when you have finished adding rows. For an IP range, use a hyphen with no spaces (-) between strings. (Syntax corrections will be noted in error messages.)
        Creating Mapping Rows for IP Addresses with Access
      • Enter information for Repository Identifier. To be compliant with OAI-PMH requirements, the value should contain two strings with no special characters, separated by a period (for example, 01BC.INST).
    7. Click Save to complete the profile.
      The Integration Profile List page appears with the new OAI definition listed.
      Integration Profile List Page with OAI Integration Profile Added
    Because Alma allows for only one OAI setting, if you want to change anything in the integration profile, you must select Edit from the Actions menu and edit the existing profile.
    • Was this article helpful?