Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

OAI-PMH feeds typically consist of a large amount of data. For most queries, you will likely need to use the resumption tokens to get the entire data set. One can use the Resume link or copy and paste the resumptionToken string into the query to continue pulling results.

Challenges

The out of the box OAI service defaults to Dublin Core. Additional metadata fields will not show up in the Blacklight feed unless custom development work is done. In Hyku, the oai_hyku prefix has been added by SoftServ, and the process for adding additional customized metadata fields is simplified in the code. Documentation for how to map to schemas other than DC is lacking.

When using the oai_dc feed, thumbnails are not included. Development work is needed to pull thumbnails into the feed. In terms of Hyrax, Lafayette College and The Ohio State University Libraries provide the thumbnail link in the dc:identifier field as [repository url/]downloads/[file id]?file=thumbnail . This is provided by pulling the thumbnail_path_ss from SOLR.

Example: https://library.osu.edu/dc/downloads/7h149s49p?file=thumbnail 

In Hyku, Hyku for Consortia/Hyku Commons provides the thumbnail link in its custom oai_hyku format in the thumbnail_url field.

Example: https://au-archives.hykucommons.org/downloads/5d20d75f-0744-4f81-bcb0-998b1ff08e70?file=thumbnail

Some version upgrades are not backwards compatible with existing OAI-PMH code. For example, code written for Hyrax version 2 is incompatible with Hyrax version 3.

Examples in the Samvera community

Oregon Digital:

https://github.com/OregonDigital/oregondigital/wiki/OAI-Documentation  

Base URL: http://oregondigital.org/catalog/oai?verb=Identify

Note: The GitHub documentation is out-of-date but provides other useful insights.

Hyku Commons (Hyku):

Accessing the hyku OAI feed

Base URL: https://TENANT.hykucommons.org/catalog/oai?verb=Identify

Example: https://au-archives.hykucommons.org/catalog/oai?verb=Identify

Shared Research Repository (Hyku)

Base URL: https://iro.bl.uk/catalog/oai?verb=Identify

Carleton University (Hyrax)

Base URL: https://repository.library.carleton.ca/catalog/oai?verb=Identify

Duke University (Hyrax)

Base URL: https://research.repository.duke.edu/catalog/oai?verb=Identify

Lafayette College (Hyrax)

Base URL: https://ldr.lafayette.edu/catalog/oai?verb=Identify

National Institute for Materials Science (Hyrax)

Base URL:https://mdr.nims.go.jp/catalog/oai?verb=Identify

The Ohio State University Libraries (Hyrax)

Base URL: https://library.osu.edu/dc/api/oai?verb=Identify

Note: This repository uses api rather than catalog in the repository’s URL.

Northwestern University Libraries (custom application):

Base URL:https://api.dc.library.northwestern.edu/api/v2/oai?verb=Identify

Note: implemented as an AWS Lambda using the node runtime as a part of our public digital collections API https://github.com/nulib/dc-api-v2/blob/main/src/handlers/oai.js

University of North Carolina at Chapel Hill (Hyrax)

Base URL: https://cdr.lib.unc.edu/catalog/oai?verb=Identify