Versions Compared

Old Version 5

changes.mady.by.user Hardy Pottinger

Saved on

compared with

New Version 6

changes.mady.by.user Anne Lawrence

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update links to documentation

...

OAI 2.0 is a Java implementation of an OAI-PMH data provider interface developed by Lyncode that uses XOAI, an OAI-PMH Java Library, http://www.lyncode.com/dspace/addons/xoai/doc/XOAI_en.pdf.

Why OAI 2.0?

Projects like OpenAIRE, and Driver have specific metadata requirements (to the published content through the OAI-PMH interface). As the OAI-PMH protocol doesn't establish any frame to these specifics, OAI 2.0 can, in a simple way, have more than one instance of an OAI interface (feature provided by the XOAI core library) so one could define an interface for each project. That is the main purpose, although, OAI 2.0 allows much more than that.

...

Configuration

Basic Configuration

Configuration File:

[dspace]/config/modules/oai.cfg

Property:

storage

Example Value:

storage = solr

Information Note:

This allows to choose the OAI data source between solr and database

Property:

solr.url

Example Value:

solr.url = ${default.solr.server}/oai

Informational Note:

Solr Server location

Property:

identifier.prefix

Example Value:

identifier.prefix = ${dspace.hostname}

Informational Note:

OAI persistent identifier prefix. Format - oai:PREFIX:HANDLE

Property:

config.dir

Example Value:

config.dir = ${dspace.dir}/config/crosswalks/oai

Informational Note:

Configuration directory, used by XOAI (core library). Contains xoai.xml, metadata format XSLTs and transformer XSLTs.

Property:

cache.dir

Example Value:

cache.dir = ${dspace.dir}/var/oai

Informational Note:

Directory to store runtime generated files (for caching purposes).

Advanced Configuration

OAI 2.0 allows you to configure following advanced options:

...

Code Block
<Format id="[IDENTIFIER]">
  <Prefix>[PREFIX]</Prefix>
  <XSLT>metadataFormats/[XSLT]</XSLT>
  <Namespace>[NAMESPACE]</Namespace>
  <SchemaLocation>[SCHEMA_LOCATION]</SchemaLocation>
</Format>

where:

Parameter

Description

IDENTIFIER

The identifier used within context configurations to reference this specific format, must be unique within all Metadata Formats available.

PREFIX

The prefix used in OAI interface (metadataPrefix=PREFIX).

XSLT

The name of the XSLT file within [dspace]/config/crosswalks/oai/metadataFormats directory

NAMESPACE

XML Default Namespace of the created Schema

SCHEMA_LOCATION

URI Location of the XSD of the created Schema

NOTE: Changes in [dspace]/config/crosswalks/oai/xoai.xml requires reloading/restarting the servlet container.

...