OAI documentation

189 views
Skip to first unread message

Agustín Alfieri

unread,
May 26, 2022, 10:31:30 AM5/26/22
to DSpace Technical Support
Hi, 

I'm trying to implement a new context in OAI to meet some national requirements and i'm a bit lost. Where can i search for documentation (specifically for setting up the transformer and metadata format) besides of https://wiki.lyrasis.org/display/DSDOC6x/OAI+2.0+Server#OAI2.0Server-WhatisOAI2.0? ?
I'm currently using Dspace 6.3

Agustin.

Tim Donohue

unread,
May 26, 2022, 3:02:27 PM5/26/22
to DSpace Technical Support
Hi Agustin,

Creating custom contexts in OAI is not well documented as it's honestly not something done frequently.  If you want examples, I'd suggest looking at how it was done when the OpenAIRE v4 context was added in https://github.com/DSpace/DSpace/pull/2592

Beyond that, the basic idea would be to:
1. Add a new context to xoai.xml: https://github.com/DSpace/DSpace/blob/main/dspace/config/crosswalks/oai/xoai.xml   This creates the context and links it up with the corresponding Transformer, Format(s) and Filters also defined in that same file.
2. You'll need to create a Transform XSLT in the transformers folder: https://github.com/DSpace/DSpace/tree/main/dspace/config/crosswalks/oai/transformers
3. You can either choose to use an existing metadataFormat or define a new one in the "metadataFormats" directory: https://github.com/DSpace/DSpace/tree/main/dspace/config/crosswalks/oai/metadataFormats

If you end up having more specific questions let us know.  If you are interested, we'd also welcome help in enhancing our documentation to provide step-by-step instructions for how to make this sort of change. If you would like to help with documentation, let me know & we can get you setup with a Wiki account and proper permissions to make edits.

Tim

Agustín Alfieri

unread,
May 31, 2022, 10:08:05 AM5/31/22
to DSpace Technical Support
Hi Tim,

Thanks for the help. I've been able to set up a test version of the new context i need with it's  correspondent  transformer and metadataFormat and so far it's working. The context appears in the OAI interface and if I go to "Metadata Formats" an then to "List Records" within my context I can see the my records just fine. 
However if i select either the "Records" or the "Identifiers" tabs directly it gives me this error: "Unknown metadata format".

I'm going to continue working on this but I'm asking to see if it has an easy fix that I'm not seeing.

Agustin.

Agustín Alfieri

unread,
May 31, 2022, 11:56:47 AM5/31/22
to DSpace Technical Support
Small clarification:

The issue is that when clicking on "records" the following link is used "http://localhost:8080/oai/snrd?verb=ListRecords&metadataPrefix=oai_dc" when it should be "http://localhost:8080/oai/snrd?verb=ListRecords&metadataPrefix=snrd_oai_dc
snrd_oai_dc.xsl is my metadataFormat wich is based on oai_dc.xsl.
oai_dc is not used within this context.
Reply all
Reply to author
Forward
0 new messages