Direkt zum Hauptinhalt

OAI-PMH-Schnittstelle

Für die Konfiguration Ihrer OAI-PMH-Schnittstelle finden Sie als Partnerinstitution hier eine Übersicht zu den wichtigsten Fragen.

Welche Metadaten sollen übermittelt werden?

Legen Sie zuerst fest, welche Metadaten für das Harvesting über OAI-PMH zur Verfügung gestellt werden sollen. Dies kann beschreibende Metadaten wie den Titel und das Leitthema sowie technische Metadaten wie das Medienformat und die Mediennutzungsrechte beinhalten. Dabei sollen zumindest die Mindestanforderungsfelder, besser aber noch mehr Metadaten (z. B. über Ort, Zeit, Handlungsträger, Konzepte …) übermittelt werden, um das Objekt bestmöglich zu kontextualisieren und es für verschiedene Benutzerszenarien vorzubereiten.

Welches Sammlungsmanagementsystem soll ich auswählen?

Ein Sammlungsmanagementsystem (auch: Sammlungsverwaltungssystem, Collection Management Software) erlaubt es, die Daten zu den Objekten in der Institution zu organisieren, zu kontrollieren und zu verwalten. Es gibt viele verschiedene Systeme, die den OAI-PMH-Standard unterstützen. Dabei ist es wichtig, eine Software zu finden, die sowohl mit den bereits bestehenden Systemen in der Institution kompatibel ist, als auch die gewünschten Metadaten übermitteln kann.

Wie konfiguriere ich die Software?

Die Software (das Sammlungsmanagementsystem) muss so konfiguriert werden, dass die gewünschten Metadaten über die OAI-PMH-Schnittstelle abgefragt werden können. Dies kann die Konfiguration der Software für die Verwendung bestimmter Metadaten-Schemata, die Einrichtung von Zugriffskontrollen und die Konfiguration der Servereinstellungen umfassen.

Als Hilfestellung zur Implementierung bietet die Open Archives Initiative Links zu verschiedenen Programmen an, die von Mitgliedern der Community erstellt wurden.

Was soll die OAI-PMH-Schnittstelle alles können?

Das OAI-PMH-Protokoll enthält sechs Basisfunktionen: Identify, ListMetadataFormats, ListSets, ListIdentifiers, ListRecords, und GetRecord. Diese Befehle werden mit „?verb=“ an die URL zum Repositorium der Institution (baseURL) angehängt.

Ein Beispiel für eine vollständige URL: https://meine-sammlung.tld/oaipmh/?verb=ListRecords&metadataPrefix=edm&set=kulturpool

Identify zeigt die allgemeinen Informationen zum OAI-Repositorium an. Das sind etwa der Name des Repositoriums, der baseURL und die Version des Protokolls.

ListMetadataFormats listet die Metadatenformate, die vom Archiv für den Export unterstützt werden.

ListSets gibt hierarchische Informationen zu der Sammlung, in der alle Kataloge (Datensets) organisiert wurden.

ListIdentifiers liefert den Header (Dateikopf) aller Datensätze, die mit den angegebenen Parametern (siehe unten) übereinstimmen.

ListRecords liefert mittels der Angabe von Parametern (siehe unten) die Datensätze. Für selektives Harvesting kann die Anfrage auf Datensätze aus einem bestimmten Datenset oder einem bestimmten Zeitraum beschränkt werden, wobei die Zeit immer die koordinierte Weltzeit UTC ist.

GetRecord liefert einzelne Datensätze durch die Angabe eines Identifiers und eines Präfixes.

Mögliche Parameter

Parameter können die folgenden sein:

  • from – Startdatum
  • until – Enddatum
  • set – Datenset, welches abgerufen werden soll
  • metadataPrefix – Metadatenformat 
  • resumptionToken – Datenflusssteuerung

Es sollten auch Fehlerbehandlungsmechanismen implementiert werden, um sicherzustellen, dass der Server auch bei Fehlern oder unvollständigen Daten angemessen auf Anfragen reagieren kann. Die definierten Fehlerkennungen sind: badArgument, badResumptionToken, badVerb, cannotDisseminateFormat, idDoesNotExist, noRecordsMatch, noMetaDataFormats, und noSetHierarchy.

Die Metadaten folgen dabei dem Mindeststandard des Europeana Data Model (EDM).

Die Datendarstellung sollte einheitlich erfolgen:

  • Datumsangaben im Format YYYY-MM-DD
  • Datumsangaben mit Zeitstempel (in koordinierter Weltzeit) im Format YYYY-MM-DDThh:mm:ss
  • Der Sprach-Tag soll einheitlich für alle Daten sein, dem → ISO-Standard 639-1 oder 639-3 folgend.
  • Mehrere Werte sollen in eigene XML Elemente aufgeteilt werden, z. B. sollte anstatt von <dc:creator>Smith, Adam; Nahs, John</dc:creator> Folgendes ausgegeben werden:
<dc:creator>Smith, Adam</dc:creator>
<dc:creator>Nahs, John</dc:creator>

Wie stelle ich sicher, dass alles funktioniert?

Testen Sie Ihre OAI-PMH-Implementierung, um sicherzustellen, dass sie ordnungsgemäß funktioniert und die Metadaten wie erwartet verfügbar gemacht werden. Dies kann z. B. über die von OAI-PMH auf der Website zur Verfügung gestellte Validierung geschehen.

Wie kann ich meine Daten der Öffentlichkeit zeigen?

Schließlich können Sie Ihr Repositorium bei einem OAI-PMH-Dienstanbieter oder Aggregator registrieren, damit andere die Metadaten entdecken und sammeln können.

Sie können sich auch freiwillig bei OAI-PMH registrieren, da die Registrierung bestimmte Vorteile mit sich bringt. Neben Testungen zur Konformität des Repositoriums ist dann auch die zur Verfügung gestellte Datenbank für andere Aggregatoren und OAI-PMH-Dienstanbieter öffentlich zugänglich.

Linktipps