PI-Hompage: 220-EPICUR_Transfer

<body> <h1>Menu</h1> <table width="100%" cellpadding="5" cellspacing="2"> <tr class="unterlegt"><td>  <a href="./">Home</a></td></tr> <tr class="unterlegt"><td>  <a href="./?link=201">Überblick</a></td></tr> <tr class="unterlegt"><td><a href="./?link=300">+ Aktivitäten</a></td></tr> <tr class="unterlegt"><td><a href="./?link=500">+ Service</a></td></tr> <tr class="unterlegt"><td>  <a href="./?link=800">Sitemap</a></td></tr> <tr class="unterlegt"><td>  <a href="./?link=900">Impressum</a></td></tr> </table> <h1>Inhalt</h1> <html> <head> <meta http-equiv="content-type" content="text/html;charset=iso-8859-1"> <title>EPICUR: Description of URN transfer interfaces</title> <link href="../includes/formate.css" rel="stylesheet" type="text/css"> <base target="_top"> </head> <body class="inhalt"> <h2>URN management transfer conditions and interfaces at the German National Library</h2> <p> <ul style='list-style-type:none'> <li><a href="#vorbemerkung" target="_self">1. Introduction</a></li> <li><a href="#begriffe" target="_self">2. Terms and Definitions</a></li> <li><a href="#dss-allgemein" target="_self">3. Data structure, syntax and semantics</a></li> <li><a href="#dss-hinweise" target="_self">4. Notes on data structure and syntax</a></li> <li><a href="#transportwege" target="_self">5. URN transfer methods</a> <br>       <a href="#urn-erstmeldung" target="_self">5.1 URN registration via existing workflow procedures</a> <br>       <a href="#transfer-manuell" target="_self">5.2 Manual URN management</a> <br>       <a href="#transfer-email" target="_self">5.3 E-mail</a> <br>       <a href="#transfer-oai" target="_self">5.4 OAI 2.0 protocol</a> </li> </ul> </p> <hr><br> <a name="vorbemerkung"></a><h2>1. Introduction</h2> <p> The German National Library is able to process data generated as part of the URN procedure using various transfer methods. The present document describes the technical conventions needed in these transfer methods and gives corresponding examples. It is possible to select between several alternatives concerning the technical transfer methods and that that provides the best solution for the institution's existing workflow. </p> <a name="begriffe"></a><h2>2. Terms and Definitions</h2> <p> <b>URN management</b> </p> <p> The term "URN management" is used to designate all procedures required for the productive application of URNs. The following procedures are of significance to the URN namespace administrator: </p> <p> <ul> <li> Allocating URNs for <ul> <li>Complete objects</li> <li>Part objects</li> <li>Object versions</li> </ul> </li> <li> Transferring the URN-URL pair to the German National Library <ul> <li> Updating URLs (deleting, adding, changing a URL) </li> <li> Maintenance of administrative data such as contact information </li> </ul> </li> </ul> </p> <p> The URN related services at the German National Library are described under its <a href="http://nbn-resolving.de/urn:nbn:de:1111-200606309">URN strategy</a>. </p> <p> <b>URN-URL pairs</b> </p> <p> What does a URN refer to? A URN points to at least one URL. URN- and URL related information must be captured together and registered at the German National Library. URNs in the form <a href="http://nbn-resolving.de/urn/resolver.pl?urn=urn:nbn:de:gbv:089-3321752945"> urn:nbn:de:gbv:089-3321752945</a> can only be applied, for example in an online catalogue, if the required information are registered at the German National Library. </p> <p> <b>URN-URL relationships</b> </p> <p> This term is used to describe all URN-URL relationships which arise in the context of a URN management: </p> <p> <ul> <li> 1:1 relationship (1 URN refers to 1 URL) </li> <li> 1:n relationship (1 URN refers to several URLs) </li> <li> hierarchical relationships from URNs of part documents to URNs of complete documents </li> <li> semantic relationships of one URN to a URN for a new version of an object. </li> </ul> </p> <p> <b>URL management</b> </p> <p> This term comprises the procedure for the initial registration of URN-URL pairs as well as all update processes such as deleting or updating URLs. </p> <p> <b>URN transfer methods</b> </p> <p> This term covers all the technical data transfer options for URN-URL pairs, for example via existing workflows from the URN namespace administrator to the German National Library. </p> <p> <b>XML record or record</b> </p> <p> This represents a unit of the registration format for URN-URL relationships, based on XML syntax. </p> <a name="dss-allgemein"></a><h2>3. Data structure, syntax and semantics</h2> <p> The description of the data records', data structure, syntax and semantics is based on XML and is explained in <a href="../?link=210&lang=en">xepicur - XML data transfer format for the management of Persistent Identifiers.</a> </p> <a name="dss-hinweise"></a><h2>4. Technical notes on data structure and syntax</h2> <p> Data received via the existing transfer interfaces described below are processed entirely automatically by the German National Library. </p> <p> The description of the data record structure that can be processed by the German National Library can be found in the document specified in <a href="#dss-allgemein" target="_self">Point 3</a>. </p> <p> The description of the structure comprises details on permitted syntax, case sensitivity such as "epicur", "administrative_data", "record", "identifier", "isPartOf" and is comprehensive in regard to </p> <p> <ul> <li>the number of permitted and mandatory element and sub-element identifiers and</li> <li>the possible combinations of attributes such as "scheme", "imt"</li> <li>and the rules on repeating element identifiers such as "administrative_data", "record" or the "identifier" itself. </li> </ul> </p> <p> Specifically the following processing rules apply in cases of incompatibility between specifications and the actual metadata records delivered. </p> <p> <ul> <li>Structural incompatibility <ul> <li> Insofar as structural incompatibility in records can be ascribed to XML, then the records will be returned automatically to the sender or to the registered contact person with an explanation. </li> </ul> </li> <li>Element identifiers <ul> <li> If element identifiers that must be defined are missing from the records ("epicur", "administrative_data", "delivery", "update_status", "record", "identifier") then the records will be returned automatically to the sender or to the registered contact person with an explanation. </li> </ul> </li> <li> Using undefined element identifiers <ul> <li> If element identifiers other than those set out in chapter 2 are used, then the records will be returned automatically to the sender or to the registered contact person with an explanation. </li> </ul> </li> <li> Attributes <ul> <li> If attributes which must be defined ("type", "scheme", "imt") are missing, then the records will be returned automatically to the sender or to the registered contact person with an explanation. </li> </ul> </li> <li>Semantic incompatibility <ul> <li> All incoming records will be checked against the following criteria: <br \> - Details supplied match the target of the record, such as initial URN registration or URL updating<br \> - Checking URN(s) and URL(s) for duplication<br \> - URN consistency checked using URN check digit<br \> </li> </ul> </li> </ul> <p> In case of errors, the records will be returned automatically to the sender or to the registered contact person with an explanation </p> <a name="transportwege"></a><h2>5. URN transfer methods</h2> <p> <ul style='list-style-type:none'> <li><a href="#urn-erstmeldung" target="_self">5.1 URN registration via existing workflow procedures</a> </li> <li><a href="#transfer-manuell" target="_self">5.2 Manual URN management</a> </li> <li><a href="#transfer-email" target="_self">5.3 Email</a> </li> <li><a href="#transfer-oai" target="_self">5.4 OAI 2.0 protocol</a> </li> </ul> </p> <p> The various URN transfer methods offer different functionality. The disadvantage if URNs registered at the German National Library using existing workflow procedures is that only URN registration is possible, and other procedures in context of the URN management for example to update URLs have to be performed using another transfer methods. For this reason the German National Library prefers either implementing transfer by e-mail of the implementation of the OAI 2.0 URN management system. </p> <p> <a name="urn-erstmeldung"></a><h3>5.1 Registering URNs at the German National Library using existing workflow procedures</h3> </p>  <p> <a name="urn-erstmeldung-realize"></a><b>5.1.1 What is possible?</b> </p> <p> <ul> <li>Type of registration <ul><li>Single registration</li></ul> </li> <li>URN management <ul><li>Initial URN registration</li></ul> </li> </ul> </p> <p> <b>5.1.2 What is <b>NOT</b> possible?</b> </p> <p> <ul><li>Type of registration <ul><li>Multiple registrations</li></ul> </li> <li>URN management <ul> <li> Initial URN registration for part documents </li> <li> Initial URN registration for new versions of objects </li> </ul> </li> <li> URL management <ul> <li> Updating a single URL </li> <li> Deleting a single URL </li> <li> Inserting a new URL </li> </ul> </li> <li> Registering an additional Persistent Identifier for an object </li> </ul> </p> <p> <a name="urn-erstmeldung-ddb-workflows"></a><b>5.1.3 Established workflow procedures for registering and archiving online resources at the German National Library</b> </p> <p> The following business procedures for registering and archiving online resources at the German National Library can be used for registering URNs. <ul> <li><a href="http://deposit.d-nb.de/netzpub/web_online-hochschulschriften.htm">Online theses and dissertations</a></li> <li><a href="http://deposit.d-nb.de/netzpub/web_abgabe_np_verfahren.htm">Networked publications </a></li> </ul> </p> <p> In both workflow procedures metadata is delivered to the German National Library using a variety of transfer interfaces. A field is provided in the metadata for "Persistent Identifier" and "Uniform Resource Locator (URL)". These fields must be completed. URN registration then occurs automatically. </p> <p> <a name="urn-erstmeldung-netzpub"></a><b>5.1.3.1 URN registration for networked publications using the interactive registration form</b> </p> <p> <b>Step 1: Authenticating who is registering </p> <p> The person registering authenticates him/herself using the identification details supplied (ID and password) on the website: <a href="http://deposit.d-nb.de/cgi-bin/epmeld_form.pl">http://deposit.d-nb.de/cgi-bin/epmeld_form.pl</a> </p> <p> <b>Step 2: Registration of metadata</b> </p> <p> Metadata are then registered. The information required for archiving a networked publication at the German National Library are explained in detail in a separate comprehensive <a href="http://deposit.d-nb.de/anmeldeformulare/netzpub_hilfe.htm"> Registration form help</a>. </p> <p> <b>Step 3: URN and URL details </b> </p> <p> Enter the URN in the "Adress/Identifier" field and click on the "URN" radio button. </p> <p> <center><img src="../img/URN-Netzpub.jpg" alt="Interactive URN capture registration form for networked publications graphic"></center> </p> <p> Then repeat the field group, while pressing the "+" button. <br> Enter the URL in the "Address/Identifier" field and click on the "URL" radio button. </p> <p> <center><img src="../img/URN-URLNetzpub.jpg" alt="Interactive URN and URL capture registration form for networked publications graphic"></center> </p> <p> <a name="urn-erstmeldung-hs"></a><b>5.1.3.2 Registering URNs for academic publications.</b> </p> <p> <ul> <li><a href="../?link=312&lang=en">Further information on registering URNs for online theses and dissertations</a></li> </ul> </p> <a name="transfer-manuell"></a><h3>5.2 Manual URN management</h3> <p> This transfer method offers manual URN management <ul> <li>if you are expecting to manage a small number of URNs or </li> <li>to compensate for lacking the functionality of the transfer interfaces described in point 5.1. </li> </ul> </p> <p> <b>5.2.1 What is possible?</b> </p> <p> <ul> <li>Type of registration <ul><li> Single registration </li></ul> </li> <li>URN management <ul><li> Initial URN registration </li> <li> Initial URN registration for part documents<br> </li> <li> Initial URN registration for a new version of a publication </li></ul> </li> <li>URL management <ul><li> Updating single URLs or all the URLs that are registered against a single URN </li> <li> Adding a URL </li> <li> Deleting a URL </li> </ul> </li> <li>Registering an additional Persistent Identifier for an object</li> </ul> </p> <p> <b>5.2.2 What is NOT possible?</b> </p> <ul> <li>Type of registration <ul><li>Multiple registrations</li></ul> </li> </ul> </p> <p> <b>5.2.3 Production steps</b> </p> <p> <b>Step 1: Authenticating the URN namespace administrator</b> </p> <p> The person registering authenticates him/herself using the identification details supplied (ID and password) on the website: <a href="http://nbn-resolving.de/login.php">http://nbn-resolving.de/login.php</a> </p> <p> <b>Step 2: Selecting the intended action</b> </p> <p> After successful authentification various URN management functions will be available. The information which needs to be registered are explained in detail in a separate <a href="https://ssl.nbn-resolving.de/frontend/english/help.php">URN namespace management help</a>. </p> <p> <center><img src="../img/frontend-auswahl.jpg" alt="Manual URN management via a web interface graphic"></center> </p> <p> <b>Step 3: Registration the information</b><br> </p> <p> Information is captured using interactive forms. </p> <p> <a name="transfer-email"></a><h2>5.3 Email</h2> </p>  <p> <a name="transfer-email-realize"></a><b>5.3.1 What is possible?</b> </p> <p> <ul> <li>Type of registration <ul> <li> Single registration </li><li> Multiple registrations </li></ul> <li> URN management <ul><li> Initial URN registration </li><li> Initial URN registration for part documents </li><li> Initial URN registration for a new version of a publication </li></ul> </li> <li>URL management <ul><li> Updating single URLs or all the URLs that are registered against a single URN </li><li> Adding a URL </li><li> Deleting a URL </li></ul> </li> </ul> </p> <p> <a name="transfer-email-realize"></a><b>5.3.2 Production steps</b> </p> <p> The procedure is carried out in the following steps: <br> <br> <b>Step 1: Target of registration process</b> </p> <p> The target of the registration process, such as, for example an initial URN registration, or updating a URL, requires different information to be registered. The information required is drawn from the descriptions in <a href="../?link=210&lang=en">"xepicur - an XML data transfer format for the management of Persistent Identifiers"</a>. </p> <p> <b>Step 2: Creating a "[name].xml" text file</b> </p> <p> Create an XML file following the rules in <a href="../?link=210&lang=en">"xepicur - an XML data transfer format for the management of Persistent Identifiers"</a>. The file can be given any name. The file extension must be "xml". </p> <p> <i>Example: urn:nbn:de:1111-20040405.xml</i> </p> <p> In this example the file name is derived from the URN sub-namespace and the date of delivery. </p> <p> <b>Step 3: Send the XML file as an attachment to an e-mail</b> </p> <p> The XML file created have to be sent as an attachment to an e-mail to the following address at the German National Library: </p> <p> <i>"urn-transaction@nbn-resolving.org"</i> </p> <p> Leave the subject line empty.<br> The body of the e-mail message is also empty. </p> <p> <b>Step 4: Finding out about processing status</b> </p> <p> The subsequent processing workflow at the German National Library is automated. A message will be generated containing the processing status (successful or unsuccessful). </p> <p> <a name="transfer-email-realize"></a><b>5.3.3 Examples (<a href="../download/URN_Verwaltung_XML_Beispiele.zip">ZIP</a>)</b> </p> <p> Examples (XML) </p> <p> <ul> <li> URN management <ul><li> Initial URN registration of entire object (<a href="../download/URN_new_Min.xml">Minimum</a>, <a href="../download/URN_new_Max.xml">Maximum</a>) </li><li> Initial URN registration of part object (<a href="../download/URN_new_Part_Min.xml">Minimum</a>, <a href="../download/URN_new_Part_Max.xml">Maximum</a>) </li><li> Initial URN registration of new version of object (<a href="../download/URN_new_version_Min.xml">Minimum</a>, <a href="../download/URN_new_version_Max.xml">Maximum</a>) </li></ul> </li> <li> URL management <ul><li> Updating URL (<a href="../download/URL_Update_Min.xml">Minimum</a>, <a href="../download/URL_Update_Max.xml">Maximum</a>) </li><li> Updating a single URL (<a href="../download/URL-update_single_Min.xml">Minimum</a>, <a href="../download/URL-update_single_Max.xml">Maximum</a>) </li><li> Deleting a single URL (<a href="../download/URL-delete-Min.xml">Minimum</a>, <a href="../download/URL_delete_Max.xml">Maximum</a>) </li><li> Inserting a new URL (<a href="../download/URL_insert_Min.xml">Minimum</a>, <a href="../download/URL_insert_Max.xml">Maximum</a>) </li></ul> </li> <li>Registering an additional Persistent Identifier for an object<a href="../download/URN_Alternative_Min.xml">Minimum</a>, <a href="../download/URN_Alternative_Max.xml">Maximum</a>) </li> </ul> </p> <a name="transfer-oai"></a><h2>5.4 OAI 2.0 protocol</h2>  <p> <a name="transfer-oai-realize"></a><b>5.4.1 What is possible?</b> </p> <p> <ul> <li>Type of registration <ul><li> Single registration </li></ul> </li> <li>URN management <ul><li> Initial URN registration </li><li> Initial URN registration for part documents </li><li> Initial URN registration for a new version of a publication </li></ul> </li> <li>URL management <ul><li> Updating URLs for <b>all</b> URLs registered against a single URN </li></ul> </li> </ul> </p> <p> <a name="transfer-oai-min"></a><b>5.4.2 Data provider's OAI minimum implementation requirements </b> </p> <p> <ul> <li>Implementing OAI protocol version 2.0</li> <li>daily, selective harvesting (from...until...)</li> <li>OAI requests for various metadata schemata</li> <li>Consistent date-stamp updating when altering data records</li> </ul> </p> <p> <a name="transfer-oai-max"></a><b>5.4.3 Data provider's OAI maximum implementation requirements </b> </p> <p> <ul> <li>The minimum requirements must be met</li> <li>Flow control using "Resumption Token"</li> <li>Selective harvesting on an hourly basis (from... until...)</li> </ul> </p> <p> <a name="transfer-oai-schritte"></a><b>5.4.4 Production steps</b> </p> <p> <b>Step 1: Extending the data provider OAI request following "metadataPrefix=epicur"</b> </p> <p> The OAI data provider must permit an OAI request for <b> "metadataPrefix=epicur" </b>. </p> <p> <i>Example</i> </p> <p> [...]<br> <request verb="ListRecords" from="2004-03-30T00:00:00Z" until="2004-03-31T00:00:00Z" metadataPrefix="epicur"> </p> <p> http://[OAI data provider domain]/[filepath]/[OAI script]  </p> <p> </request> <br>[...] </p> <p> <b>Step 2: Structuring metadata in "xepicur"</b> </p> <p> The previously created metadata are to be structured following the rules in <a href="../?link=210&lang=en">"xepicur - an XML data transfer format for the management of Persistent Identifiers"</a>. </p> <p> <b>General notes on preparing metadata for URN management</b> </p> <ul> <li> Regardless of the data model used by the data provider, it may be necessary to extend the data model using the <b>"update_status"</b> field. </li> <li> Consistently <b>updating the date stamp</b>, when changes to the URN related metadata. </li> <li> When making changes, especially URL updates, essentially only the desired <b>target status</b>, thus for example only current URLs, will be created. </li> </ul> </p> <p> <a name="transfer-oai-beispiele"></a><b>5.4.5 Examples (<a href="../download/OAI_URN_Verwaltung_Beispiele.zip">ZIP</a>)</b> </p>  <p> </p> <p> <b>5.4.5.1 Example answer to an OAI request for "metadataPrefix=epicur"</b> </p> <p> <?xml version="1.0" encoding="UTF-8"?> <OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" <br> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <br> xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ <br> http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd"> <br> <responseDate>2004-03-31T15:43:26Z</responseDate> <br> <request verb="ListRecords" from="2004-03-30T00:00:00Z" until="2004-03-31T00:00:00Z" metadataPrefix="epicur"> <br> http://edoc.hub-berlin.de/oai2.0/urnoai  <br> <br> </request> <br> <br> <ListRecords> <br>  <record> <br>   <header> <br>    <identifier>oai:hub:myurn</identifier> <br>    <datestamp>2004-03-30T16:20:12Z</datestamp> <br>   </header> <br> <br> <br>   <metadata> <br>    <epicur xmlns="urn:nbn:de:1111-2004033116" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance="    xsi:schemaLocation="urn:nbn:de:1111-2004033116 <br>    http://nbn-resolving.de/urn/resolver.pl?urn=urn:nbn:de:1111-2004033116"> <br>     <br> <br>    <administrative_data> <br>     <delivery> <br>      <update_status type="urn_new"/> <br>     </delivery> <br>    </administrative_data> <br>    <record> <br>     <identifier scheme="urn:nbn:de" >urn:nbn:de:kobv:11-1008171</identifier> <br>     <resource> <br>      <identifier scheme="url">http://dochost.rz.hu-berlin.de/dissertationen/biologie/schmidt-kathrin/SGML/schmidt.did </identifier> <br>      <format scheme="imt">text/sgml</format> <br>     </resource> <br>    </record> <br>    </epicur> <br> <br>   </metadata> <br> <br>   [...] <br> <br>  </record> <br>  </ListRecords> <br> </OAI-PMH> <br> </p> <p> <b>5.4.5.2 Initial URN registration for complete and part objects</b> </p> <p> Notes </p> <p> <ul> <li>Updating the date stamp</li> <li>The attribute of the "update_status" element is "urn_new" (update_status="urn_new")</li> </ul> <p> Examples (XML) </p> <ul> <li> Initial URN registration of complete object (<a href="../download/OAI_URN_insert_Min.xml">Minimum</a>, <a href="../download/OAI_URN_insert_Max.xml">Maximum</a>) </li> <li> Initial URN registration of part object (<a href="../download/OAI_Part_insert_Min.xml">Minimum</a>, <a href="../download/OAI_Part_insert_Max.xml">Maximum</a>) </li> </ul> </p> <p> <b>5.4.5.3 Initial URN registration for new versions of objects</b></p> </p> <p> Notes </p> <p> <ul> <li>Updating the date stamp</li> <li>The attribute of the "update_status" element is "urn_new_version" (update_status="urn_new_version")</li> </ul> </p> <p> Examples (XML) </p> <ul> <li> <a href="../download/OAI_URN_new_version_Min.xml">Minimum</a> </li> <li> <a href="../download/OAI_URN_new_version_Max.xml">Maximum</a> </li> </ul> </p> <p> <b>5.4.5.4 Updating URLs</b> </p> <p> Notes </p> <p> <ul> <li>Updating the date stamp</li> <li>The attribute of the "update_status" element is "url_update_general" (update_status="url_update_general")</li> <li>Only <b>new URLs</b> will be detailed. </li> </ul> </p> <p> Examples (XML) </p> <p> <ul> <li><a href="../download/OAI_URL_Update_Min.xml">Minimum</a></li> <li><a href="../download/OAI_URL_Update_Max.xml">Maximum</a></li> </ul> </p> <br /> <br /> <b>Warning</b>: include(../includes/footer_en.inc) [<a href='function.include'>function.include</a>]: failed to open stream: No such file or directory in <b>/data/htdocs/www.persistent-identifier.de/english/220-EPICUR_Transfer.php</b> on line <b>880</b><br /> <br /> <b>Warning</b>: include() [<a href='function.include'>function.include</a>]: Failed opening '../includes/footer_en.inc' for inclusion (include_path='.:/usr/local/lib/php') in <b>/data/htdocs/www.persistent-identifier.de/english/220-EPICUR_Transfer.php</b> on line <b>880</b><br /> </body> </html> </body>