Child pages
  • xepicur - XML-Datentransferformat zur Verwaltung von URN
Skip to end of metadata
Go to start of metadata



Die ursprüngliche xepicur Dokumentation wird ergänzt mit den Hinweisen, welche Elemente aktuell und in Zukunft tatsächlich ausgewertet werden.


(Warnung) Zu beachten ist insbesondere: Bitte liefern Sie alle aktuell gültigen URLs mit Ihrer URN. Alle nicht mehr mitgelieferten URLs werden in der URN-Datenbank gelöscht. (Warnung)



Generelle Hinweise

Gültigkeit:

Für Datensätze zur Administration von URNs wird xepicur zukünftig nur noch für die Übertragungsart OAI-PMH verbindlich sein.

Hinweise zu Datenstruktur und Syntax

Für den Datensatz ist als Dokumentformat XML verbindlich.

  • Elementtypen
    • Der Metadatensatz enthält Datenelemente, die nach Elementtypen differenziert in strukturierter Form angegeben sind. Jedes Datenelement wird durch einen Elementbezeichner (tag) eingeleitet, der den Elementnamen angibt.
    • Beispiel: <identifier>

  • Attribute
    • Elementbezeichner werden durch Attribute spezifiziert. Es gibt sowohl obligatorische Attribute ("type", "scheme", "imt") als auch optionale Attribute ("role", "status" oder "type").
    • Beispiel: <identifier scheme="url" role="primary">

Beschreibung des Datenformates, Reihenfolge und Struktur der Elemente

Generelle Struktur

Ein XML-Datensatz besteht aus einem Wurzelelement

<epicur>

und zwei hierarchisch untergeordneten Elementen

<administrative_data>
<record>

Wurzelelement "epciur"

Bezeichnungepicurwird ausgewertet
Attributekeine
Unterelemente
  • "administrative_data"
  • "record"
Wiederholbarnein
Obligatorischja
BeschreibungDas Wurzelelement bildet die äußere Einheit eines XML-Dokumentes.
Syntax
<epicur> 
  <administrative_data>
  [...]
</administrative_data>
  <record> 
[...]
</record>
</epicur>

Elementgruppe "administrative_data"

Element "administrative_data"

Bezeichnungadministrative_dataWird zukünftig nicht mehr ausgewertet, da es aber obligatorisch ist, bitte dennoch liefern.
Attributekeine
Unterelemente
  • "delivery"

Wiederholbarnein
Obligatorischja
Beschreibung

Das Element dient der Kapselung von Legitimationsdaten, der Spezifizierung des URN-Meldeprozesses,
der verwendeten Transferschnittstelle sowie der Art der Rückmeldung.


Syntax
<administrativ_data>
 <delivery>
  [...]
 </delivery>
</administrative_data>

Element "authorization" 

BezeichnungauthorizationWird nicht mehr ausgewertet. Bitte nicht mehr verwenden
Attributekeine

Unterelemente

  • "person_id"
    Legitimations_ID einer Person.
  • "system_id"
    Alternative zu "person_id".
  • "urn_nid"
    Das Element beinhaltet den URN-Unternamensraum wie z. B. "urn:nbn:de".

  • "urn_snid"
    Das Element beinhaltet den NBN-Unternamensraum wie z. B. "urn:nbn:de:gbv:089". Das Ziel ist das Ermitteln von Berechtigungen zur Administration des URN-Unternamensraumes.
Wiederholbarnein
Obligatorischnein
BeschreibungDie Informationen dienen der Spezifizierung des URN-Meldeprozesses wie z. B. URN-Erstmeldung oder URL-Aktualisierung, der verwendeten Transferschnittstelle oder der Art der Rückmeldung.
Syntax
<administrative_data>
 <delivery>
  <authorization>
   <person_id>F6000123</person_id>
   <urn_snid>urn:nbn:de:089</urn_snid>
  </authorization>
 </delivery>
</administrative_data>

Element "update_status"

Bezeichnungupdate_statusIst obligatorisch, bitte nur noch mit dem Werten "urn_new"  oder "url_update_general" verwenden und aktuelle URN/URL-Zuordungen liefern.
Attribute

