"Fossies" - the Fresh Open Source Software Archive

Member "geoserver-2.18.1/user/community/metadata/advanced.html" (19 Nov 2020, 19210 Bytes) of package /linux/www/geoserver-2.18.1-htmldoc.zip:


The requested HTML page contains a <FORM> tag that is unusable on "Fossies" in "automatic" (rendered) mode so that page is shown as HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US" xml:lang="en-US">
    4 <head>
    5   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    6   
    7   <title>Advanced Configuration &mdash; GeoServer 2.18.1 User Manual</title>
    8   <link rel="stylesheet" href="../../_static/blueprint/screen.css" type="text/css" media="screen, projection" />
    9   <link rel="stylesheet" href="../../_static/blueprint/print.css" type="text/css" media="print" /> 
   10   <!--[if IE]>
   11   <link rel="stylesheet" href="../../_static/blueprint/ie.css" type="text/css" media="screen, projection" />
   12   <![endif]-->
   13   <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
   14   <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
   15   <script type="text/javascript">
   16     var DOCUMENTATION_OPTIONS = {
   17         URL_ROOT:    '../../',
   18         VERSION:     '2.18.1',
   19         COLLAPSE_MODINDEX: false,
   20         FILE_SUFFIX: '.html'
   21     };
   22   </script>
   23   <script type="text/javascript" src="../../_static/jquery.js"></script>
   24   <script type="text/javascript" src="../../_static/doctools.js"></script>
   25   <script type="text/javascript" src="../../_static/searchtools.js"></script>
   26   <script type="text/javascript" src="../../searchindex.js"></script>
   27   <link rel="shortcut icon" href="../../_static/geoserver.ico"/>
   28       <link rel="search" title="Search" href="../../search.html" />
   29       <link rel="top" title="GeoServer 2.18.1 User Manual" href="../../index.html" />
   30       <link rel="up" title="Metadata" href="index.html" />
   31       <link rel="next" title="User Guide" href="user.html" />
   32       <link rel="prev" title="Fields configuration" href="uiconfiguration.html" />
   33 </head>
   34 <body class="community/metadata/advanced">
   35   <div id="header" class="selfclear">
   36     <div class="wrap selfclear">
   37       <div id="logo"><a href="../../index.html">GeoServer 2.18.1 User Manual</a></div>
   38       <ul id="top-nav">
   39         <li class="first"><a href="http://geoserver.org/about">About</a></li>
   40         <li><a href="http://blog.geoserver.org/">Blog</a></li>
   41         <li><a href="http://geoserver.org/download">Download</a></li>
   42         <!--<li><a href="../../index.html">Documentation</a></li>-->
   43       </ul>
   44         <form id="quick-search" action="../../search.html" method="get">
   45           <fieldset>
   46             <input type="hidden" name="check_keywords" value="yes" />
   47             <input type="hidden" name="area" value="default" />
   48             <input id="quick-search-query" type="text" name="q" accessKey="q" name="searchQuery.queryString" size="25" value="Search Documentation&hellip;" size="20" tabindex="3" onblur="if(this.value=='') this.value='Search Documentation&hellip;';" onfocus="if(this.value=='Search Documentation&hellip;') this.value='';" />
   49             <input id="quick-search-submit" type="image" value="Search" src="../../_static/chrome/search_icon_green.png" />
   50           </fieldset>
   51         </form>
   52     </div><!-- /.wrap -->
   53   </div><!-- /#header -->
   54   <div id="main">
   55     <div class="wrap selfclear">
   56       <div id="content-left" class="content-border"></div>
   57       <div id="content">
   58 <ul id="breadcrumbs">
   59   
   60   <li><a href="../../index.html">GeoServer 2.18.1 User Manual</a> &raquo;</li>
   61   <li><a href="../index.html" accesskey="U">Community modules</a> &raquo;</li>
   62   <li><a href="index.html" accesskey="U">Metadata</a> &raquo;</li>
   63   <li>Advanced Configuration</li>
   64 </ul>
   65 <ul id="relatedlinks" class="selfclear">
   66   <li class="first">
   67     <a href="../../py-modindex.html" title="Python Module Index"
   68        accesskey="">modules</a></li>
   69   <li>
   70     <a href="user.html" title="User Guide"
   71        accesskey="N">next</a>|</li>
   72   <li>
   73     <a href="uiconfiguration.html" title="Fields configuration"
   74        accesskey="P">previous</a>|</li>
   75 </ul>
   76         
   77   <blockquote>
   78 <div></div></blockquote>
   79 <div class="section" id="advanced-configuration">
   80 <span id="community-metadata-advanced-configuration"></span><h1>Advanced Configuration<a class="headerlink" href="#advanced-configuration" title="Permalink to this headline"></a></h1>
   81 <div class="contents local topic" id="contents">
   82 <ul class="simple">
   83 <li><p><a class="reference internal" href="#import-from-geonetwork" id="id1">Import from Geonetwork</a></p></li>
   84 <li><p><a class="reference internal" href="#custom-to-native-mapping" id="id2">Custom to Native Mapping</a></p></li>
   85 </ul>
   86 </div>
   87 <div class="section" id="import-from-geonetwork">
   88 <h2><a class="toc-backref" href="#id1">Import from Geonetwork</a><a class="headerlink" href="#import-from-geonetwork" title="Permalink to this headline"></a></h2>
   89 <p>The <span class="guilabel">Import from Geonetwork</span> option allows the user to import existing metadata from <a class="reference external" href="https://geonetwork-opensource.org//">GeoNetwork</a>.
   90 Two confurations are needed for the import to work:</p>
   91 <blockquote>
   92 <div><ul class="simple">
   93 <li><p><strong>geonetworks:</strong> configure a list geonetwork endpoints</p></li>
   94 <li><p><strong>geonetworkmapping:</strong> define the mapping between the geonetwork fields and the fields configured in the metadata module.</p></li>
   95 </ul>
   96 </div></blockquote>
   97 <p>The configuration can be added to the same <a class="reference external" href="https://yaml.org/">yaml</a> file as the UI configuration or it can be put in a separate file.</p>
   98 <div class="section" id="geonetwork-endpoint-configuration">
   99 <h3>Geonetwork endpoint configuration<a class="headerlink" href="#geonetwork-endpoint-configuration" title="Permalink to this headline"></a></h3>
  100 <p>The example will configure 2 endpoints.</p>
  101 <div class="highlight-YAML notranslate"><div class="highlight"><pre><span></span><span class="nt">geonetworks</span><span class="p">:</span>
  102     <span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Geonetwork DOV production</span>
  103       <span class="nt">url</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://www.dov.vlaanderen.be/geonetwork/srv/api/records/${UUID}/formatters/xml?attachment=true</span>
  104     <span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Geonetwork test</span>
  105       <span class="nt">url</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://geonetwork-opensource.org/test/srv/api/records/${UUID}/formatters/xml?attachment=true</span>
  106 </pre></div>
  107 </div>
  108 <table class="docutils align-default">
  109 <colgroup>
  110 <col style="width: 11%" />
  111 <col style="width: 6%" />
  112 <col style="width: 83%" />
  113 </colgroup>
  114 <thead>
  115 <tr class="row-odd"><th class="head"><p>Key</p></th>
  116 <th class="head"><p>Required</p></th>
  117 <th class="head"><p>Description</p></th>
  118 </tr>
  119 </thead>
  120 <tbody>
  121 <tr class="row-even"><td><p><strong>name</strong></p></td>
  122 <td><p>yes</p></td>
  123 <td><p>The name of the Geonetwork endpoint that will be shown in the dropdown.</p></td>
  124 </tr>
  125 <tr class="row-odd"><td><p><strong>url</strong></p></td>
  126 <td><p>yes</p></td>
  127 <td><p>The url of the XML export of the metadata in the Geonetwork, where <code class="docutils literal notranslate"><span class="pre">${UUID}</span></code> will be replaced by the metadata’s UUID.</p></td>
  128 </tr>
  129 </tbody>
  130 </table>
  131 </div>
  132 <div class="section" id="geonetwork-mapping-configuration">
  133 <h3>Geonetwork mapping configuration<a class="headerlink" href="#geonetwork-mapping-configuration" title="Permalink to this headline"></a></h3>
  134 <p>Each field from Geonetwork can be mapped to a native field from GeoServer or a field from the metadata module.
  135 The configuration for simple components are added under the yaml attribute <cite>geonetworkmapping</cite>.
  136 The fields of the type <code class="docutils literal notranslate"><span class="pre">COMPLEX</span></code> are mapped under the attribute  <cite>objectmapping</cite>.</p>
  137 <p>The example will map one field (UUID) from the geonetwork xml to UI.</p>
  138 <div class="highlight-YAML notranslate"><div class="highlight"><pre><span></span><span class="nt">geonetworkmapping</span><span class="p">:</span>
  139     <span class="p p-Indicator">-</span>  <span class="nt">geoserver</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">metadata-identifier</span>
  140        <span class="nt">geonetwork</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">//gmd:fileIdentifier/gco:CharacterString/text()</span>
  141 </pre></div>
  142 </div>
  143 <p>A complex object is mapped in the following example:</p>
  144 <div class="highlight-YAML notranslate"><div class="highlight"><pre><span></span><span class="nt">objectmapping</span><span class="p">:</span>
  145     <span class="p p-Indicator">-</span> <span class="nt">typename</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">responsible-party</span>
  146       <span class="nt">mapping</span><span class="p">:</span>
  147         <span class="p p-Indicator">-</span> <span class="nt">geoserver</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">organisation</span>
  148           <span class="nt">geonetwork</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">.//gmd:CI_ResponsibleParty/gmd:organisationName/gco:CharacterString/text()</span>
  149         <span class="p p-Indicator">-</span> <span class="nt">geoserver</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">contactinfo</span>
  150           <span class="nt">geonetwork</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">.//gmd:CI_ResponsibleParty/gmd:contactInfo</span>
  151         <span class="p p-Indicator">-</span> <span class="nt">geoserver</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">role</span>
  152           <span class="nt">geonetwork</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">.//gmd:CI_ResponsibleParty/gmd:role/gmd:CI_RoleCode/@codeListValue</span>
  153 </pre></div>
  154 </div>
  155 <p>Metadata from geonetwork can also be mapped to native fields. Do this by setting the <cite>mappingType</cite> to <code class="docutils literal notranslate"><span class="pre">NATIVE</span></code></p>
  156 <div class="highlight-YAML notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span>  <span class="nt">geoserver</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">title</span>
  157    <span class="nt">geonetwork</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">//gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:title/gco:CharacterString/text()</span>
  158    <span class="nt">mappingType</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">NATIVE</span>
  159 <span class="p p-Indicator">-</span>  <span class="nt">geoserver</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">alias</span>
  160    <span class="nt">geonetwork</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">//gmd:identificationInfo/gmd:MD_DataIdentification/gmd:citation/gmd:CI_Citation/gmd:alternateTitle/gco:CharacterString/text()</span>
  161    <span class="nt">mappingType</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">NATIVE</span>
  162 </pre></div>
  163 </div>
  164 <table class="docutils align-default">
  165 <colgroup>
  166 <col style="width: 10%" />
  167 <col style="width: 5%" />
  168 <col style="width: 85%" />
  169 </colgroup>
  170 <thead>
  171 <tr class="row-odd"><th class="head"><p>Key</p></th>
  172 <th class="head"><p>Required</p></th>
  173 <th class="head"><p>Description</p></th>
  174 </tr>
  175 </thead>
  176 <tbody>
  177 <tr class="row-even"><td><p><strong>geoserver</strong></p></td>
  178 <td><p>yes</p></td>
  179 <td><p>the key for the attributes in geoserver</p></td>
  180 </tr>
  181 <tr class="row-odd"><td><p><strong>geonetwork</strong></p></td>
  182 <td><p>yes</p></td>
  183 <td><p>The <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/XPath">xpath</a> expression pointing to the content from the geonetwork metadata xml file.</p></td>
  184 </tr>
  185 <tr class="row-even"><td><p><strong>mappingType:</strong></p></td>
  186 <td><p>no</p></td>
  187 <td><div class="line-block">
  188 <div class="line">CUSTOM (default; map to fields from the metadata module configuration)</div>
  189 <div class="line">NATIVE (map to geoserver native fields)</div>
  190 </div>
  191 </td>
  192 </tr>
  193 </tbody>
  194 </table>
  195 </div>
  196 </div>
  197 <div class="section" id="custom-to-native-mapping">
  198 <span id="community-metadata-advanced-configuration-custom-native"></span><h2><a class="toc-backref" href="#id2">Custom to Native Mapping</a><a class="headerlink" href="#custom-to-native-mapping" title="Permalink to this headline"></a></h2>
  199 <p>Sometimes your custom metadata configuration may contain a more complex version of fields already present in geoserver native metadata,
  200 or you may want to derive geoserver native fields (such as URL’s, keywords, etcetera) from information in your custom metadata. Native fields
  201 are used by <code class="docutils literal notranslate"><span class="pre">GetCapabilities</span></code> requests, and you want to avoid filling in the same information twice. We can automatise deriving these
  202 native fields from custom fields using a custom-to-native mapping configuration. For example in the following configuration:</p>
  203 <div class="highlight-YAML notranslate"><div class="highlight"><pre><span></span><span class="nt">customNativeMappings</span><span class="p">:</span>
  204   <span class="p p-Indicator">-</span> <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">KEYWORDS</span>
  205     <span class="nt">mapping</span><span class="p">:</span>
  206       <span class="nt">value</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">KEY_${keywords/name}</span>
  207       <span class="nt">vocabulary</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">${keywords/vocabulary}</span>
  208   <span class="p p-Indicator">-</span> <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">IDENTIFIERS</span>
  209     <span class="nt">mapping</span><span class="p">:</span>
  210       <span class="nt">value</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">${identifiers/id}</span>
  211       <span class="nt">authority</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">${identifiers/authority}</span>
  212   <span class="p p-Indicator">-</span> <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">METADATALINKS</span>
  213     <span class="nt">mapping</span><span class="p">:</span>
  214       <span class="nt">value</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://my-host/geonetwork/?uuid=${uuid}</span>
  215       <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">text/html</span>
  216       <span class="nt">metadataType</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ISO191156:2003</span>
  217   <span class="p p-Indicator">-</span> <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">METADATALINKS</span>
  218     <span class="nt">mapping</span><span class="p">:</span>
  219       <span class="nt">value</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">https://my-host/geonetwork/srv/nl/csw?Service=CSW&amp;Request=GetRecordById&amp;Version=2.0.2&amp;outputSchema=http://www.isotc211.org/2005/gmd&amp;elementSetName=full&amp;id=${uuid}</span>
  220       <span class="nt">type</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">text/xml</span>
  221       <span class="nt">metadataType</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ISO191156:2003</span>
  222 </pre></div>
  223 </div>
  224 <table class="docutils align-default">
  225 <colgroup>
  226 <col style="width: 8%" />
  227 <col style="width: 4%" />
  228 <col style="width: 88%" />
  229 </colgroup>
  230 <thead>
  231 <tr class="row-odd"><th class="head"><p>Key</p></th>
  232 <th class="head"><p>Required</p></th>
  233 <th class="head"><p>Description</p></th>
  234 </tr>
  235 </thead>
  236 <tbody>
  237 <tr class="row-even"><td><p><strong>type</strong></p></td>
  238 <td><p>yes</p></td>
  239 <td><p>currently supported: KEYWORDS, IDENTIFIERS, METADATALINKS</p></td>
  240 </tr>
  241 <tr class="row-odd"><td><p><strong>mapping</strong></p></td>
  242 <td><p>yes</p></td>
  243 <td><div class="line-block">
  244 <div class="line">List of key to value pairs. Value contains a literal with or without placeholder that contains custom attribute path (the <code class="docutils literal notranslate"><span class="pre">/</span></code> symbol denoting subfields inside complex fields).</div>
  245 <div class="line">Possible keys for KEYWORDS: value, vocabulary</div>
  246 <div class="line">Possible keys for METADATALINKS: value, type, metadataType, about</div>
  247 <div class="line">Possible keys for IDENTIFIERS: value, authority</div>
  248 </div>
  249 </td>
  250 </tr>
  251 </tbody>
  252 </table>
  253 <p>The synchronisation of the metadata takes place each time a layer is saved. Any information that has been entered by the user in mapped native fields via the GUI will be lost.</p>
  254 </div>
  255 </div>
  256 
  257 
  258       <div class="selfclear pagination-nav">
  259           <div class="leftwise"><strong>Previous</strong>: <a href="uiconfiguration.html" title="previous chapter">Fields configuration</a></div>
  260           <div class="rightwise"><strong>Next</strong>: <a href="user.html" title="next chapter">User Guide</a></div>
  261       </div>
  262       </div><!-- /#content> -->
  263       <div id="content-right" class="content-border"></div>
  264   <div id="sidebar" class="contrast">
  265       <div id="toc" class="section">
  266         <h3 class="pngfix">Table Of Contents</h3>
  267         <ul>
  268 <li><a class="reference internal" href="#">Advanced Configuration</a><ul>
  269 <li><a class="reference internal" href="#import-from-geonetwork">Import from Geonetwork</a><ul>
  270 <li><a class="reference internal" href="#geonetwork-endpoint-configuration">Geonetwork endpoint configuration</a></li>
  271 <li><a class="reference internal" href="#geonetwork-mapping-configuration">Geonetwork mapping configuration</a></li>
  272 </ul>
  273 </li>
  274 <li><a class="reference internal" href="#custom-to-native-mapping">Custom to Native Mapping</a></li>
  275 </ul>
  276 </li>
  277 </ul>
  278 
  279         <div class="section-footer"></div>
  280       </div>
  281         <div class="section">
  282           <h3>Continue Reading</h3>
  283           <ul>
  284             <li>Previous: <a href="uiconfiguration.html" title="previous chapter">Fields configuration</a></li>
  285             <li>Next: <a href="user.html" title="next chapter">User Guide</a></li>
  286           </ul>
  287         </div>
  288         <div class="section">
  289         <h3>This Page</h3>
  290         <ul class="this-page-menu">
  291                 
  292         <li><a href="https://github.com/geoserver/geoserver/tree/master/doc/en/user/source/community/metadata/advanced.rst">Edit</a></li>
  293         </ul>
  294         </div>
  295   </div><!-- /#sidebar -->
  296   </div><!-- /.wrap> -->
  297 </div><!-- /#main -->
  298 <div id="footer">
  299   <div class="wrap">
  300     &copy; Copyright 2020, Open Source Geospatial Foundation. License <a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution</a>.
  301     Last updated on Nov 19, 2020.
  302     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
  303   </div><!-- /.wrap> -->
  304 </div><!-- /#footer -->
  305   </body>
  306 </html>