CINXE.COM

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html> <head> <title>OAI-PMH Implementation Guidelines</title> <style type="text/css" id="internalStyle">> body { color: black; background: white; } code,pre { font-family: "Courier New", Courier, monospace; font-size: 80%; } em { color: red; } table { background: #CCCCCC; } th { font-weight: bold; font-size: 120%; } table.header { background: white; } td.docsubtitle { font-weight: bold; font-size: 150%; } </style> <meta content="Open Archives Initiative - Protocol for Metadata Harvesting - Implementation Guidelines" name="DC.title"/> <meta content="Lagoze, Carl" name="DC.creator"/> <meta content="Van de Sompel, Herbert" name="DC.creator"/> <meta content="Nelson, Michael" name="DC.creator"/> <meta content="Warner, Simeon" name="DC.creator"/> <meta content="2005/05/03T22:51:00Z" name="DC.date"/></head> <body> <table class="header" summary="Logo and heading" border="0" width="100%"> <tr> <td align="center"> <a href="http://www.openarchives.org"><img alt="OAI logo" src="http://www.openarchives.org/images/OA100.gif" height="70" width="100"/></a> </td> <td align="left" width="87%"> <h2>Implementation Guidelines for the Open Archives Initiative Protocol for Metadata Harvesting</h2> </td> </tr> <tr> <td> </td> <td align="left" width="87%"> <b>Protocol Version 2.0 of 2002-06-14<br /> Document Version 2005/05/03T22:51:00Z<br /> http://www.openarchives.org/OAI/2.0/guidelines.htm</b> </td> </tr> </table> <p><b>Editors</b></p> <p> <a href="mailto:lagoze@cs.cornell.edu">Carl Lagoze</a> (<a href="http://www.openarchives.org/organization/index.html">OAI Executive</a>; <a href="http://www.cs.cornell.edu/">Cornell University - Computer Science</a>) <br /> <a href="mailto:herbertv@lanl.gov">Herbert Van de Sompel</a> (<a href="http://www.openarchives.org/organization/index.html">OAI Executive</a>; <a href="http://lib-www.lanl.gov/">Los Alamos National Laboratory - Research Library</a>) <br /> <a href="mailto:mln@cs.odu.edu">Michael Nelson</a> (<a href="http://www.cs.odu.edu/">Old Dominion University - Computer Science</a>) <br /> <a href="mailto:simeon@cs.cornell.edu">Simeon Warner</a> (<a href="http://www.cs.cornell.edu/">Cornell University - Computer Science</a>) </p> <h1>1. Introduction</h1> <p>These guidelines are a supplement to the <a href="openarchivesprotocol.htm">Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH) Version 2.0</a> and are intended to be read in conjunction with that specification.</p> <p>It is anticipated that the guidelines will be added to or updated while the protocol specification remains unchanged. To facilitate this, the guidelines are separated out into a set of documents for which this document is a table of contents.</p> <h1>2. General Guidelines</h1> <dl> <dt> <b>2.1 <a href="guidelines-repository.htm">Guidelines for Repository Implementers</a></b></dt> <dd> <p>These guidelines describe best practices and discuss implementation issues for repository implementers. Topics include: minimal repository implementation; datestamps and granularity; best practices for the use of <code>resumptionTokens</code>; collection and set descriptions; flow control and load balancing; response compression; and error handling.</p> </dd> <dt> <b>2.2 <a href="guidelines-harvester.htm">Guidelines for Harvester Implementers</a></b></dt> <dd> <p>These guidelines discuss issues relating to implementing and operating harvesting software. Topics include: running harvesting software; datestamps and granularity; sets; flow control, load balancing and redirection; incomplete lists and <code>resumptionToken</code>; and response compression.</p> </dd> <dt> <b>2.3 <a href="guidelines-aggregator.htm">Guidelines for Aggregators, Caches and Proxies</a></b></dt> <dd> <p>These guidelines discuss issues specific to systems that act as both harvesters and repositories. Topics include: identifiers; provenance; and datestamps.</p> </dd> </dl> <h1>3. Guidelines for Optional Containers</h1> <p>There are a number of places in OAI-PMH responses where XML complying with any external schema may be supplied. These containers are provided for extensibility and for community specific enhancements. The following sections list the optional containers and link to existing schemas.</p> <dl> <dt> <b>3.1 Repository-level <code><description></code> container</b></dt> <dd> <p>The response to an <code>Identify</code> request may contain description containers that can be used to express properties of the repository that are not covered by the standard response to the <code>Identify</code> verb. The following guidelines are provided:</p> <p><a href="guidelines-oai-identifier.htm"><code>oai-identifier</code></a>: a specification describing a specific, recommended implementation of <a href="openarchivesprotocol.htm#UniqueIdentifier">unique identifiers</a> which repositories may adhere to;<br /> <a href="guidelines-rights.htm#repository_level"><code>rightsManifest</code></a>: part of the guidelines for conveying rights expressions than can be used to include a manifest of rights statements that apply to metadata from items in the repository;<br /> <a href="guidelines-eprints.htm"><code>eprints</code></a>: a schema that can be used to provide collection-level metadata for eprint repositories;<br /> <a href="guidelines-friends.htm"><code>friends</code></a>: a recommended schema allowing a repository to list confederate repositories as a means to support automatic discovery of repositories by harvesters;<br /> <a href="guidelines-branding.htm"><code>branding</code></a>: a schema for repositories to provide branding information;<br /> <a href="guidelines-gateway.htm"><code>gateway</code></a>: a schema than can be used to describe a gateway which is acting as an OAI-PMH repository.</p> </dd> <dt> <b>3.2 Set-level <code><setDescription></code> container</b></dt> <dd> <p>The response to a <code>ListSets</code> request may contain <code>setDescription</code> containers, which provide an extensible mechanism for communities to describe their sets. Dublin Core metadata may be used for this purpose. A schema for <a href="openarchivesprotocol.htm#dublincore">unqualified Dublin Core</a> is provided in the protocol document. The <a href="guidelines-repository.htm#setDescription">Guidelines for Repository Implementers</a> makes further recommendations about schema that can be used for this purpose. Other schema that may be used at the set level include:</p> <p> <a href="guidelines-rights.htm#set_level"><code>rightsManifest</code></a>: part of the guidelines for conveying rights expressions than can be used to include a manifest of rights statements that apply to metadata from items in the set;<br /> <a href="guidelines-branding.htm"><code>branding</code></a>: a schema for repositories to provide branding information.</p> </dd> <dt> <b>3.3 Record-level <code><metadata></code> container</b></dt> <dd> <p>Dublin Core metadata with <code>metadataPrefix</code> <code>oai_dc</code> is mandatory and is described in the <a href="openarchivesprotocol.htm#dublincore">protocol document</a>. In addition, schema descriptions for the following metadata formats are provided:</p> <p><a href="guidelines-rfc1807.htm"><code>rfc1807</code></a>: a schema for rfc1807 format metadata; <br /> <a href="guidelines-marcxml.htm"><code>marc21</code></a>: a recommended schema for MARC21 metadata, provided by the Library of Congress; <br /> <a href="guidelines-oai_marc.htm"><code>oai_marc</code></a>: a schema for MARC format metadata.</p> </dd> <dt> <b>3.4 Record-level <code><about></code> container</b></dt> <dd> <p>A record may contain <code><about></code> containers that provide information about the <code><metadata></code> part of the record. It is expected that community specific standards may arise in addition to the following specifications:</p> <p><a href="guidelines-provenance.htm"><code>provenance</code></a>: a schema that is recommended for the description of the provenance of metadata that is re-exposed by a repository, i.e. metadata that has previously been harvested before being exposed by the repository;<br /> <a href="guidelines-rights.htm"><code>rights</code></a>: a specification for conveying rights expressions that pertain to the <code><metadata></code> part of the record.</p> </dd> </dl> <h1>4. Static Repositories and Static Repository Gateways</h1> <p>The <a href="guidelines-static-repository.htm">Specification for an OAI Static Repository and an OAI Static Repository Gateway</a> provides a simple approach for exposing relatively static and small collections of metadata records through the OAI-PMH. It is recommended that Static Repository Gateway implementers use the <a href="guidelines-gateway.htm"><code>gateway</code></a> container to include descriptions of the gateway.</p> <h1>5. Community Guidelines</h1> <p>Individual OAI user communities are encouraged to endorse particular formats and schemas, perhaps including some of those listed above, and to define additional standards that meet their own needs. The following community specific guidelines are available:</p> <ul> <li><b><a href="http://www.language-archives.org">Open Language Archives Community</a></b> - a partnership of institutions and individuals who are creating a worldwide virtual library of language resources. Includes a specific metadata format and instructions for data providers.</li> <li><b><a href="http://www.openarchives.org/OAI/2.0/guidelines-eprints.htm">Repository description for the <code>eprints</code> community</a></b> - a schema released with OAI-PMH v2.0 to describe e-print repositories.</li> </ul>  <h2><a name="acknowledgements"></a>Acknowledgements</h2> <p>Support for the development of the OAI-PMH and for other Open Archives Initiative activities comes from the <a href="http://www.diglib.org/">Digital Library Federation</a>, the <a href="http://www.cni.org/">Coalition for Networked Information</a>, and from the National Science Foundation through Grant No. IIS-9817416. Individuals who have played a significant role in the development of OAI-PMH version 2.0 are <a href="http://www.openarchives.org/OAI/2.0/openarchivesprotocol.htm#acknowledgements">acknowledged in the protocol document</a>.</p> <h2><a name="DocumentHistory">Document History</a></h2> <p><b>2005-05-03</b>: Added guidelines for conveying rights expressions about metadata.<br /> <b>2003-10-10</b>: Added Static Repository Gateway and Gateway Description guidelines.<br /> <b>2002-05-08</b>: Added <code>branding</code>, wording changes.<br /> <b>2002-03-31</b>: Release of initial version of OAI-PMH v2.0 guidelines documents.</p>  <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.0/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.gif" /></a><br /> This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.0/">Creative Commons License</a>.   </body> </html>