"type" mit folgenden Inhalten:

  • "urn_new"
    Kennzeichnung der Meldung als "URN-Erstregistrierung". Bei Einbindung in OAI muss bei Neuerstellung von Records "urn_new" angegeben werden.
bitte verwenden
  • "urn_new_version"
Wird nicht mehr ausgewertet
  • "urn_alternative"
Wird nicht mehr ausgewertet
  • "url_update"
Wird nicht mehr ausgewertet
  • "url_update_general"
    Aktualisierung von URLs. Dieses Attribut muss angegeben, wenn der Record nur "neue" URLs beinhaltet. Es werden alle registrierten URLs gelöscht und mit den "neuen" URLs ersetzt.
bitte verwenden
  • "url_delete"
    Dieses Attribut wird gesetzt, wenn eine URL gelöscht werden soll.

Wird nicht mehr ausgewertet

(warning)Hinweis: Wenn url_delete NICHT mit einem OAI-Header <header status="deleted">geliefert wird, wird die gelieferte URL erneut in die Datenbank eingetragen.

  • "url_insert"
    Dieses Attribut wird gesetzt, wenn eine neue URL hinzugefügt (im Sinne eines URL-Nachmeldeprozesses) werden soll.
Wird nicht mehr ausgewertet
Unterelementekeine
Wiederholbarnein
Obligatorischja
BeschreibungDas Element dient der Spezifizierung der Art des Meldeprozesses.
Syntax
<update_status type="urn_new"/>

Element "transfer"

BezeichnungtransferWird nicht mehr ausgewertet. Bitte nicht mehr verwenden.
Obligatorischnein

Element "resupply"

BezeichnungresupplyWird nicht mehr ausgewertet. Bitte nicht mehr verwenden.
Obligatorischnein

Beispiel "administrative_data"

<epicur>

<administrative_data>




<delivery>




<update_status type="urn_new"/>


</delivery>

</administrative_data>
[...]
</epicur>

Elementgruppe "record"

Element "record"

BezeichnungrecordWird ausgewertet

Attribute

keine
Unterelemente
  • "identifier"
    Mit dem Element "identifier" werden URN und URL mit unterschiedlichen Attributen erfasst.
Wird ausgewertet

  • "resource"
    Das Element "resource" mit den Unterelementen "identifier" und "format" dient der Abbildung der Zusammenhänge von URN und URL.
Wird ausgewertet

  • "isPartOf"
    Das Element "isPartOf" dient der Erfassung von Informationen über URNs und URLs für Teildokumente.

URN und URLs werden zukünftig noch registriert, die hierarische Struktur aber ignoriert.


  • "isVersionOf"
Wird nicht mehr ausgewertet. Bitte nicht mehr verwenden.

  • "hasVersion"
Wird nicht mehr ausgewertet. Bitte nicht mehr verwenden.
Wiederholbarja, aber bei Einbindung des Schemas in OAI 2.0 ist die Kardinalität des Elements "record" auf 1 begrenzt.  
Obligatorischja
Beschreibung

Das Element "record" kapselt URN-URL-Beziehungen der Objekte.

Das Element "record" ist dem Wurzelelement "epicur" direkt untergeordnet. Es ist wiederholbar, um Sammelmeldungen zu generieren. Dieser Fall kann bei der Implementation des URN-Melde- und Updateprozesses über eine separate URN-Schnittstelle eintreten. Bei Einbindung des Schemas in OAI 2.0 ist die Kardinalität des Elements "record" auf 1 begrenzt.  

Syntax
<record>
  [...]
</record>

Element "identifier"

BezeichnungidentifierWird ausgewertet
Attribute    
  • "scheme"

Mit dem Attribut "scheme" wird URN bzw. URL des Objektes erfasst.

Das Attribut zur Spezifizierung der URN kann folgende Werte annehmen:

  • "urn"
  • "urn:nbn"
  • "urn:nbn:de"
  • "urn:nbn:at"
  • "urn:nbn:ch"

Das Attribut zur Spezifizierung der URL hat folgenden obligatorischen Wert:

  • "url"
