PI-Hompage: 210-EPICUR_xml_RefDescr

<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> <title>xepicur - Reference description "xepicur - an XML data transfer format for the administration of Persistent Identifiers"</title> <link href="/includes/formate.css" rel="stylesheet" type="text/css"> </head> <body class="inhalt"> <h2>xepicur - an XML data transfer format for the administration of Persistent Identifiers</h2> <p></p> <table> <tr><td> <ul style='list-style-type:none'> <li><a href="#vorbemerkung">Introduction</a></li> <li> <a href="#datentransferformat">B Data transfer format</a> <br>    <a href="#hinweis-allg">1. General notes</a> <br>     <a href="#hinweis-datenstruktur">2. Data structure and syntax notes</a><br>    <a href="#beschreibung"> 3. Description of data format, and sequence and structure of elements.</a><br> </li> </ul> </td></tr> </table> <br><hr> <a name="vorbemerkung"></a><h2>Introduction</h2> <p> The following document describes the data transfer format "xepicur". This XML based format provides a comprehensive URN administration. Data records are created by the authorised URN namespace administrator and can </p> <p> <ul> <li>be active reported to the German National Library directly or</li> <li>harvested by the German National Library.</li> </ul> </p> <p> This includes the following procedures: </p> <p> <ul> <li> Initial registration of URNs for <ul> <li>Complete objects</li> <li>Partial objects or</li> <li>Versions of objects</li> </ul> </li> <li> URL management <ul> <li>updating of one or more URL</li> <li>adding one or more URL</li> <li>deleting one or more URL</li> </ul> </li> </ul> </p> <p> Data records are created by the authorised URN namespace administrator and can be submitted as <ul> <li>single or</li> <li>accumulated reports</li> </ul> </p> <p> and </p> <p> <ul> <li>can be active reported to the German National Library or</li> <li>harvested by the German National Library.</li> </ul> </p> <p> The various transfer methods are detailed under <a href="../?link=220&lang=en" target="_top">Description of transfer interfaces</a>. </p> <p> "xepicur" was developed as part of the EPICUR project in co-coperation of the EPICUR with digital library tool developers and content providers. </p> <a name="datentransferformat"></a><h2>B Data transfer format</h2> <p> <a name="hinweis-allg"></a><h3>1. General notes</h3> </p> <p> <ul> <li>Validity <ul> <li>xepicur is mandatory for the transfer of all URN management data records, except for existing reporting procedures for archiving digital objects at the German National Library. </li> </ul> </li> </ul> </p> <p> <a name="hinweis-datenstruktur"></a><h3>2. Notes on data structure and syntax</h3> </p> <p> The XML document format has to be used for structuring the data record. </p> <ul> <li> <b>Types of elements</b> <ul> <li> The xml data record contains data elements which appear in a structured form, differentiated according to their element type. Each data element is preceded by an element descriptor (tag) which represent the name of the element. </li> <li> <i>Example:</i> <identifier> </li> </ul> </li> <li> <b>Attributes</b> <ul> <li>Element descriptors are specified by their attributes. Mandatory ("type", "scheme", "imt") and optional ("role", "status" or "type") attributes have been defined. </li> <li><i>Example:</i> <identifier scheme="url" role="primary"> </li> </ul> </li> </ul> <a name="beschreibung"></a><h3>3. Description of data format, and sequence and structure of elements</h3> <p> <h4>General structure</h4> </p> <p> An XML data record comprises one root element </p> <p> <ul> <li> <epicur> <br> </li> </ul> <p> and two subordinated sub-elements </p> <ul> <li><administrative_data> </li> <li><record> </li> </ul> </p> <p> <h4>root element</h4> </p> <p> <ul> <li> <b>"epicur" root element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>epicur</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td>none</td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> <ul> <li>"administrative_data"</li> <li>"record" </li> </ul> </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>no</td> </tr> <tr class="gerade"> <td>mandatory</td> <td>yes</td> </tr> <tr class="ungerade"> <td>description</td> <td>The root element encapsulates the XML document.</td> </tr> <td>Syntax</td> <td> <epicur> <br>  <administrative_data> <br>   [...]<br>  </administrative_data> <br>  <record> <br>   [...]<br>  </record><br> </epicur> </td> </tr> </table> </p> <p> <h4>"administrative_data" element group</h4> </p> <p> <ul> <li> <b>"administrative_data" element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>administrative_data</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td>none</td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> <ul> <li>"delivery"</li> </ul> </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>no</td> </tr> <tr class="gerade"> <td>mandatory</td> <td>yes</td> </tr> <tr class="ungerade"> <td>description</td> <td> The element incorporates the verification data, the specification of the URN reporting process, the transfer interface used and type of confirmation concerning the processed data records. </td> </tr> <td>Syntax</td> <td> <administrativ_data> <br>  <delivery> <br>   [...] <br>  </delivery> <br> </administrative_data> </td> </tr> </table> </p> <p> <ul> <li> <b>"authorization" element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>authorization</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td>none</td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> <ul> <li>"person_id" <br> Authorisation ID for a person. </li> <li>"system_id"<br> Alternative to "person_id". This is an ID that only used in conjunction with automated URN reporting process. </li> <li>"urn_snid" <br> This element contains the NBN sub-namespace such as urn:nbn:de:gbv:089. The aim of this is to determine authority for managing URN sub-namespaces. </li> <li>"urn_snid" <br> This element contains the URN sub-namespace such as "urn:std". </li> </ul> </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>no</td> </tr> <tr class="gerade"> <td>mandatory</td> <td>no</td> </tr> <tr class="ungerade"> <td>description</td> <td> This information is used to specify the URN registration process, such as initial registration or updating process, the transfer interface used or the type of confirmation of processed data records. </td> </tr> <tr class="gerade"> <td>Syntax</td> <td> <administrative_data> <br>  <delivery> <br>   <authorization><br>    <person_id>F6000123</person_id> <br>    <urn_snid>urn:nbn:de:089</urn_snid><br>   </authorization><br>  </delivery> <br> </administrative_data> </td> </tr> </table> </p> <p> <ul> <li> <b>"update_status" element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>update_status</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td> "type" with the following content: <ul> <li>"urn_new" <br> "Initial URN registration" indicator. When integrated with OAI, "urn_new" must be specified when creating new records. </li> <li>"urn_new_version"<br> Initial URN registration for a new document version. </li> <li>"urn_alternative" <br> Persistent Identifier, which exists for an already registered URN, such as DOI. </li> <li>"url_update" <br> When updating a URL, this attribute specifies to be altered URL if several URLs registered. </li> <li>"url_update_general" <br> Updating URLs. This attribute must be specified if the record only contains "new" URLs. All registered URLs will be deleted and replaced with the "new" URL(s). </li> <li>"url_delete" <br> This attribute is set if the URL is to be deleted. </li> <li>"url_insert" <br> This attribute is set if a new URL is to be inserted (in the sense of a subsequent URL registration process). </li> </ul> </td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> none </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>no</td> </tr> <tr class="gerade"> <td>mandatory</td> <td>yes</td> </tr> <tr class="ungerade"> <td>description</td> <td> This element is used to specify the registration process type. </td> </tr> <tr class="gerade"> <td>Syntax</td> <td> <update_status type="urn_new"/> <br> </td> </tr> </table> </p> <p> <ul> <li> <b>"transfer" element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>transfer</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td> "type" with the following content: <ul> <li>"email" <br> </li> <li>"http" <br> </li> <li>"ftp" <br> </li> </ul> </td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> none </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>no</td> </tr> <tr class="gerade"> <td>compulsory</td> <td>no</td> </tr> <tr class="ungerade"> <td>description</td> <td> Transfer interface or protocol details. </td> </tr> <tr class="gerade"> <td>Syntax</td> <td> <transfer type="email"/> <br> </td> </tr> </table> </p> <p> <ul> <li> <b>"resupply" element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>resupply</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td> "type" with the following content: <ul> <li>"email" <br> </li> <li>"ftp" <br> </li> </ul> </td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> none </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>no</td> </tr> <tr class="gerade"> <td>mandatory</td> <td>no</td> </tr> <tr class="ungerade"> <td>description</td> <td> Target address for information on processing status (success or error). </td> </tr> <tr class="gerade"> <td>Syntax</td> <td> <resupply type="email"/> <br> </td> </tr> </table> </p> <p> <b>"administrative_data" example</b> </p> <p> <table> <tr><td> <epicur> </td> </tr> <tr> <td></td><td><administrative_data></td><td></td><td></td> </tr> <tr> <td></td><td></td><td><delivery></td><td></td> </tr> <tr> <td></td><td></td><td></td> <td><authorization> </td> </tr> <tr> <td></td><td></td><td></td><td></td> <td> <person_id>F6000123</person_id><br> <center><b>or</b></center> <system_id>034jf0249r843</system_id> </td> </tr> <tr> <td></td><td></td><td></td><td></td> <td> <urn_snid>urn:nbn:de:gbv:089</urn_snid> <br> <center><b>or</b></center> <urn_nid>urn:issn</urn_nid> </td> </tr> <tr> <td></td><td></td><td></td> <td><authorization> </td> </tr> <tr> <td></td><td></td><td> <td colspan=3> <update_status type="urn_new"/> <br> </td> </tr> <tr> <td></td><td></td><td> <td colspan=3><transfer type="http"/> </td> </tr> <tr> <td></td><td></td><td> <td colspan=3><resupply type="email"/> </td> </tr> <tr> <td></td><td></td><td></delivery></td> </tr> <tr> <td></td><td></administrative_data> </td> </tr> <tr><td> [...] </td></tr> <tr><td> <epicur> </td> </tr> </table> </p> <p> <h4>"record" element group</h4> </p> <p> <ul> <li type="circle"> <b>"record" element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>record</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td> none </td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> <ul> <li>"identifier"<br> With the "identifier" element URNs and URLs with different attributes are included. </li> <li>"isVersionOf" <br> With the "isVersionOf" element, a URN for the new document version can be created. </li> <li>"hasVersion" <br> The "hasVersion" element contains a Persistent Identifier such as a DOI which exists in addition to a URN and should be registered at the German National Library. </li> <li>"resource" <br> The "resource" element, with its sub-elements "identifier" and "format", is used to illustrate the context of the URN and the URL. </li> <li>"isPartOf" <br> The "isPartOf" element is used for recording information on URNs and URLs for part documents. </li> </ul> </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>yes</td> </tr> <tr class="gerade"> <td>mandatory</td> <td>yes</td> </tr> <tr class="ungerade"> <td>description</td> <td> The "record" element covers URN-URL relationships of the objects. </td> </tr> <tr class="gerade"> <td>Syntax</td> <td> <record> <br>   [...] <br> </record> </td> </tr> </table> </p> <p> <ul> <li> <b>"identifier" element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>identifier</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td> <ul> The "identifier" element has the following attributes: <li>"scheme" <br> With the "scheme" attribute, the URN or URL belonging to the object is captured <br><br> The attribute for specifying the <b>URN</b> can have the following values: <br>   "urn" <br>   "urn:nbn" <br>   "urn:nbn:de" <br>   "urn:nbn:at" <br>   "urn:nbn:ch" <br> <br> The attribute for specifiyng the <b>URL</b> has the following compulsory value: <br>   "url" <br> <br> and in addition, the following <b>optional</b> attributes: </li> <li>"type" <br> The optional attibute serves to identify a URL as a frontpage URL and has the value "frontpage". </li> <li>"status" <br> This attribute is optional and is used in context of the update process to characterise a URL as "old" or "new". It can have the following alternative values: <br>   "new" <br>   "old" <br> </li> <li>"role" <br> This optional attribute indicates a URL as a "master URL" and is initially designated during the resolution procedure. This would be the case if more than one URL is registered against a single URN. <br> The attribute has the following value: <br>   "primary" </li> <li>"origin" <br> This optional attribute specifies the origin of the object. <br> This attribute can have the following alternative values: <br>   "original" <br>   "external" <br>   "archive" <br> </li> <li>"target" <br> The indication <i>target="transfer"" </i> is optional and is used to identify a URL as a transfer URL for transferring an object in the legal deposit system of the German National Library. </li> </ul> </td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> none </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>yes</td> </tr> <tr class="gerade"> <td>mandatory</td> <td>yes</td> </tr> <tr class="ungerade"> <td>description</td> <td> The "identifier" element contains information about a URL or URN. It is specified in more detail by means of mandatory and several optional attributes. </td> </tr> <tr class="gerade"> <td>Syntax (Selection)</td> <td> <identifier scheme="urn:nbn:de"> <br>   [...] <br> </identifier> <br><b>or</b><br> <identifier scheme="url"> <br>   [...] <br> </identifier> <br><b>or</b><br> <identifier scheme="url" type="frontpage" role="primary" origin="archive"> <br>   [...] <br> </identifier> </td> </tr> </table> </p> <p> <ul> <li> <b>"isVersionOf" element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>isVersionOf</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td> The namespace of the Persistent Identifier is determined by means of the "scheme" attribute. This attribute can have the following values: <ul> <li> "urn" </li> <li> "urn:nbn" </li> <li> "urn:nbn:de" </li> <li> "urn:nbn:at" </li> <li> "urn:nbn:ch" </li> </ul> </td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> none </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>no</td> </tr> <tr class="gerade"> <td>mandatory</td> <td>no</td> </tr> <tr class="ungerade"> <td>description</td> <td> The optional "isVersionOf" element contains the Persistent Identifier of the new document version. </td> </tr> <tr class="gerade"> <td>Syntax</td> <td> <isVersionOf scheme="urn:nbn:de"> <br>   [...] <br> </isVersionOf> </td> </tr> </table> </p> <p> <ul> <li> <b>"hasVersion" element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>hasVersion</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td> The namespace of the Persistent Identifier is determined by means of the "scheme" attribute. This attribute can have the following values: <ul> <li> "urn" </li> <li> "urn:nbn" </li> <li> "urn:nbn:de" </li> <li> "urn:nbn:at" </li> <li> "urn:nbn:ch" </li> <li> "doi" </li> <li> "handle" </li> <li> "urn:issn" </li> <li> "urn:isbn" </li> </ul> </td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> none </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>no</td> </tr> <tr class="gerade"> <td>mandatory</td> <td>no</td> </tr> <tr class="ungerade"> <td>description</td> <td> The "hasVersion" element is optional and provides details as to whether, in addition to an already registered Persistent Identifier, such as "urn:nbn:de:...", a further Persistent Identifier such as DOI exists. This "external" Persistent Identifier must be specified using "scheme". </td> </tr> <tr class="gerade"> <td>Syntax</td> <td> <hasVersion scheme="doi"> <br>   [...] <br> </hasVersion> </td> </tr> </table> </p> <p> <ul> <li> <b>"resource" element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>resource</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td> none </td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> <ul> <li>"identifier" <br> the "identifier" element captures the URL of the object. For this reason, the scheme="url" attribute must be used. (see "identifier" element) </li> <li>"format" <br> The "format" identifier is used to capture the object's mime type. </li> </ul> </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>yes</td> </tr> <tr class="gerade"> <td>mandatory</td> <td>no</td> </tr> <tr class="ungerade"> <td>description</td> <td> The "resource" identifier encapsulates the "identifier" sub-element with the scheme="url" attribute, and "format" is used to capture the object's URL and Mime Type (file format). </td> </tr> <tr class="gerade"> <td>Syntax</td> <td> <resource> <br>   <identifier scheme="url"> <br>    [object URL] <br>   </identifier> <br>   <format scheme="imt"> <br>    [object's mime type] <br>   </format> <br> </resource> </td> </tr> </table> </p> <p> <ul> <li> <b>"format" element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>format</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td> The "format" element has the following attribute: <br>   "imt", which contains the object's mime type as a value. </td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> none </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>no</td> </tr> <tr class="gerade"> <td>mandatory</td> <td>no</td> </tr> <tr class="ungerade"> <td>description</td> <td> The "format" element is used to cover the object's Mime Type (file format). </td> </tr> <tr class="gerade"> <td>Syntax</td> <td> <format scheme="imt"><br>   [Object mime type] <br> </format> </td> </tr> </table> </p> <p> <ul> <li> <b>"isPartOf" element</b></li> </ul> </p> <p> <table border=1 width=90%> <tr class="gerade"> <td>Designation</td> <td>isPartOf</td> </tr> <tr class="ungerade"> <td>Attributes</td> <td> none </td> </tr> <tr class="gerade"> <td> Sub-elements </td> <td> <ul> <li>"identifier"</li> <li>"resource"</li> </ul> </td> </tr> <tr class="ungerade"> <td>repeatable</td> <td>yes</td> </tr> <tr class="gerade"> <td>compulsory</td> <td>no</td> </tr> <tr class="ungerade"> <td>description</td> <td> The "isPartOf" element includes information about URNs and URLs of part objects. </td> </tr> <tr class="gerade"> <td>Syntax</td> <td> <isPartOf><br>   [...] <br> </isPartOf> </td> </tr> </table> </p> <p> <b>"record" example</b> </p> <p> <table borde=1 width=90%> <tr> <td><epicur> </td> </tr> <tr> <td></td><td><administrative_data><br>[...]</td><td></td><td></td> </tr> <tr> <td></td><td></td><td colspan=2> <update_status type="urn_new"/> </td> </tr> <tr> <td></td><td>[...] <br></administrative_data></td><td></td><td></td> </tr> <tr> <td></td><td> <record> </td> </tr> <tr> <td></td><td></td><td colspan=3> <identifier scheme="urn:nbn:de">urn:nbn:de:gbv:089-3321752945</identifier> </td> </tr> <tr> <td></td><td></td><td> <resource> </td> </tr> <tr> <td></td><td></td><td></td><td colspan=3> <identifier scheme="url" type="frontpage">http://edok01.tib.uni-hannover.de/edoks/e01dh01/</identifier> </td> </tr> <tr> <td></td><td></td><td></td><td colspan=3> <format scheme="imt">text/html</format> </td> </tr> <tr> <td></td><td></td><td> </resource> </td> </tr> <tr> <td></td><td></td><td> <isPartOf> </td> </tr> <tr> <td><td><td></td><td colspan=3> <identifier scheme="urn:nbn:de">urn:nbn:de:gbv:089-332175-teil1</identifier> </td> </tr> <tr> <td><td><td></td><td></td><td> <resource> </td> </tr> <tr> <td></td><td></td><td></td><td></td><td></td><td colspan=3> <identifier scheme="url">http://edok01.tib.uni- hannover.de/edoks/e01dh01/teil1.pdf</identifier> </td> </tr> <tr> <td></td><td></td><td></td><td></td><td colspan=3> <format scheme="imt">application/pdf</format> </td> </tr> <tr> <td><td><td></td><td></td><td> </resource> </td> </tr> <tr> <td></td><td></td><td> </isPartOf> </td> </tr> <tr> <td></td><td></td><td> <isPartOf> </td> </tr> <tr> <td><td><td></td><td colspan=3> <identifier scheme="urn:nbn:de">urn:nbn:de:gbv:089-332175-teil2</identifier> </td> </tr> <tr> <td><td><td></td><td colspan=3> <resource> </td> </tr> <tr> <td></td><td></td><td></td><td></td><td></td><td colspan=3> <identifier scheme="url">http://edok01.tib.uni-hannover.de/edoks/e01dh01/teil2.ps</identifier> </td> </tr> <tr> <td></td><td></td><td></td><td></td><td></td><td colspan=3> <format scheme="imt">application/postscript</format> </td><td></td><td></td> </tr> <tr> <td><td><td></td><td colspan=3> </resource> </td> </tr> <tr> <td></td><td></td><td> </isPartOf> </td> </tr> <tr> <td></td><td> </record> </td> </tr> <tr> <td></epicur></td> </tr> </table> </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/210-EPICUR_xml_RefDescr.php</b> on line <b>1208</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/210-EPICUR_xml_RefDescr.php</b> on line <b>1208</b><br /> </body> </html> </body>