<!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>Metacat Administrator’s Guide — Metacat 2.19.0 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.19.0',
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.19.0 documentation" href="#" />
<link rel="next" title="1. Introduction" href="intro.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="intro.html" title="1. Introduction"
accesskey="N">next</a>
</li>
<li class="breadcrumb first"><a href="#">Metacat 2.19.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="metacat-administrator-s-guide">
<h1>Metacat Administrator’s Guide<a class="headerlink" href="#metacat-administrator-s-guide" title="Permalink to this headline">¶</a></h1>
<div class="sidebar">
<p class="first sidebar-title">Version: 2.19.0</p>
<a class="reference internal image-reference" href="_images/metacat-logo-darkgray.png"><img alt="_images/metacat-logo-darkgray.png" src="_images/metacat-logo-darkgray.png" style="height: 130pt;" /></a>
<dl class="docutils">
<dt>Send feedback and bugs to:</dt>
<dd><ul class="first last simple">
<li><a class="reference external" href="mailto:metacat-dev%40ecoinformatics.org">metacat-dev<span>@</span>ecoinformatics<span>.</span>org</a></li>
<li><a class="reference external" href="http://bugzilla.ecoinformatics.org">http://bugzilla.ecoinformatics.org</a></li>
</ul>
</dd>
</dl>
<p>License: GPL</p>
<p class="last">Release Date: June, 2023</p>
</div>
<p>Metacat is a repository for data and metadata (documentation about data) that helps
scientists find, understand and effectively use data sets they manage or that
have been created by others. Thousands of data sets are currently documented in
a standardized way and stored in Metacat systems, providing the scientific
community with a broad range of science data that–because the data are well and
consistently described–can be easily searched, compared, merged, or used
in other ways.</p>
<p><span class="note2">Note:</span></p>
<p>An external Solr HTTP server is required as of Metacat version 2.13.0. You should add the <code class="docutils literal"><span class="pre">tomcat8</span></code> user to the <code class="docutils literal"><span class="pre">solr</span></code> group and the <code class="docutils literal"><span class="pre">solr</span></code> user to the <code class="docutils literal"><span class="pre">tomcat8</span></code> group in order to avoid the file permission issues. The details can be found on the <a class="reference external" href="./install.html#solr-server">Solr Server</a> part of the installation page.</p>
<p>If this is the first time you have installed an external Solr server, you need to re-index all existing objects in the Metacat instance. The instruction can be found on the <a class="reference external" href="./query-index.html#regenerating-the-index">Regenerating The Index</a> part of the Metacat indexing page.</p>
<ul>
<li><p class="first">Download Metacat</p>
<blockquote>
<div><ul class="simple">
<li><dl class="first docutils">
<dt>Binary Distribution (A war file installation)</dt>
<dd><ul class="first last">
<li>GZIP File: <a href="https://knb.ecoinformatics.org/software/dist/metacat-bin-2.19.0.tar.gz">metacat-bin-2.19.0.tar.gz</a></li>
<li>ZIP File: <a href="https://knb.ecoinformatics.org/software/dist/metacat-bin-2.19.0.zip">metacat-bin-2.19.0.zip</a></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Source Distribution (Full source, requiring build)</dt>
<dd><ul class="first last">
<li>GZIP File: <a href="https://knb.ecoinformatics.org/software/dist/metacat-src-2.19.0.tar.gz">metacat-src-2.19.0.tar.gz</a></li>
<li>ZIP File: <a href="https://knb.ecoinformatics.org/software/dist/metacat-src-2.19.0.zip">metacat-src-2.19.0.zip</a></li>
</ul>
</dd>
</dl>
</li>
<li><a class="reference external" href="https://knb.ecoinformatics.org/software/dist/">Older versions</a></li>
</ul>
</div></blockquote>
</li>
</ul>
<ul class="simple">
<li>For Developers: Metacat <a class="reference external" href="./api/index.html">API documentation</a></li>
</ul>
</div>
<div class="section" id="contents">
<h1>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#what-s-in-this-guide">1.1. What’s in this Guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#metacat-features">1.2. Metacat Features</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributors.html">2. Contributors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributors.html#id1">2.1. Contributors</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributors.html#patch-contributors">2.2. Patch contributors</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">3. License</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">4. Downloading and Installing Metacat</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#system-requirements">4.1. System Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-on-linux">4.2. Installing on Linux</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">5. Configuring Metacat</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#initial-configuration">5.1. Initial Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#logging-in-to-metacat">5.2. Logging in to Metacat</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#required-configuration">5.3. Required Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#additional-configuration">5.4. Additional Configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dataone.html">6. DataONE Member Node Support</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dataone.html#what-is-dataone">6.1. What is DataONE?</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataone.html#the-dataone-service-interface">6.2. The DataONE Service Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataone.html#member-nodes">6.3. Member Nodes</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataone.html#coordinating-nodes">6.4. Coordinating Nodes</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataone.html#investigator-toolkit">6.5. Investigator Toolkit</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataone.html#configuring-metacat-as-a-member-node">6.6. Configuring Metacat as a Member Node</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataone.html#access-control-policies">6.7. Access Control Policies</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataone.html#configuration-as-a-replication-target">6.8. Configuration as a replication target</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataone.html#object-replication-policies">6.9. Object Replication Policies</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataone.html#generating-dataone-system-metadata">6.10. Generating DataONE System Metadata</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataone.html#apache-configuration-details">6.11. Apache configuration details</a></li>
<li class="toctree-l2"><a class="reference internal" href="dataone.html#configure-tomcat-to-allow-dataone-identifiers">6.12. Configure Tomcat to allow DataONE identifiers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="submitting.html">7. Accessing and Submitting Metadata and Data</a><ul>
<li class="toctree-l2"><a class="reference internal" href="submitting.html#a-brief-note-about-how-information-is-stored">7.1. A Brief Note about How Information is Stored</a></li>
<li class="toctree-l2"><a class="reference internal" href="submitting.html#using-the-registry">7.2. Using the Registry</a></li>
<li class="toctree-l2"><a class="reference internal" href="submitting.html#using-html-forms-the-http-interface">7.3. Using HTML Forms (the HTTP Interface)</a></li>
<li class="toctree-l2"><a class="reference internal" href="submitting.html#using-the-earthgrid-api-aka-ecogrid">7.4. Using the EarthGrid API (aka EcoGrid)</a></li>
<li class="toctree-l2"><a class="reference internal" href="submitting.html#using-morpho">7.5. Using Morpho</a></li>
<li class="toctree-l2"><a class="reference internal" href="submitting.html#creating-your-own-client">7.6. Creating Your Own Client</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="query-index.html">8. Metacat Indexing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="query-index.html#indexed-documents-and-fields">8.1. Indexed documents and fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="query-index.html#default-indexed-fields">8.2. Default indexed fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="query-index.html#index-configuration">8.3. Index configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="query-index.html#adding-additional-document-types-and-fields">8.4. Adding additional document types and fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="query-index.html#querying-the-index">8.5. Querying the index</a></li>
<li class="toctree-l2"><a class="reference internal" href="query-index.html#access-policy-enforcement">8.6. Access Policy enforcement</a></li>
<li class="toctree-l2"><a class="reference internal" href="query-index.html#regenerating-the-index">8.7. Regenerating the index</a></li>
<li class="toctree-l2"><a class="reference internal" href="query-index.html#class-design-overview">8.8. Class design overview</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="themes.html">9. Modifying and Creating Themes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="themes.html#quick-start-using-the-default-theme">9.1. Quick Start Using the Default Theme</a></li>
<li class="toctree-l2"><a class="reference internal" href="themes.html#creating-a-custom-theme">9.2. Creating a Custom Theme</a></li>
<li class="toctree-l2"><a class="reference internal" href="themes.html#using-custom-endpoints">9.3. Using Custom Endpoints</a></li>
<li class="toctree-l2"><a class="reference internal" href="themes.html#creating-a-custom-skin">9.4. Creating a Custom Skin</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="authinterface.html">10. Metacat Authentication Mechanism</a><ul>
<li class="toctree-l2"><a class="reference internal" href="authinterface.html#file-based-authentication">10.1. File-Based Authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="authinterface.html#utility-for-password-file-based-authentication">10.2. Utility for Password File Based Authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="authinterface.html#ldap-based-authentication">10.3. LDAP-Based Authentication</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="geoserver.html">11. Metacat’s Use of Geoserver</a><ul>
<li class="toctree-l2"><a class="reference internal" href="geoserver.html#installing-and-configuring">11.1. Installing and Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="geoserver.html#spatial-queries">11.2. Spatial Queries</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="replication.html">12. Replication</a><ul>
<li class="toctree-l2"><a class="reference internal" href="replication.html#configuring-replication">12.1. Configuring Replication</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="harvester.html">13. Harvester and Harvest List Editor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="harvester.html#configuring-harvester">13.1. Configuring Harvester</a></li>
<li class="toctree-l2"><a class="reference internal" href="harvester.html#harvester-properties-and-their-functions">13.2. Harvester Properties and their Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="harvester.html#configuring-a-harvest-site-instructions-for-site-contact">13.3. Configuring a Harvest Site (Instructions for Site Contact)</a></li>
<li class="toctree-l2"><a class="reference internal" href="harvester.html#running-harvester">13.4. Running Harvester</a></li>
<li class="toctree-l2"><a class="reference internal" href="harvester.html#reviewing-harvest-reports">13.5. Reviewing Harvest Reports</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="oaipmh.html">14. OAI Protocol for Metadata Harvesting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="oaipmh.html#eml-and-dublin-core">14.1. EML and Dublin Core</a></li>
<li class="toctree-l2"><a class="reference internal" href="oaipmh.html#metacat-oai-pmh-service-interfaces">14.2. Metacat OAI-PMH Service Interfaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="oaipmh.html#configuring-and-running-metacat-oai-pmh">14.3. Configuring and Running Metacat OAI-PMH</a></li>
<li class="toctree-l2"><a class="reference internal" href="oaipmh.html#oai-pmh-error-codes">14.4. OAI-PMH Error Codes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="event-logging.html">15. Event Logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="sitemaps.html">16. Enabling Web Searches: Sitemaps</a><ul>
<li class="toctree-l2"><a class="reference internal" href="sitemaps.html#configuration">16.1. Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="sitemaps.html#creating-a-sitemap">16.2. Creating a Sitemap</a></li>
<li class="toctree-l2"><a class="reference internal" href="sitemaps.html#serving-your-sitemaps">16.3. Serving Your Sitemaps</a></li>
<li class="toctree-l2"><a class="reference internal" href="sitemaps.html#registering-a-sitemap">16.4. Registering a Sitemap</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="metacat-properties.html">17. Appendix: Metacat Properties</a><ul>
<li class="toctree-l2"><a class="reference internal" href="metacat-properties.html#server-properties">17.1. Server Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="metacat-properties.html#application-properties">17.2. Application Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="metacat-properties.html#solr-properties">17.3. Solr Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="metacat-properties.html#database-properties">17.4. Database Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="metacat-properties.html#authorization-and-authentication-properties">17.5. Authorization and Authentication Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="metacat-properties.html#xml-eml-properties">17.6. XML/EML Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="metacat-properties.html#data-manager-properties">17.7. Data Manager Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="metacat-properties.html#id1">17.8. EZID Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="metacat-properties.html#sitemap-properties">17.9. Sitemap Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="metacat-properties.html#additional-properties">17.10. Additional Properties</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="development.html">18. Appendix: Development Issues</a><ul>
<li class="toctree-l2"><a class="reference internal" href="identifiers.html">18.1. Identifier Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="doi.html">18.2. DOI Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="statistics-service.html">18.3. Metacat Usage Statistics Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="ore-model-expansion.html">18.4. ORE Model for Derived Data Packages</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</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="intro.html" title="1. Introduction"
>next</a>
</li>
<li class="breadcrumb first"><a href="#">Metacat 2.19.0 documentation</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.6.7.
</div>
</div>
</div>
</body>
</html>