"Fossies" - the Fresh Open Source Software Archive

Member "user/services/wps/administration.html" (22 Nov 2019, 12015 Bytes) of package /linux/www/geoserver-2.16.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>WPS Service page &mdash; GeoServer 2.16.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.16.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.16.1 User Manual" href="../../index.html" />
   30       <link rel="up" title="Web Processing Service (WPS)" href="index.html" />
   31       <link rel="next" title="WPS Security and input limits" href="security.html" />
   32       <link rel="prev" title="WPS Operations" href="operations.html" />
   33 </head>
   34 <body class="services/wps/administration">
   35   <div id="header" class="selfclear">
   36     <div class="wrap selfclear">
   37       <div id="logo"><a href="../../index.html">GeoServer 2.16.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.16.1 User Manual</a> &raquo;</li>
   61   <li><a href="../index.html" accesskey="U">Services</a> &raquo;</li>
   62   <li><a href="index.html" accesskey="U">Web Processing Service (WPS)</a> &raquo;</li>
   63   <li>WPS Service page</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="security.html" title="WPS Security and input limits"
   71        accesskey="N">next</a>|</li>
   72   <li>
   73     <a href="operations.html" title="WPS Operations"
   74        accesskey="P">previous</a>|</li>
   75 </ul>
   76         
   77   <div class="section" id="wps-service-page">
   78 <span id="webadmin-wps"></span><h1>WPS Service page<a class="headerlink" href="#wps-service-page" title="Permalink to this headline"></a></h1>
   79 <p>The Web Processing Service (WPS) page supports the basic metadata for the service, as well as
   80 service specific settings</p>
   81 <div class="section" id="service-metadata">
   82 <h2>Service Metadata<a class="headerlink" href="#service-metadata" title="Permalink to this headline"></a></h2>
   83 <p>The service metadata section is common among all services. See the section on <a class="reference internal" href="../wcs/webadmin.html#service-metadata"><span class="std std-ref">Service Metadata</span></a>.</p>
   84 <div class="figure align-center">
   85 <img alt="../../_images/metadata.png" src="../../_images/metadata.png" />
   86 </div>
   87 </div>
   88 <div class="section" id="execution-and-resource-management-options">
   89 <h2>Execution and resource management options<a class="headerlink" href="#execution-and-resource-management-options" title="Permalink to this headline"></a></h2>
   90 <div class="figure align-center">
   91 <img alt="../../_images/execution.png" src="../../_images/execution.png" />
   92 </div>
   93 <p>Execution settings:</p>
   94 <blockquote>
   95 <div><ul class="simple">
   96 <li><em>Connection timeout</em>: the number of seconds the WPS will wait before giving up on a remote HTTP connection used to retrieve complex inputs</li>
   97 <li><em>Maximum synchronous executions run parallel</em>: the maximum number of synchronous processes that will run in parallel at a given time. The others will be queued.</li>
   98 <li><em>Maximum execution time for synchronous requests</em>: the maximum time a synchronous process is allowed executing. Processes running in synchronous mode will have to complete execution within the set time limit, or they will be dismissed automatically. These requests have the client waiting for a response on a HTTP connection, so choose a relatively short time (e.g., 60 seconds)</li>
   99 <li><em>Maximum queue and execution time for synchronous requests</em>: the maximum time a process is allowed in the queue and executing. Processes running in synchronous mode will have to complete within the set time limit, or they will be dismissed automatically. These requests have the client waiting for a response on a HTTP connection, so choose a relatively short time (e.g., 60 seconds)</li>
  100 <li><em>Maximum asynchronous executions run parallel</em>: the maximum number of asynchronous processes that will run in parallel at a given time. The others will be queued</li>
  101 <li><em>Maximum execution time for asynchronous requests</em>: the maximum time an asysynchronous process is allowed executing. Processes running in asynchronous mode will have to complete within the set time limit, or they will be dismissed automatically</li>
  102 <li><em>Maximum queue and execution time for asynchronous requests</em>: the maximum time an asysynchronous process is allowed in the queue and executing. Processes running in asynchronous mode will have to complete within the set time limit, or they will be dismissed automatically</li>
  103 </ul>
  104 </div></blockquote>
  105 <p>Resource settings:</p>
  106 <blockquote>
  107 <div><ul class="simple">
  108 <li><em>Resource expiration timeout</em>: number of seconds the result of a asynchronous execution will be kept available on disk for user to retrieve. Once this time is expired these resources will be eligible for clearing (which happens at regular intervals).</li>
  109 <li><em>Resource storage directory</em>: where on disk the input, temporary and output resources associated to a certain process will be kept. By default it will be the <code class="docutils literal notranslate"><span class="pre">temp/wps</span></code> directory inside the GeoServer data directory</li>
  110 </ul>
  111 </div></blockquote>
  112 </div>
  113 <div class="section" id="process-status-page">
  114 <h2>Process status page<a class="headerlink" href="#process-status-page" title="Permalink to this headline"></a></h2>
  115 <p>The process status page, available in the “About &amp; Status” section, reports about running, and recently
  116 completed, processes:</p>
  117 <div class="figure align-center">
  118 <img alt="../../_images/statuspage.png" src="../../_images/statuspage.png" />
  119 </div>
  120 <p>The table contains several information bits:</p>
  121 <ul class="simple">
  122 <li><em>S/A</em>: synchronous or asynchronous execution</li>
  123 <li><em>Node</em>: the name of the machine running the process (important in a clustered environment)</li>
  124 <li><em>User</em>: user that started the execution</li>
  125 <li><em>Process name</em>: the main process being run (chained processes will not appear in this table)</li>
  126 <li><em>Created</em>: when the process got created</li>
  127 <li><em>Phase</em>: the current phase in the process lifecycle</li>
  128 <li><em>Progress</em>: current progress</li>
  129 <li><em>Task</em>: what the process is actually doing at the moment</li>
  130 </ul>
  131 <p>In GeoServer there are the following execution phases:</p>
  132 <ul class="simple">
  133 <li><em>QUEUED</em>: the process is waiting to be executed</li>
  134 <li><em>RUNNING</em>: the process is either retriving and parsing the inputs, computing the results, or writing them out</li>
  135 <li><em>FAILED</em>: the process execution terminated with a failure</li>
  136 <li><em>SUCCESS</em>: the process execution terminated with a success</li>
  137 <li><em>DISMISSING</em>: the process execution is being dismissed, depending on the process nature this might take some time, or be instantaneous</li>
  138 </ul>
  139 <p>All executions listed in the table can be selected, and then dismissed using the “Dismiss selected processes” link  at the top of the table.
  140 Unlike the “Dismiss” vendor operation this UI allows to also dismiss synchronous processes.
  141 Once the process dismissal is complete, the process execution will disappear from the table (in accordance with the WPS specification).</p>
  142 <p>Completed processes can also be dismissed, this will cause all on disk resources associated to the processe to be removed
  143 immediately, instead of waiting for the regular time based expiration.</p>
  144 </div>
  145 </div>
  146 
  147 
  148       <div class="selfclear pagination-nav">
  149           <div class="leftwise"><strong>Previous</strong>: <a href="operations.html" title="previous chapter">WPS Operations</a></div>
  150           <div class="rightwise"><strong>Next</strong>: <a href="security.html" title="next chapter">WPS Security and input limits</a></div>
  151       </div>
  152       </div><!-- /#content> -->
  153       <div id="content-right" class="content-border"></div>
  154   <div id="sidebar" class="contrast">
  155       <div id="toc" class="section">
  156         <h3 class="pngfix">Table Of Contents</h3>
  157         <ul>
  158 <li><a class="reference internal" href="#">WPS Service page</a><ul>
  159 <li><a class="reference internal" href="#service-metadata">Service Metadata</a></li>
  160 <li><a class="reference internal" href="#execution-and-resource-management-options">Execution and resource management options</a></li>
  161 <li><a class="reference internal" href="#process-status-page">Process status page</a></li>
  162 </ul>
  163 </li>
  164 </ul>
  165 
  166         <div class="section-footer"></div>
  167       </div>
  168         <div class="section">
  169           <h3>Continue Reading</h3>
  170           <ul>
  171             <li>Previous: <a href="operations.html" title="previous chapter">WPS Operations</a></li>
  172             <li>Next: <a href="security.html" title="next chapter">WPS Security and input limits</a></li>
  173           </ul>
  174         </div>
  175         <div class="section">
  176         <h3>This Page</h3>
  177         <ul class="this-page-menu">
  178                 
  179         <li><a href="https://github.com/geoserver/geoserver/tree/master/doc/en/user/source/services/wps/administration.rst">Edit</a></li>
  180         </ul>
  181         </div>
  182   </div><!-- /#sidebar -->
  183   </div><!-- /.wrap> -->
  184 </div><!-- /#main -->
  185 <div id="footer">
  186   <div class="wrap">
  187     &copy; Copyright 2019, Open Source Geospatial Foundation. License <a href="http://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution</a>.
  188     Last updated on Nov 22, 2019.
  189     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
  190   </div><!-- /.wrap> -->
  191 </div><!-- /#footer -->
  192   </body>
  193 </html>