OAI Service

This page covers the functionality of the edu-sharing oai service.

OAI (Open Archives Initiative) is a standard for discovering and exchanging documents and metadata.
Edu-Sharing provides support for oai_lom-de based metadata discovery.

Installation

As soon as you've fully set up your repository and edu-sharing, the oai service is already available.

If you want to have public access to the oai service, make sure to configure a guest user.

Access it via:

CODE

<edu-sharing-base-url>/edu-sharing/eduservlet/oai/

For instance, if you want to list available identifiers, use:

CODE

<edu-sharing-base-url>/edu-sharing/eduservlet/oai/provider?verb=ListIdentifiers&metadataPrefix=lom

And if you want to get metadata for a particular item, use:

CODE

<edu-sharing-base-url>/edu-sharing/eduservlet/oai/provider?verb=GetRecord&metadataPrefix=lom&identifier=<node-id>

Configuration

The embedded OAI service is a pretty standard and minimal implementation.
If you feel that it does not fit your needs, we recommend taking a look at jOAI, which is a dedicated web app for serving data via OAI.

You can change the default query of the items listed and exported by the OAI service via the metadataset. The query id is "oai".

By default, the query will show all items that are visible to the current user (or the guest if it is active).

If you want to modify this query, follow the guide for the metadataset configuration.

Also, the following default parameters apply and can not be changed at the moment:

The items per page are set to 300
The result is ordered by creation date ascending
Only files are reported
No individual sets are supported. If you need to set a set in the requesting software, use "default" as the set name