<!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>Glossary — v2.1.0-beta</title>
<link rel="stylesheet" href="_static/dataone.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.1.0-beta',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/mathjax_pre.js"></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>
<script type="text/javascript" src="//cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML"></script>
<script type="text/javascript" src="_static/sidebar.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Change Log" href="changelog.html" />
<link rel="prev" title="About These Documents" href="about.html" />
<link media="only screen and (max-device-width: 480px)" href="_static/small_dataone.css" type= "text/css" rel="stylesheet" />
</head>
<body role="document">
<div class="version_notice">
<p>
<span class='bold'>Warning:</span> These documents are under active
development and subject to change (version 2.1.0-beta).<br />
The latest release documents are at:
<a href="https://purl.dataone.org/architecture">https://purl.dataone.org/architecture</a>
</p>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="changelog.html" title="Change Log"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="about.html" title="About These Documents"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html"></a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="glossary">
<h1>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h1>
<dl class="glossary docutils">
<dt id="term-api">API</dt>
<dd>Application Programming Interface. Software interacts with libraries,
applications, and systems through APIs they expose. See also <a class="reference internal" href="apis/index.html"><span class="doc">DataONE APIs</span></a>.</dd>
<dt id="term-archived">archived</dt>
<dd>Refers to a boolean property in System Metadata which when set to true,
indicates that the object is in an archived state. Conceptually, this
means that no further derivatives may be made from this object, it is at
the terminus of its version lineage. Technically, this means that the
object is removed from search indexes and the update method will fail
when applied to the object, other properties such as access control and
ownership information are unchanged. This is enforced by the
Coordinating Nodes and expected of Member Nodes. Compare with
<a class="reference internal" href="#term-obsoleted"><span class="xref std std-term">obsoleted</span></a>.</dd>
<dt id="term-authentication">authentication</dt>
<dd>Authentication is the process of verifying a claim made by a subject that
it should be allowed to act on behalf of a given principal (person,
computer, process, etc.). Authentication in DataONE is described in
<a class="reference internal" href="design/UseCases/12_uc.html"><span class="doc">Use Case 12 - User Authentication</span></a>.</dd>
<dt id="term-authoritative-member-node">Authoritative Member Node</dt>
<dd>Recorded in <a class="reference internal" href="#term-systemmetadata"><span class="xref std std-term">SystemMetadata</span></a> for an object, the Authoritative
Member Node has all the rights of the <a class="reference internal" href="#term-rightsholder"><span class="xref std std-term">rightsHolder</span></a> to maintain
and curate the object, including making any changes necessary.</dd>
<dt id="term-authorization">authorization</dt>
<dd>The process of verifying that a subject has permission to access specific
resources or perform specific actions. Authorization in DataONE is
described in <a class="reference internal" href="design/UseCases/13_uc.html"><span class="doc">Use Case 13 - User Authorization</span></a>.</dd>
<dt id="term-charset">charset</dt>
<dd>An element in system metadata that aligns with the <a href="#id1"><span class="problematic" id="id2">`IANA Character
Sets<IANA_CHARS>`_</span></a> specification. See <a class="reference internal" href="design/what_is_it.html"><span class="doc">What is This Thing?</span></a> for more
information.</dd>
<dt id="term-checksum">checksum</dt>
<dd>A string representing the computed hash of an object using an algorithm
supported by the DataONE infrastructure (MD5 or SHA-1). Checksums are
used to assist with the bit-level preservation of content.</dd>
<dt id="term-cicore">cicore<dt id="term-8">CICore</dt>
<dd>Refers to the essential, core components of the DataONE
cyberinfrastructure. This includes the <a class="reference internal" href="#term-member-node"><span class="xref std std-term">Member Node</span></a>s,
<a class="reference internal" href="#term-coordinating-node"><span class="xref std std-term">Coordinating Node</span></a>s, and the <a class="reference internal" href="#term-investigator-toolkit"><span class="xref std std-term">Investigator Toolkit</span></a>
components.</dd>
<dt id="term-cn">CN<dt id="term-coordinating-node">Coordinating Node<dt id="term-coordinating-nodes">Coordinating Nodes</dt>
<dd>One of at least three nodes in the DataONE cyberinfrastructure that is
responsible for maintaining a complete collection of all <a class="reference internal" href="#term-71"><span class="xref std std-term">science
metadata</span></a>, all <a class="reference internal" href="#term-80"><span class="xref std std-term">system metadata</span></a>, a record of the location of all
objects stored in the <a class="reference internal" href="#term-dataone"><span class="xref std std-term">DataONE</span></a> system, and provides mechanisms for
search and retrieval of all content. Coordinating Nodes store all
original copies of <a class="reference internal" href="#term-71"><span class="xref std std-term">science metadata</span></a>. All Coordinating Node
content is replicated between other Coordinating Nodes. Coordinating
Nodes drive the replication of content between Member Nodes.</dd>
<dt id="term-coordinating-node-replication">Coordinating Node Replication</dt>
<dd>Refers to the process by which content that appears on any one
Coordinating Node is mirrored to all other Coordinating Nodes. See also
<a class="reference internal" href="#term-member-node-synchronization"><span class="xref std std-term">Member Node synchronization</span></a> and <a class="reference internal" href="#term-data-replication"><span class="xref std std-term">data replication</span></a>.</dd>
<dt id="term-data">data<dt id="term-14">Data<dt id="term-data-object">data object<dt id="term-16">Data object</dt>
<dd>Typically refers to <a class="reference internal" href="#term-69"><span class="xref std std-term">science data</span></a>. Where ambiguity between the
science data and another form of data may be interpreted or implied, the
full term “science data” should be used.</dd>
<dt id="term-data-package">data package</dt>
<dd>A data package is a set of one or more <a class="reference internal" href="#term-14"><span class="xref std std-term">data</span></a> objects and
<a class="reference internal" href="#term-71"><span class="xref std std-term">science metadata</span></a> objects that together represent a scientifically
useful unit of information. Data packages are defined in DataONE using
<a class="reference internal" href="#term-resource-maps"><span class="xref std std-term">resource maps</span></a>.</dd>
<dt id="term-data-replication">data replication</dt>
<dd>The transfer of content between Member Nodes as directed by the
Coordinating Nodes. Also referred to as just “replication”.</dd>
<dt id="term-dataone">DataONE</dt>
<dd>An NSF sponsored project implementing cyberinfrastructure according to
guidelines indicated in the NSF <a class="reference external" href="http://www.nsf.gov/publications/pub_summ.jsp?WT.z_pims_id=503141&ods_key=nsf07601">DataNet RFP</a>.</dd>
<dt id="term-detail-code">detail code</dt>
<dd>Part of an exception that represents an error condition in the DataONE
APIs. The error detail code is specific to an API method and is intended
to be only useful to the implementors of the service that generates an
exception to help identify the location in the code where the exception
originated. See also <a class="reference internal" href="apis/Exceptions.html#module-Exceptions" title="Exceptions: Exceptions that are raised by MN, CN, and ITK software."><code class="xref py py-mod docutils literal"><span class="pre">Exceptions</span></code></a>.</dd>
<dt id="term-dn">DN<dt id="term-distinguished-name">Distinguished Name<dt id="term-x-509-distinguished-name">X.509 Distinguished Name</dt>
<dd><p class="first">TODO</p>
<p class="last">See also <a class="reference internal" href="#term-74"><span class="xref std std-term">Subject</span></a>.</p>
</dd>
<dt id="term-extension">extension</dt>
<dd>In the context of a <a class="reference internal" href="#term-23"><span class="xref std std-term">filename</span></a> or within
<a class="reference internal" href="apis/Types2.html#v2_0.Types.ObjectFormat" title="v2_0.Types.ObjectFormat"><code class="xref py py-class docutils literal"><span class="pre">v2_0.Types.ObjectFormat</span></code></a>. refers to the suffix of a filename
appearing after the final period (.) in the file name.</dd>
<dt id="term-filename">filename<dt id="term-23">fileName</dt>
<dd>The name of a file when save to file system media. See
<a class="reference internal" href="design/what_is_it.html"><span class="doc">What is This Thing?</span></a> for more information the use of fileName in
DataONE.</dd>
<dt id="term-formatid">formatId</dt>
<dd>An element in <a class="reference internal" href="#term-80"><span class="xref std std-term">System Metadata</span></a> that is used to indicate the type
of content represented by the digital object. The complete list of
formats can be retrieved through the <a class="reference internal" href="apis/CN_APIs.html#CNCore.listFormats" title="CNCore.listFormats"><code class="xref py py-func docutils literal"><span class="pre">CNCore.listFormats()</span></code></a>
operation.</dd>
<dt id="term-group">Group<dt id="term-26">group</dt>
<dd>Group represents metadata about a <a class="reference internal" href="#term-74"><span class="xref std std-term">Subject</span></a> that represents a
collection of other Subjects. Groups provide a convenient mechanism to
express access rules for certain roles that are not necessarily tied to
particular <a class="reference internal" href="#term-principals"><span class="xref std std-term">principals</span></a> over time.</dd>
<dt id="term-identifier">identifier<dt id="term-pid">pid<dt id="term-29">PID<dt id="term-primary-identifier">primary identifier<dt id="term-persistent-identifier">persistent identifier</dt>
<dd>Persistent Unique Identifier. A string of printable Unicode characters
that uniquely identifies an object within the DataONE infrastructure. See
<a class="reference internal" href="apis/Types.html#Types.Identifier" title="Types.Identifier"><code class="xref py py-class docutils literal"><span class="pre">Types.Identifier</span></code></a></dd>
<dt id="term-identity">identity</dt>
<dd>Refers to the properties of a user or <a class="reference internal" href="#term-principal"><span class="xref std std-term">principal</span></a> that enables the
DataONE system to distinguish them from other users.</dd>
<dt id="term-itk">ITK<dt id="term-investigator-toolkit">Investigator Toolkit</dt>
<dd>Software libraries, applications, and other tools that enable interaction
with the DataONE system, typically by enabling storage of content on a
Member Node and/or by enabling search and retrieval of content from the
DataONE infrastructure.</dd>
<dt id="term-mediatype">mediaType<dt id="term-media-type">media type<dt id="term-37">media-type</dt>
<dd>Formerly :term:MIME-type, an entry in the <a href="#id3"><span class="problematic" id="id4">`IANA Media Type<IANA_MEDIA>`_</span></a>
registry. Passed in the HTTP <em>Content-Type</em> header for HTTP GET and HEAD
responses to provide information about the resource for the consumer. See
<a class="reference internal" href="design/what_is_it.html"><span class="doc">What is This Thing?</span></a> for more information on it’s use in DataONE.</dd>
<dt id="term-metadata">metadata</dt>
<dd>Data describing data. There are currently two distinct forms of metadata
managed by DataONE, <a class="reference internal" href="#term-71"><span class="xref std std-term">science metadata</span></a> and <a class="reference internal" href="#term-80"><span class="xref std std-term">system metadata</span></a>.</dd>
<dt id="term-mime">MIME<dt id="term-mime-type">MIME-Type</dt>
<dd>Multipurpose Internet Mail Extensions Type. The preferred name is now
“media-type”.</dd>
<dt id="term-mn">MN<dt id="term-member-node">Member Node<dt id="term-member-nodes">Member Nodes</dt>
<dd>A data holding node that implements all or the essential elements of the
member mode <a class="reference internal" href="#term-api"><span class="xref std std-term">API</span></a>s (see <a class="reference internal" href="apis/MN_APIs.html"><span class="doc">Member Node APIs</span></a>). Member Nodes accept
content from users and may store content replicated from other member
nodes as directed by a Coordinating Node.</dd>
<dt id="term-node-event-log">node event log</dt>
<dd>The node event log is implemented on Coordinating Nodes and Member Nodes
and should record all object access and manipulation events.</dd>
<dt id="term-obsoleted">obsoleted</dt>
<dd>An object is in an obsoleted state when the obsoletedBy property of its
system metadata contains an entry to a newer revision of the object. The
system metadata of the newer object will contain an obsoletes entry in
its system metadata, which contains the PID of the obsoleted object. An
object may obsolete another object and be obsoleted as well, indicating
that the object has bother older and newer revisions of itself. Obsoleted
content will continue to be discoverable through the search index, though
not by default.</dd>
<dt id="term-origin-member-node">Origin Member Node</dt>
<dd>The <a class="reference internal" href="#term-member-node"><span class="xref std std-term">Member Node</span></a> where an object was first registered with the
DataONE infrastructure.</dd>
<dt id="term-principal">principal<dt id="term-principals">principals</dt>
<dd>A principal refers to the entity (e.g. a person) that is assigned one or
more <a class="reference internal" href="#term-subjects"><span class="xref std std-term">subjects</span></a>.</dd>
<dt id="term-public">Public<dt id="term-public-user">public user<dt id="term-54">Public User</dt>
<dd>The default user identity used when a service is called without supplying
user credentials. The public user SHOULD never have write access to any
services and MAY be limited access to some services in addition to the
usual restrictions imposed by access control. The public user
<a class="reference internal" href="#term-74"><span class="xref std std-term">subject</span></a> can be any of “Public”, “AuthenticatedUser”,
“VerifiedUser”.</dd>
<dt id="term-registry">Registry<dt id="term-node-registry">node registry<dt id="term-47">Node Registry</dt>
<dd>A list of nodes participating in DataONE maintained by Coordinating
Nodes. Entries in node registry may be retrieved through the
<a class="reference internal" href="apis/CN_APIs.html#CNCore.listNodes" title="CNCore.listNodes"><code class="xref py py-func docutils literal"><span class="pre">CNCore.listNodes()</span></code></a> method of a Coordinating Node.</dd>
<dt id="term-replication">replication</dt>
<dd>See <a class="reference internal" href="#term-coordinating-node-replication"><span class="xref std std-term">Coordinating Node replication</span></a> or <a class="reference internal" href="#term-data-replication"><span class="xref std std-term">data replication</span></a>.</dd>
<dt id="term-replication-target">replication target</dt>
<dd>A Member Node that can be directed by a Coordinating Node to retrieve
content from another Member node to support the process of
<a class="reference internal" href="#term-replication"><span class="xref std std-term">replication</span></a>.</dd>
<dt id="term-resource-map">resource map<dt id="term-resource-maps">resource maps<dt id="term-59">Resource map<dt id="term-60">Resource Map</dt>
<dd>An OAI-ORE RDF document serialized in RDF/XML format that is used to
indicate the relationships between <a class="reference internal" href="#term-14"><span class="xref std std-term">data</span></a> and <a class="reference internal" href="#term-71"><span class="xref std std-term">science
metadata</span></a> in a <a class="reference internal" href="#term-data-package"><span class="xref std std-term">data package</span></a>. Resource maps have the
<a class="reference internal" href="#term-formatid"><span class="xref std std-term">formatId</span></a> of <code class="docutils literal"><span class="pre">http://www.openarchives.org/ore/terms</span></code></dd>
<dt id="term-rightsholder">rightsHolder<dt id="term-rights-holder">Rights Holder</dt>
<dd>The <a class="reference internal" href="#term-74"><span class="xref std std-term">Subject</span></a> that has full control over the access control rules
for an object.</dd>
<dt id="term-science-data">science data<dt id="term-69">Science data</dt>
<dd>Science data that is stored in the DataONE system. See
<a class="reference internal" href="design/WhatIsData.html"><span class="doc">What is Data (DataONE Perspective)?</span></a> for a description of what is considered data in
DataONE. DataONE services always return exact copies of the original data
as submitted to DataONE.</dd>
<dt id="term-science-metadata">science metadata<dt id="term-71">Science metadata</dt>
<dd>Metadata that describes the data that is replicated across the Member
Nodes.</dd>
<dt id="term-session">session</dt>
<dd>In the context of DataONE, a session refers to the operations that occur
with a single authentication token.</dd>
<dt id="term-sid">SID<dt id="term-seriesid">seriesId<dt id="term-series-identifier">series identifier<dt id="term-66">Series Identifier</dt>
<dd>An identifier that may refer to multiple versions of an object. A Series
Identifier resolves to the latest revision of an object as indicated by the
obsolescence chain or other revision information. See the document
<a class="reference internal" href="design/PIDs.html"><span class="doc">Identifiers in DataONE</span></a> for more detail.</dd>
<dt id="term-subject">subject<dt id="term-subjects">subjects<dt id="term-74">Subject</dt>
<dd>Princpals (users) that are a recognized <a class="reference internal" href="#term-identity"><span class="xref std std-term">identity</span></a> in the DataONE
system.</dd>
<dt id="term-synchronized">synchronized<dt id="term-synchronization">synchronization<dt id="term-member-node-synchronization">Member Node synchronization</dt>
<dd>The process of updating a <a class="reference internal" href="#term-coordinating-node"><span class="xref std std-term">Coordinating Node</span></a> with the science and
system metadata that appears on a <a class="reference internal" href="#term-member-node"><span class="xref std std-term">Member Node</span></a>. Also referred to
as just “synchronization”.</dd>
<dt id="term-sysmeta">sysmeta<dt id="term-system-metadata">system metadata<dt id="term-80">System Metadata<dt id="term-systemmetadata">SystemMetadata</dt>
<dd>Metadata that is used internally by the DataONE system to record system
properties about each object stored in the DataONE system. See
<a class="reference internal" href="apis/Types.html#Types.SystemMetadata" title="Types.SystemMetadata"><code class="xref py py-class docutils literal"><span class="pre">Types.SystemMetadata</span></code></a> and <a class="reference internal" href="design/SystemMetadata.html#module-SystemMetadata" title="SystemMetadata"><code class="xref py py-mod docutils literal"><span class="pre">SystemMetadata</span></code></a>. Also referred to
as <a class="reference internal" href="#term-sysmeta"><span class="xref std std-term">sysmeta</span></a>.</dd>
<dt id="term-tier-1">tier 1<dt id="term-83">Tier 1</dt>
<dd>A Member Node that implements the minimal set of programming interfaces
and operates as a read only, public access repository.</dd>
<dt id="term-tier-4">tier 4<dt id="term-85">Tier 4</dt>
<dd>A Member Node that implements the full set of programming interfaces, and
so supports authenticated read and write, and the ability to accept
copies of content from other Member Nodes under the direction of a
Coordinating Node.</dd>
<dt id="term-token">token</dt>
<dd>An X509 certificate generated by a trusted authority and is used to
absolutely and unambiguously identify a <a class="reference internal" href="#term-principal"><span class="xref std std-term">principal</span></a>.</dd>
<dt id="term-verified">verified</dt>
<dd>A <a class="reference internal" href="#term-74"><span class="xref std std-term">Subject</span></a> is verified in DataONE after going through a process to
verify that the stated identity matches with an actual identity for the
subject.</dd>
<dt id="term-whitespace">whitespace</dt>
<dd>Characters that produce no visible output other than influencing the
spacing of other characters. For example the space character (ASCII 0x20)
and the tab character (ASCII 0x09) are whitespace characters.</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="http://dataone.org">
<img class="logo" src="_static/dataone_logo.png" alt="Logo"/>
</a></p><h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation Overview</a><ul>
<li>Previous: <a href="about.html" title="previous chapter">About These Documents</a></li>
<li>Next: <a href="changelog.html" title="next chapter">Change Log</a></li>
</ul></li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
<div id="copyright">
© Copyright <a href="http://www.dataone.org">2009-2017, DataONE</a>.
[ <a href="_sources/glossary.txt"
rel="nofollow">Page Source</a> |
<a href='https://redmine.dataone.org/projects/d1/repository/changes/documents/Projects/cicore/architecture/api-documentation/source/glossary.txt'
rel="nofollow">Revision History</a> ]
</div>
<div id="acknowledgement">
<p>This material is based upon work supported by the National Science Foundation
under Grant Numbers <a href="http://www.nsf.gov/awardsearch/showAward?AWD_ID=0830944">083094</a> and <a href="http://www.nsf.gov/awardsearch/showAward?AWD_ID=1430508">1430508</a>.</p>
<p>Any opinions, findings, and conclusions or recommendations expressed in this
material are those of the author(s) and do not necessarily reflect the views
of the National Science Foundation.</p>
</div>
</div>
<!--
<hr />
<div id="HCB_comment_box"><a href="http://www.htmlcommentbox.com">HTML Comment Box</a> is loading comments...</div>
<link rel="stylesheet" type="text/css" href="_static/skin.css" />
<script type="text/javascript" language="javascript" id="hcb">
/*<! -*/
(function()
{s=document.createElement("script");
s.setAttribute("type","text/javascript");
s.setAttribute("src", "http://www.htmlcommentbox.com/jread?page="+escape((typeof hcb_user !== "undefined" && hcb_user.PAGE)||(""+window.location)).replace("+","%2B")+"&mod=%241%24wq1rdBcg%24Gg8J5iYSHJWwAJtlYu/yU."+"&opts=21407&num=10");
if (typeof s!="undefined") document.getElementsByTagName("head")[0].appendChild(s);})();
/* ->*/
</script>
-->
</body>
</html>