OAI-PMH

From ICA-AtoM

Main Page > User manual > Import/export > OAI-PMH

ICA-AtoM can expose metadata using the Open Archives Initiative Protocol for Metadata Harvesting, version 2. Currently, metadata is only available as unqualified Dublin Core, although future versions of ICA-AtoM will likely expose OAI harvestable metadata in other metadata formats.

Enabling support [edit]

To enable ICA-AtoM as an OAI data provider, log in as an administrator and go to Admin > Settings > OAI Harvesting.

• Check "yes" under "Enable OAI"
• In the "OAI repository code" field, add a string that uniquely identifies your instance of ICA-AtoM.

Base URL [edit]

To have your metadata harvested, you must provide harvesters with your OAI base URL, which follows this pattern: http://example.com/.../index.php/oai/oai

- where "http://example.com/.../" is the URL of your instance of ICA-AtoM.

Example requests [edit]

You will not usually need to supply any URLs to harvesters other than your base URL, but the following illustrate the URLs for some standard OAI-PMH requests:

• http://example.com/.../;oai?verb=Identify
• http://example.com/.../;oai?verb=ListSets
• http://example.com/.../;oai?verb=ListRecords&metadataPrefix=oai_dc

Sets [edit]

ICA-AtoM supports OAI-PMH Sets, and defines the very top level in any descriptive hierarchy as a set (usually the fonds but could also be a collection or series depending on your own descriptive practices).

Harvesting metadata [edit]

Currently, ICA-AtoM can only act as an OAI-PMH data provider. However, support for using it to harvest and import metadata using OAI-PMH is under active development.