und zusätzlich folgende optionale Attribute:
Wird ausgewertet
  • "type"

Das optionale Attribut dient zur Kennzeichnung einer URL als Frontpage-URL (landing page) und hat den Wert

  • "frontpage".
Wird zukünftig nicht mehr ausgewertet
  •  "status"
Wird nicht mehr ausgewertet. Bitte nicht mehr verwenden.
  • "role"

Das optionale Attribut kennzeichnet eine URL als "Master-URL", die beim Resolving zuerst ausgewiesen werden soll. Dieser Fall tritt ein, wenn mehr als eine URL zu einer URN registriert ist.

Das Attribut hat folgenden Wert:

  • "primary"
Wird ausgewertet
  • "origin"
Wird nicht mehr ausgewertet. Bitte nicht mehr verwenden.
  • "target"
Wird nicht mehr ausgewertet. Bitte nicht mehr verwenden.
Unterelementekeine
Wiederholbarja
Obligatorischja
BeschreibungDas Element "identifier" enthält Informationen über eine URN und URL. Es wird durch obligatorische sowie mehrere optionale Attribute näher spezifiziert.
Syntax (Auswahl)
<identifier scheme="urn:nbn:de"> 
   [...] 
 </identifier>

oder

 <identifier scheme="url"> 
   [...] 
 </identifier>

oder

 <identifier scheme="url" role="primary"> 
   [...] 
 </identifier>

Element "isVersionOf"

BezeichnungisVersionOfwird nicht mehr ausgewertet. Bitte nicht mehr verwenden
Obligatorischnein

Element "hasVersion"

BezeichnunghasVersionwird nicht mehr ausgewertet. Bitte nicht mehr verwenden
Obligatorischnein

Element "resource"

Bezeichnungresourcewird ausgewertet
Attributekeine
Unterelemente
  • "identifier"

Mit dem Element "identifier" wird die URL des Objektes erfasst. Aus diesem Grund muss das Attribut "scheme"="url" verwendet werden. (siehe  Element "identifier")

wird ausgewertet
  • "format"

Das Element "format" dient der Erfassung des MimeTypes des Objektes.

wird ausgewertet
Wiederholbarja
Obligatorischnein
BeschreibungDas Element "resource" kapselt die Unterelemente "identifier" mit dem Attribut "scheme"="url" und "format" dient der Erfassung der URL und des MimeTypes (Dateiformat) des Objektes.
Syntax
<resource>
  <identifier scheme="url">
   [URL des Objektes]
  </identifier>
  <format scheme="imt">
   [MimeType des Objektes]  
</format>
</resource>
Element "format"
Bezeichnungformatwird ausgewertet
Attribute

Das Element "format" hat folgendes Attribut:

  "imt", das als Wert den MimeType des Objektes enthält.


Unterelementekeine
Wiederholbarnein
Obligatorischnein
Beschreibung Das Element "format" dient der Erfassung des MimeTypes (Dateiformates) eines Objektes.
Syntax
<format scheme="imt">
  [MimeType des Objektes]
</format>

Element "isPartOf"

BezeichnungisPartOfZukünftig werden URN und URL registriert, die hierarchische Struktur aber wird ignoriert.
Attributekeine
Unterelemente
  • "identifier"
  • "resource"
Wiederholbarja
Obligatorischnein
Beschreibung

Das Element "isPartOf" kapselt Informationen zu URNs und URLs von Teilobjekten.

Syntax
<isPartOf>
  [...]
</isPartOf>

Beispiel "record"

<epicur>
 
<administrative_data>
[...]
 
 
 
 
<update_status type="urn_new"/>
 
[...] 
</administrative_data>
 
 
 
<record>
 
 
<identifier scheme="urn:nbn:de">
urn:nbn:de:gbv:089-3321752945
</identifier>
 
 
<resource>
 
 
 
<identifier scheme="url" role="primary" >http://edok01.tib.uni-hannover.de/edoks/e01dh01/</identifier>
 
 
 
<format scheme="imt">text/html</format>
 
 
</resource>
 
</record>
</epicur>
  • No labels