<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>18.2. DOI Management — Metacat 2.8.4 documentation</title>
<link rel="stylesheet" href="_static/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="_static/font-awesome/css/font-awesome.min.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/metacatui.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.8.4',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="Metacat 2.8.4 documentation" href="index.html" />
<link rel="up" title="18. Appendix: Development Issues" href="development.html" />
<link rel="prev" title="18.1. Identifier Management" href="identifiers.html" />
<link rel="next" title="18.3. Metacat Usage Statistics Service" href="statistics-service.html" />
</head>
<body>
<div id="metacatDocs">
<div class="banner">
<a href="index.html"><img class="logo" src="_static/metacat-logo-white.png" /></a>
<a href="index.html"><h1 class="title">Metacat: Metadata and Data Management Server</h1></a>
<img class="logo-right" src="_static/nceas-logo-white.png" />
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right">
<span id="searchbox" style="display: none;">
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" class="icon-search"/>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</span>
</li>
<script type="text/javascript">$('#searchbox').show(0);</script>
<li class="right">
<a href="genindex.html" title="General Index"
accesskey="I">index</a>
</li>
<li class="right">
<a href="statistics-service.html" title="18.3. Metacat Usage Statistics Service"
accesskey="N">next</a>
</li>
<li class="right">
<a href="identifiers.html" title="18.1. Identifier Management"
accesskey="P">previous</a>
</li>
<li class="breadcrumb first"><a href="index.html">Metacat 2.8.4 documentation</a> »</li>
<li class="breadcrumb"><a href="development.html" accesskey="U">18. Appendix: Development Issues</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="doi-management">
<h1>18.2. DOI Management<a class="headerlink" href="#doi-management" title="Permalink to this headline">¶</a></h1>
<dl class="docutils" id="index-0">
<dt>Author</dt>
<dd>Benjamin Leinfelder</dd>
<dt>Date</dt>
<dd><ul class="first last simple">
<li>20130307 [BRL] Initial draft of DOI documentation</li>
</ul>
</dd>
<dt>Goal</dt>
<dd>Register DOI-identified objects with the EZID service on insert/update</dd>
<dt>Summary</dt>
<dd>Metacat supports generating identifiers using UUID and DOI schemes via the
DataONE Member Node API. After client has generated a DOI using this
method, Metacat must ensure that the DOI registration with EZID/DataCite
is created and kept up-to-date.</dd>
</dl>
<div class="section" id="doi-generation">
<h2>18.2.1. DOI Generation<a class="headerlink" href="#doi-generation" title="Permalink to this headline">¶</a></h2>
<p>Metacat will generate, or “mint” a DOI using the EZID service and return that
identifier to the client. This identifier is guaranteed by EZID to be unique
for the shoulder configured for this Metacat instance. The Metacat instance
must have a valid EZID account in order to utilze the EZID service.</p>
<p>There will be no attempt to “reserve” the DOI with the CN because Metacat
will be configured with a unique shoulder and a specific EZID account that
allows minting under that shoulder.</p>
<p>DOIs will only be minted if the following metacat.properties are set.</p>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Metadata Field</th>
<th class="head">Source or value of metadata</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>guid.ezid.enabled</td>
<td>true (default, false)</td>
</tr>
<tr class="row-odd"><td>guid.ezid.username</td>
<td><EZID account> (default, “apitest”)</td>
</tr>
<tr class="row-even"><td>guid.ezid.password</td>
<td><EZID password> (default, “apitest”)</td>
</tr>
<tr class="row-odd"><td>guid.ezid.doishoulder.1</td>
<td><EZID shoulder for home server> (default, “doi:10.5072/FK2”)</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="doi-registration">
<h2>18.2.2. DOI Registration<a class="headerlink" href="#doi-registration" title="Permalink to this headline">¶</a></h2>
<p>When an object identified with a DOI is inserted or updated in Metacat
using the DataONE API, Metacat will supply EZID with the appropriate
metadata for that DOI based on the information available for the object.</p>
<p>The following metadata will be submitted for objects that specify an AccessPolicy
containing a public read rule. The same metadata will be updated when the
Member Node is alerted to a SystemMetadata change on the CN. When a newer
object is added (MN.update()) metadata for the obsolete object is updated as
the metadata for the new object is added - both via EZID API.</p>
<table border="1" class="docutils">
<colgroup>
<col width="31%" />
<col width="69%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Metadata Field</th>
<th class="head">Source or value of metadata</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>dc_identifier</td>
<td>the DOI value</td>
</tr>
<tr class="row-odd"><td>datacite_url</td>
<td>the MN /object URL</td>
</tr>
<tr class="row-even"><td>dc_title</td>
<td>collect from EML; or default to “[Meta]Data object” depending on type</td>
</tr>
<tr class="row-odd"><td>dc_creator</td>
<td>collect from EML; default to SM.rightsHolder</td>
</tr>
<tr class="row-even"><td>dc_publisher</td>
<td>Member Node nodeId or nodeName</td>
</tr>
<tr class="row-odd"><td>datacite_publicationyear</td>
<td>collect from EML; default to SM.dateUploaded</td>
</tr>
<tr class="row-even"><td>datacite_resourcetypegeneral</td>
<td>“Dataset”</td>
</tr>
<tr class="row-odd"><td>datacite_resourcetype</td>
<td>one of “metadata” or “data”</td>
</tr>
<tr class="row-even"><td>datacite_format</td>
<td>SM.formatId</td>
</tr>
<tr class="row-odd"><td>datacite_relatedidentifier_ispreviousversionof</td>
<td>SM.obsoletedBy</td>
</tr>
<tr class="row-even"><td>datacite_relatedidentifier_ispreviousversionoftype</td>
<td>“DOI”, if above exists</td>
</tr>
<tr class="row-odd"><td>datacite_relatedidentifier_isnewversionof</td>
<td>SM.obsoletes</td>
</tr>
<tr class="row-even"><td>datacite_relatedidentifier_isnewversionoftype</td>
<td>“DOI”, if above exists</td>
</tr>
<tr class="row-odd"><td>datacite_relatedidentifier_ispartof</td>
<td>ORE DOI or MN /object URL</td>
</tr>
<tr class="row-even"><td>datacite_relatedidentifier_ispartoftype</td>
<td>“DOI” or “URL”, if above exists</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="doi-registration-for-deprecated-metacat-api">
<h2>18.2.3. DOI Registration for deprecated Metacat API<a class="headerlink" href="#doi-registration-for-deprecated-metacat-api" title="Permalink to this headline">¶</a></h2>
<p>For objects that are inserted or updated using the original Metacat API
using identifiers in the form</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">scope</span><span class="o">.</span><span class="n">docid</span><span class="o">.</span><span class="n">rev</span>
</pre></div>
</div>
<p>(e.g., “smith.1.1”) will have DOIs generated in the form</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">configured</span> <span class="n">doi</span> <span class="n">shoulder</span><span class="o">>/</span><span class="n">scope</span><span class="o">.</span><span class="n">docid</span><span class="o">.</span><span class="n">rev</span>
</pre></div>
</div>
<p>(e.g., “doi:10.5072/FK2/smith.1.1”) and registered with the same metadata as objects
submitted via the DataONE API.</p>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
<div class="footerNav">
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right">
<span id="searchbox" style="display: none;">
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" class="icon-search"/>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</span>
</li>
<script type="text/javascript">$('#searchbox').show(0);</script>
<li class="right">
<a href="genindex.html" title="General Index"
>index</a>
</li>
<li class="right">
<a href="statistics-service.html" title="18.3. Metacat Usage Statistics Service"
>next</a>
</li>
<li class="right">
<a href="identifiers.html" title="18.1. Identifier Management"
>previous</a>
</li>
<li class="breadcrumb first"><a href="index.html">Metacat 2.8.4 documentation</a> »</li>
<li class="breadcrumb"><a href="development.html" >18. Appendix: Development Issues</a> »</li>
</ul>
</div>
</div>
<div class="small-print">
© Copyright 2012, Regents of the University of California.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.5.2.
</div>
</div>
</div>
</body>
</html>