[659] | 1 | |
---|
| 2 | |
---|
| 3 | <!DOCTYPE html> |
---|
| 4 | <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
---|
| 5 | <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
---|
| 6 | <head> |
---|
| 7 | <meta charset="utf-8"> |
---|
| 8 | <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
---|
| 9 | |
---|
| 10 | <title>ZOO-Service configuration file — ZOO-Project 1.4a0 documentation</title> |
---|
| 11 | |
---|
| 12 | <link href="http://fonts.googleapis.com/css?family=Days+One" rel="stylesheet" type="text/css"> |
---|
| 13 | |
---|
| 14 | |
---|
| 15 | |
---|
| 16 | |
---|
| 17 | |
---|
| 18 | |
---|
| 19 | |
---|
| 20 | |
---|
| 21 | <link rel="search" type="application/opensearchdescription+xml" title="Search within ZOO-Project 1.4a0 documentation" href="../_static/opensearch.xml"/> |
---|
| 22 | |
---|
| 23 | |
---|
| 24 | |
---|
| 25 | |
---|
| 26 | |
---|
| 27 | |
---|
| 28 | <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> |
---|
| 29 | |
---|
| 30 | |
---|
| 31 | |
---|
| 32 | |
---|
| 33 | |
---|
| 34 | <link rel="top" title="ZOO-Project 1.4a0 documentation" href="../index.html"/> |
---|
| 35 | <link rel="up" title="ZOO-Services" href="index.html"/> |
---|
| 36 | <link rel="next" title="Process profiles registry" href="process-profiles.html"/> |
---|
| 37 | <link rel="prev" title="What are ZOO-Services ?" href="what.html"/> |
---|
| 38 | |
---|
| 39 | |
---|
| 40 | <script src="_static/js/modernizr.min.js"></script> |
---|
| 41 | |
---|
| 42 | </head> |
---|
| 43 | |
---|
| 44 | <body class="wy-body-for-nav" role="document"> |
---|
| 45 | |
---|
| 46 | <div class="wy-grid-for-nav"> |
---|
| 47 | |
---|
| 48 | |
---|
| 49 | <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
---|
| 50 | <div class="wy-side-nav-search"> |
---|
| 51 | |
---|
| 52 | |
---|
| 53 | |
---|
| 54 | <a class="shrink" href="http://zoo-project.org"><img src="http://zoo-project.org/img/zoo-sun-logo.png" class="img-responsive sun" style="display: inline;"> ZOO</a> |
---|
| 55 | |
---|
| 56 | |
---|
| 57 | |
---|
| 58 | </a> |
---|
| 59 | |
---|
| 60 | |
---|
| 61 | <div role="search"> |
---|
| 62 | <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
---|
| 63 | <input type="text" name="q" placeholder="Search docs" /> |
---|
| 64 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 65 | <input type="hidden" name="area" value="default" /> |
---|
| 66 | </form> |
---|
| 67 | </div> |
---|
| 68 | |
---|
| 69 | |
---|
| 70 | </div> |
---|
| 71 | |
---|
| 72 | <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
---|
| 73 | |
---|
| 74 | |
---|
| 75 | |
---|
| 76 | <ul class="current"> |
---|
| 77 | <li class="toctree-l1"><a class="reference internal" href="../intro.html">Introduction</a><ul> |
---|
| 78 | <li class="toctree-l2"><a class="reference internal" href="../intro.html#what-is-zoo-project">What is ZOO-Project ?</a></li> |
---|
| 79 | <li class="toctree-l2"><a class="reference internal" href="../intro.html#zoo-project-components">ZOO-Project components</a></li> |
---|
| 80 | <li class="toctree-l2"><a class="reference internal" href="../intro.html#open-source">Open Source</a></li> |
---|
| 81 | </ul> |
---|
| 82 | </li> |
---|
| 83 | <li class="toctree-l1"><a class="reference internal" href="../install/index.html">ZOO-Project installation</a><ul> |
---|
| 84 | <li class="toctree-l2"><a class="reference internal" href="../install/install-prerequisites.html">Prerequisites</a></li> |
---|
| 85 | <li class="toctree-l2"><a class="reference internal" href="../install/install-download.html">Download</a></li> |
---|
| 86 | <li class="toctree-l2"><a class="reference internal" href="../install/install-confoptions.html">Configure options</a></li> |
---|
| 87 | <li class="toctree-l2"><a class="reference internal" href="../install/install-installation.html">Installation on Unix/Linux</a></li> |
---|
| 88 | <li class="toctree-l2"><a class="reference internal" href="../install/install-onwindows.html">Installation on Windows ™</a></li> |
---|
| 89 | <li class="toctree-l2"><a class="reference internal" href="../install/install-onmacos.html">Installation on MacOSX ™</a></li> |
---|
| 90 | </ul> |
---|
| 91 | </li> |
---|
| 92 | <li class="toctree-l1"><a class="reference internal" href="../kernel/index.html">ZOO-Kernel</a><ul> |
---|
| 93 | <li class="toctree-l2"><a class="reference internal" href="../kernel/what.html">What is ZOO-Kernel ?</a></li> |
---|
| 94 | <li class="toctree-l2"><a class="reference internal" href="../kernel/configuration.html">ZOO-Kernel configuration</a></li> |
---|
| 95 | <li class="toctree-l2"><a class="reference internal" href="../kernel/mapserver.html">Optional MapServer support</a></li> |
---|
| 96 | <li class="toctree-l2"><a class="reference internal" href="../kernel/orfeotoolbox.html">Optional Orfeo Toolbox support</a></li> |
---|
| 97 | <li class="toctree-l2"><a class="reference internal" href="../kernel/sagagis.html">Optional SAGA GIS support</a></li> |
---|
| 98 | </ul> |
---|
| 99 | </li> |
---|
| 100 | <li class="toctree-l1 current"><a class="reference internal" href="index.html">ZOO-Services</a><ul class="current"> |
---|
| 101 | <li class="toctree-l2"><a class="reference internal" href="what.html">What are ZOO-Services ?</a></li> |
---|
| 102 | <li class="toctree-l2 current"><a class="current reference internal" href="">ZOO-Service configuration file</a></li> |
---|
| 103 | <li class="toctree-l2"><a class="reference internal" href="process-profiles.html">Process profiles registry</a></li> |
---|
| 104 | <li class="toctree-l2"><a class="reference internal" href="howtos.html">Create your own ZOO-Services</a></li> |
---|
| 105 | <li class="toctree-l2"><a class="reference internal" href="status.html">ZOO Status Service</a></li> |
---|
| 106 | <li class="toctree-l2"><a class="reference internal" href="debug.html">Debugging ZOO Services</a></li> |
---|
| 107 | <li class="toctree-l2"><a class="reference internal" href="zoo-services.html">Available ZOO-Services</a></li> |
---|
| 108 | </ul> |
---|
| 109 | </li> |
---|
| 110 | <li class="toctree-l1"><a class="reference internal" href="../api/index.html">ZOO-API</a><ul> |
---|
| 111 | <li class="toctree-l2"><a class="reference internal" href="../api/what.html">What is ZOO-API ?</a></li> |
---|
| 112 | <li class="toctree-l2"><a class="reference internal" href="../api/howto.html">Using ZOO-API</a></li> |
---|
| 113 | <li class="toctree-l2"><a class="reference internal" href="../api/classes.html">ZOO-API Classes</a></li> |
---|
| 114 | <li class="toctree-l2"><a class="reference internal" href="../api/examples.html">Examples</a></li> |
---|
| 115 | </ul> |
---|
| 116 | </li> |
---|
| 117 | <li class="toctree-l1"><a class="reference internal" href="../client/index.html">ZOO-Client</a><ul> |
---|
| 118 | <li class="toctree-l2"><a class="reference internal" href="../client/what.html">What is ZOO-Client ?</a></li> |
---|
| 119 | <li class="toctree-l2"><a class="reference internal" href="../client/howto.html">Using ZOO-Client</a></li> |
---|
| 120 | <li class="toctree-l2"><a class="reference internal" href="../client/example.html">Example application</a></li> |
---|
| 121 | </ul> |
---|
| 122 | </li> |
---|
| 123 | <li class="toctree-l1"><a class="reference internal" href="../contribute/index.html">Contributor Guide</a><ul> |
---|
| 124 | <li class="toctree-l2"><a class="reference internal" href="../contribute/howto.html">How to contribute ?</a></li> |
---|
| 125 | <li class="toctree-l2"><a class="reference internal" href="../contribute/code.html">Contribute code</a></li> |
---|
| 126 | </ul> |
---|
| 127 | </li> |
---|
| 128 | </ul> |
---|
| 129 | |
---|
| 130 | |
---|
| 131 | |
---|
| 132 | </div> |
---|
| 133 | |
---|
| 134 | </nav> |
---|
| 135 | |
---|
| 136 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
---|
| 137 | |
---|
| 138 | |
---|
| 139 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
---|
| 140 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
---|
| 141 | <a href="../contents.html">ZOO-Project</a> |
---|
| 142 | </nav> |
---|
| 143 | |
---|
| 144 | |
---|
| 145 | |
---|
| 146 | <div class="wy-nav-content"> |
---|
| 147 | <div class="rst-content"> |
---|
| 148 | <div role="navigation" aria-label="breadcrumbs navigation"> |
---|
| 149 | <ul class="wy-breadcrumbs"> |
---|
| 150 | |
---|
| 151 | <li><a href="../contents.html"> Docs</a> ∕  </li> |
---|
| 152 | |
---|
| 153 | <li><a href="index.html">ZOO-Services</a> ∕  </li> |
---|
| 154 | |
---|
| 155 | <li>ZOO-Service configuration file</li> |
---|
| 156 | <li class="wy-breadcrumbs-aside"> |
---|
| 157 | |
---|
| 158 | <a href="../_sources/services/zcfg-reference.txt" rel="nofollow"> View page source</a> |
---|
| 159 | |
---|
| 160 | </li> |
---|
| 161 | </ul> |
---|
| 162 | <hr/> |
---|
| 163 | </div> |
---|
| 164 | <div role="main" class="document"> |
---|
| 165 | |
---|
| 166 | <div class="section" id="zoo-service-configuration-file"> |
---|
| 167 | <span id="services-zcfg"></span><h1>ZOO-Service configuration file<a class="headerlink" href="#zoo-service-configuration-file" title="Permalink to this headline">¶</a></h1> |
---|
| 168 | <p>The ZOO-Service configuration file (.zcfg) describes a |
---|
| 169 | WPS service. It provides metadata information on a particular WPS |
---|
| 170 | Service and it is parsed by ZOO-Kernel when <em>DescribeProcess</em> and |
---|
| 171 | <em>Execute</em> request are sent.</p> |
---|
| 172 | <p>The ZOO-Service configuration file is divided into three distinct sections :</p> |
---|
| 173 | <blockquote> |
---|
| 174 | <div><ul class="simple"> |
---|
| 175 | <li>Main Metadata information</li> |
---|
| 176 | <li>List of Inputs metadata information (optional since <a class="reference external" href="http://zoo-project.org/trac/changeset/469">rev. 469</a>)</li> |
---|
| 177 | <li>List of Outputs metadata information</li> |
---|
| 178 | </ul> |
---|
| 179 | </div></blockquote> |
---|
| 180 | <div class="admonition warning"> |
---|
| 181 | <p class="first admonition-title">Warning</p> |
---|
| 182 | <p class="last">The ZOO-Service configuration file is case sensitive.</p> |
---|
| 183 | </div> |
---|
| 184 | <div class="admonition note"> |
---|
| 185 | <p class="first admonition-title">Note</p> |
---|
| 186 | <p class="last">There are many example ZCFG files in the <code class="docutils literal"><span class="pre">cgi-env</span></code> directory of the <a class="reference external" href="http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-services">ZOO-Project svn</a>.</p> |
---|
| 187 | </div> |
---|
| 188 | <div class="section" id="main-section"> |
---|
| 189 | <h2>Main section<a class="headerlink" href="#main-section" title="Permalink to this headline">¶</a></h2> |
---|
| 190 | <p>The fist part of the ZOO-Service configuration file is the <code class="docutils literal"><span class="pre">main</span></code> section, |
---|
| 191 | which contains general metadata information on the related WPS |
---|
| 192 | Service.</p> |
---|
| 193 | <p>Note that the “name of your service” between brackets on the first line has to be the exact same name |
---|
| 194 | as the function you defined in your services provider code. In most cases, this name is also the name |
---|
| 195 | of the ZCFG file without the “<code class="docutils literal"><span class="pre">.zcfg</span></code>” extension.</p> |
---|
| 196 | <p>An example of the <code class="docutils literal"><span class="pre">main</span></code> section is given bellow as reference.</p> |
---|
| 197 | <div class="highlight-none"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1 |
---|
| 198 | 2 |
---|
| 199 | 3 |
---|
| 200 | 4 |
---|
| 201 | 5 |
---|
| 202 | 6 |
---|
| 203 | 7 |
---|
| 204 | 8 |
---|
| 205 | 9 |
---|
| 206 | 10 |
---|
| 207 | 11</pre></div></td><td class="code"><div class="highlight"><pre>[Name of WPS Service] |
---|
| 208 | Title = Title of the WPS Service |
---|
| 209 | Abstract = Description of the WPS Service |
---|
| 210 | processVersion = Version number of the WPS Service |
---|
| 211 | storeSupported = true/false |
---|
| 212 | statusSupported = true/false |
---|
| 213 | serviceType = Pprogramming language used to implement the service (C|Fortran|Python|Java|PHP|Ruby|Javascript) |
---|
| 214 | serviceProvider = Name of the Services provider (shared library|Python Module|Java Class|PHP Script|JavaScript Script) |
---|
| 215 | <MetaData> |
---|
| 216 | title = Metadata title of the WPS Service |
---|
| 217 | </MetaData> |
---|
| 218 | </pre></div> |
---|
| 219 | </td></tr></table></div> |
---|
| 220 | <div class="admonition warning"> |
---|
| 221 | <p class="first admonition-title">Warning</p> |
---|
| 222 | <p class="last">‘Name of WPS Service’ must be the exact same name as the function defined in the WPS Service source code.</p> |
---|
| 223 | </div> |
---|
| 224 | <div class="admonition note"> |
---|
| 225 | <p class="first admonition-title">Note</p> |
---|
| 226 | <p class="last">An <code class="docutils literal"><span class="pre">extend</span></code> parameter may be used for the <a class="reference external" href="process-profiles.html">Process profile registry</a>.</p> |
---|
| 227 | </div> |
---|
| 228 | </div> |
---|
| 229 | <div class="section" id="list-of-inputs"> |
---|
| 230 | <h2>List of Inputs<a class="headerlink" href="#list-of-inputs" title="Permalink to this headline">¶</a></h2> |
---|
| 231 | <p>The second part of the ZOO-Service configuration file is the <code class="docutils literal"><span class="pre"><DataInputs></span></code> |
---|
| 232 | section which lists the supported inputs. Each input is defined as :</p> |
---|
| 233 | <blockquote> |
---|
| 234 | <div><ul class="simple"> |
---|
| 235 | <li>Name (between brackets as for the name of the service before)</li> |
---|
| 236 | <li>Various medata properties (<code class="docutils literal"><span class="pre">Title</span></code>, <code class="docutils literal"><span class="pre">Abstract</span></code>, <code class="docutils literal"><span class="pre">minOccurs</span></code>, <code class="docutils literal"><span class="pre">maxOccurs</span></code> and, in case of ComplexData, the optional <code class="docutils literal"><span class="pre">maximumMegabytes</span></code>)</li> |
---|
| 237 | <li><a class="reference internal" href="#typedatanodes"><span>Type Of Data Node</span></a></li> |
---|
| 238 | </ul> |
---|
| 239 | </div></blockquote> |
---|
| 240 | <p>A typical list of inputs (<code class="docutils literal"><span class="pre"><DataInputs></span></code>) looks like the following:</p> |
---|
| 241 | <div class="highlight-none"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1 |
---|
| 242 | 2 |
---|
| 243 | 3 |
---|
| 244 | 4 |
---|
| 245 | 5 |
---|
| 246 | 6 |
---|
| 247 | 7 |
---|
| 248 | 8 |
---|
| 249 | 9 |
---|
| 250 | 10 |
---|
| 251 | 11 |
---|
| 252 | 12 |
---|
| 253 | 13 |
---|
| 254 | 14</pre></div></td><td class="code"><div class="highlight"><pre><DataInputs> |
---|
| 255 | [Name of the first input] |
---|
| 256 | Title = Title of the first input |
---|
| 257 | Abstract = Abstract describing the first input |
---|
| 258 | minOccurs = Minimum occurence of the first input |
---|
| 259 | maxOccurs = Maximum occurence of the first input |
---|
| 260 | <Type Of Data Node /> |
---|
| 261 | [Name of the second input] |
---|
| 262 | Title = Title of the second input |
---|
| 263 | Abstract = Abstract describing the second input |
---|
| 264 | minOccurs = Minimum occurence of the second input |
---|
| 265 | maxOccurs = Maximum occurence of the second input |
---|
| 266 | <Type Of Data Node /> |
---|
| 267 | </DataInputs> |
---|
| 268 | </pre></div> |
---|
| 269 | </td></tr></table></div> |
---|
| 270 | <div class="admonition note"> |
---|
| 271 | <p class="first admonition-title">Note</p> |
---|
| 272 | <p class="last">A <code class="docutils literal"><span class="pre"><MetaData></span></code> node can also be added, as in the main metadata information.</p> |
---|
| 273 | </div> |
---|
| 274 | </div> |
---|
| 275 | <div class="section" id="list-of-outputs"> |
---|
| 276 | <h2>List of Outputs<a class="headerlink" href="#list-of-outputs" title="Permalink to this headline">¶</a></h2> |
---|
| 277 | <p>The third part of the ZOO Service configuration file is the <code class="docutils literal"><span class="pre"><DataOutputs></span></code> |
---|
| 278 | section, which lists the supported outputs and is is very similar to a |
---|
| 279 | list of inputs.</p> |
---|
| 280 | <p>A typical list of outputs (<code class="docutils literal"><span class="pre"><DataOutputs></span></code>) looks like the |
---|
| 281 | following:</p> |
---|
| 282 | <div class="highlight-none"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1 |
---|
| 283 | 2 |
---|
| 284 | 3 |
---|
| 285 | 4 |
---|
| 286 | 5 |
---|
| 287 | 6</pre></div></td><td class="code"><div class="highlight"><pre><DataOutputs> |
---|
| 288 | [Name of the output] |
---|
| 289 | Title = Title of the output |
---|
| 290 | Abstract = Description of the output |
---|
| 291 | <Type Of Data Node /> |
---|
| 292 | </DataOutputs> |
---|
| 293 | </pre></div> |
---|
| 294 | </td></tr></table></div> |
---|
| 295 | </div> |
---|
| 296 | <div class="section" id="type-of-data-nodes"> |
---|
| 297 | <span id="typedatanodes"></span><h2>Type Of Data Nodes<a class="headerlink" href="#type-of-data-nodes" title="Permalink to this headline">¶</a></h2> |
---|
| 298 | <p>The <em>Type Of Data Nodes</em> describes data types for inputs and |
---|
| 299 | outputs. There are three different types which are described in this |
---|
| 300 | section.</p> |
---|
| 301 | <blockquote> |
---|
| 302 | <div><ul class="simple"> |
---|
| 303 | <li><a class="reference internal" href="#literaldata"><span>LiteralData</span></a></li> |
---|
| 304 | <li><a class="reference internal" href="#boundingboxdata"><span>BoundingBoxData</span></a></li> |
---|
| 305 | <li><a class="reference internal" href="#complexdata"><span>ComplexData</span></a></li> |
---|
| 306 | </ul> |
---|
| 307 | <div class="admonition warning"> |
---|
| 308 | <p class="first admonition-title">Warning</p> |
---|
| 309 | <p class="last">Every <em>BoundingBoxData</em> and <em>ComplexData</em> must have at least one <code class="docutils literal"><span class="pre"><Default></span></code> node (even empty like <code class="docutils literal"><span class="pre"><Default</span> <span class="pre">/></span></code>)</p> |
---|
| 310 | </div> |
---|
| 311 | </div></blockquote> |
---|
| 312 | <div class="section" id="literaldata-node"> |
---|
| 313 | <span id="literaldata"></span><h3>LiteralData node<a class="headerlink" href="#literaldata-node" title="Permalink to this headline">¶</a></h3> |
---|
| 314 | <p>A <code class="docutils literal"><span class="pre"><LiteralData></span></code> node contains:</p> |
---|
| 315 | <ul class="simple"> |
---|
| 316 | <li>one (optional) <code class="docutils literal"><span class="pre">AllowedValues</span></code> key containing all value allowed for this input</li> |
---|
| 317 | <li>one (optional) <code class="docutils literal"><span class="pre">range</span></code> properties containing the range (<code class="docutils literal"><span class="pre">[</span></code>, <code class="docutils literal"><span class="pre">]</span></code>)</li> |
---|
| 318 | <li>one (optional) <code class="docutils literal"><span class="pre">rangeMin</span></code> (<code class="docutils literal"><span class="pre">rangeMax</span></code>) properties containing the minimum (maximum) value of this range</li> |
---|
| 319 | <li>one (optional) <code class="docutils literal"><span class="pre">rangeSpacing</span></code> properties containing the regular distance or spacing between value in this range</li> |
---|
| 320 | <li>one (optional) <code class="docutils literal"><span class="pre">rangeClosure</span></code> properties containing the closure type (<code class="docutils literal"><span class="pre">c</span></code>, <code class="docutils literal"><span class="pre">o</span></code>, <code class="docutils literal"><span class="pre">oc</span></code>, <code class="docutils literal"><span class="pre">co</span></code>)</li> |
---|
| 321 | <li>one <code class="docutils literal"><span class="pre"><Default></span></code> node,</li> |
---|
| 322 | <li>zero or more <code class="docutils literal"><span class="pre"><Supported></span></code> nodes depending on the existence or the number of supported Units Of Measure (UOM), and</li> |
---|
| 323 | <li>a <code class="docutils literal"><span class="pre">dataType</span></code> property. The <code class="docutils literal"><span class="pre">dataType</span></code> property defines the type of literal data, such as a string, an interger and so on |
---|
| 324 | (consult <a class="reference external" href="http://www.w3.org/TR/xmlschema-2/#built-in-datatypes">the complete list</a> of supported data types).</li> |
---|
| 325 | </ul> |
---|
| 326 | <p><code class="docutils literal"><span class="pre"><Default></span></code> and <code class="docutils literal"><span class="pre"><Supported></span></code> nodes can contain the <code class="docutils literal"><span class="pre">uom</span></code> property to define which UOM has to be used for |
---|
| 327 | this input value.</p> |
---|
| 328 | <p>For input <code class="docutils literal"><span class="pre"><LiteralData></span></code> nodes, you can add the <code class="docutils literal"><span class="pre">value</span></code> property to the <code class="docutils literal"><span class="pre"><Default></span></code> node to define a default |
---|
| 329 | value for this input. This means that, when your Service will be run, even if the input wasn’t defined, this default |
---|
| 330 | value will be set as the current value for this input.</p> |
---|
| 331 | <p>A typical <code class="docutils literal"><span class="pre"><LiteralData></span></code> node, defining a <code class="docutils literal"><span class="pre">float</span></code> data type using meters or degrees for its UOM, looks like the |
---|
| 332 | following:</p> |
---|
| 333 | <div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1 |
---|
| 334 | 2 |
---|
| 335 | 3 |
---|
| 336 | 4 |
---|
| 337 | 5 |
---|
| 338 | 6 |
---|
| 339 | 7 |
---|
| 340 | 8 |
---|
| 341 | 9</pre></div></td><td class="code"><div class="highlight"><pre><span class="nt"><LiteralData></span> |
---|
| 342 | dataType = float |
---|
| 343 | <span class="nt"><Default></span> |
---|
| 344 | uom = meters |
---|
| 345 | <span class="nt"></Default></span> |
---|
| 346 | <span class="nt"><Supported></span> |
---|
| 347 | uom = feet |
---|
| 348 | <span class="nt"></Supported></span> |
---|
| 349 | <span class="nt"></LiteralData></span> |
---|
| 350 | </pre></div> |
---|
| 351 | </td></tr></table></div> |
---|
| 352 | <p>A typical <code class="docutils literal"><span class="pre"><LiteralData></span></code> node, defining a <code class="docutils literal"><span class="pre">float</span></code> data type which |
---|
| 353 | should take values contained in <code class="docutils literal"><span class="pre">[0.0,100.0]</span></code>, looks like the following:</p> |
---|
| 354 | <div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1 |
---|
| 355 | 2 |
---|
| 356 | 3 |
---|
| 357 | 4 |
---|
| 358 | 5 |
---|
| 359 | 6 |
---|
| 360 | 7</pre></div></td><td class="code"><div class="highlight"><pre><span class="nt"><LiteralData></span> |
---|
| 361 | dataType = float |
---|
| 362 | rangeMin = 0.0 |
---|
| 363 | rangeMax = 100.0 |
---|
| 364 | rangeClosure = c |
---|
| 365 | <span class="nt"><Default</span> <span class="nt">/></span> |
---|
| 366 | <span class="nt"></LiteralData></span> |
---|
| 367 | </pre></div> |
---|
| 368 | </td></tr></table></div> |
---|
| 369 | <p>Or more simply:</p> |
---|
| 370 | <div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1 |
---|
| 371 | 2 |
---|
| 372 | 3 |
---|
| 373 | 4 |
---|
| 374 | 5</pre></div></td><td class="code"><div class="highlight"><pre><span class="nt"><LiteralData></span> |
---|
| 375 | dataType = float |
---|
| 376 | range = [0.0,100.0] |
---|
| 377 | <span class="nt"><Default</span> <span class="nt">/></span> |
---|
| 378 | <span class="nt"></LiteralData></span> |
---|
| 379 | </pre></div> |
---|
| 380 | </td></tr></table></div> |
---|
| 381 | <p>A typical <code class="docutils literal"><span class="pre"><LiteralData></span></code> node, defining a <code class="docutils literal"><span class="pre">string</span></code> data type which |
---|
| 382 | support values <code class="docutils literal"><span class="pre">hillshade</span></code>, <code class="docutils literal"><span class="pre">slope</span></code>, <code class="docutils literal"><span class="pre">aspect</span></code>, <code class="docutils literal"><span class="pre">TRI</span></code>, <code class="docutils literal"><span class="pre">TPI</span></code> |
---|
| 383 | and <code class="docutils literal"><span class="pre">roughness</span></code>, looks like the following:</p> |
---|
| 384 | <div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1 |
---|
| 385 | 2 |
---|
| 386 | 3 |
---|
| 387 | 4 |
---|
| 388 | 5</pre></div></td><td class="code"><div class="highlight"><pre><span class="nt"><LiteralData></span> |
---|
| 389 | dataType = string |
---|
| 390 | AllowedValues = hillshade,slope,aspect,TRI,TPI,roughness |
---|
| 391 | <span class="nt"><Default</span> <span class="nt">/></span> |
---|
| 392 | <span class="nt"></LiteralData></span> |
---|
| 393 | </pre></div> |
---|
| 394 | </td></tr></table></div> |
---|
| 395 | <p>Properties <code class="docutils literal"><span class="pre">AllowedValues</span></code> and <code class="docutils literal"><span class="pre">range*</span></code> can be conbined with both <code class="docutils literal"><span class="pre"><Default></span></code> and |
---|
| 396 | <code class="docutils literal"><span class="pre"><Supported></span></code> nodes in the same was as <code class="docutils literal"><span class="pre"><LiteralData></span></code> node. For |
---|
| 397 | instance, the following is supported:</p> |
---|
| 398 | <div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1 |
---|
| 399 | 2 |
---|
| 400 | 3 |
---|
| 401 | 4 |
---|
| 402 | 5 |
---|
| 403 | 6 |
---|
| 404 | 7 |
---|
| 405 | 8 |
---|
| 406 | 9 |
---|
| 407 | 10 |
---|
| 408 | 11 |
---|
| 409 | 12 |
---|
| 410 | 13 |
---|
| 411 | 14 |
---|
| 412 | 15 |
---|
| 413 | 16 |
---|
| 414 | 17 |
---|
| 415 | 18 |
---|
| 416 | 19 |
---|
| 417 | 20 |
---|
| 418 | 21</pre></div></td><td class="code"><div class="highlight"><pre><span class="nt"><LiteralData></span> |
---|
| 419 | dataType = int |
---|
| 420 | <span class="nt"><Default></span> |
---|
| 421 | value = 11 |
---|
| 422 | AllowedValues = -10,-8,-7,-5,-1 |
---|
| 423 | rangeMin = 0 |
---|
| 424 | rangeMin = 100 |
---|
| 425 | rangeClosure = co |
---|
| 426 | <span class="nt"></Default></span> |
---|
| 427 | <span class="nt"><Supported></span> |
---|
| 428 | rangeMin = 200 |
---|
| 429 | rangeMin = 600 |
---|
| 430 | rangeClosure = co |
---|
| 431 | <span class="nt"></Supported></span> |
---|
| 432 | <span class="nt"><Supported></span> |
---|
| 433 | rangeMin = 750 |
---|
| 434 | rangeMin = 990 |
---|
| 435 | rangeClosure = co |
---|
| 436 | rangeSpacing = 10 |
---|
| 437 | <span class="nt"></Supported></span> |
---|
| 438 | <span class="nt"></LiteralData></span> |
---|
| 439 | </pre></div> |
---|
| 440 | </td></tr></table></div> |
---|
| 441 | </div> |
---|
| 442 | <div class="section" id="boundingboxdata-node"> |
---|
| 443 | <span id="boundingboxdata"></span><h3>BoundingBoxData node<a class="headerlink" href="#boundingboxdata-node" title="Permalink to this headline">¶</a></h3> |
---|
| 444 | <p>A <code class="docutils literal"><span class="pre"><BoundingBoxData></span></code> node contains:</p> |
---|
| 445 | <ul class="simple"> |
---|
| 446 | <li>one <code class="docutils literal"><span class="pre"><Default></span></code> node with a CRS property defining the default Coordinate Reference Systems (CRS), and</li> |
---|
| 447 | <li>one or more <code class="docutils literal"><span class="pre"><Supported></span></code> nodes depending on the number of CRS your service supports (note that you can |
---|
| 448 | alternatively use a single <code class="docutils literal"><span class="pre"><Supported></span></code> node with a comma-separated list of supported CRS).</li> |
---|
| 449 | </ul> |
---|
| 450 | <p>A typical <code class="docutils literal"><span class="pre"><BoundingBoxData></span></code> node, for two supported CRS (<a class="reference external" href="http://www.epsg-registry.org/indicio/query?request=GetRepositoryItem&id=urn:ogc:def:crs:EPSG::4326">EPSG:4326</a> |
---|
| 451 | and <a class="reference external" href="http://www.epsg-registry.org/indicio/query?request=GetRepositoryItem&id=urn:ogc:def:crs:EPSG::3785">EPSG:3785</a>), |
---|
| 452 | looks like the following:</p> |
---|
| 453 | <div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1 |
---|
| 454 | 2 |
---|
| 455 | 3 |
---|
| 456 | 4 |
---|
| 457 | 5 |
---|
| 458 | 6 |
---|
| 459 | 7 |
---|
| 460 | 8 |
---|
| 461 | 9 |
---|
| 462 | 10 |
---|
| 463 | 11</pre></div></td><td class="code"><div class="highlight"><pre><span class="nt"><BoundingBoxData></span> |
---|
| 464 | <span class="nt"><Default></span> |
---|
| 465 | CRS = urn:ogc:def:crs:EPSG:6.6:4326 |
---|
| 466 | <span class="nt"></Default></span> |
---|
| 467 | <span class="nt"><Supported></span> |
---|
| 468 | CRS = urn:ogc:def:crs:EPSG:6.6:4326 |
---|
| 469 | <span class="nt"></Supported></span> |
---|
| 470 | <span class="nt"><Supported></span> |
---|
| 471 | CRS = urn:ogc:def:crs:EPSG:6.6:3785 |
---|
| 472 | <span class="nt"></Supported></span> |
---|
| 473 | <span class="nt"></BoundingBoxData></span> |
---|
| 474 | </pre></div> |
---|
| 475 | </td></tr></table></div> |
---|
| 476 | </div> |
---|
| 477 | <div class="section" id="complexdata-node"> |
---|
| 478 | <span id="complexdata"></span><h3>ComplexData node<a class="headerlink" href="#complexdata-node" title="Permalink to this headline">¶</a></h3> |
---|
| 479 | <p>A ComplexData node contains:</p> |
---|
| 480 | <ul class="simple"> |
---|
| 481 | <li>a <code class="docutils literal"><span class="pre"><Default></span></code> node and</li> |
---|
| 482 | <li>one or more <code class="docutils literal"><span class="pre"><Supported></span></code> nodes depending on the number of supported formats. A format is made up of this |
---|
| 483 | set of properties : <code class="docutils literal"><span class="pre">mimeType</span></code>, <code class="docutils literal"><span class="pre">encoding</span></code> and optionaly <code class="docutils literal"><span class="pre">schema</span></code>.</li> |
---|
| 484 | </ul> |
---|
| 485 | <p>For output ComplexData nodes, you can add the <code class="docutils literal"><span class="pre">extension</span></code> property to define what extension to use to name |
---|
| 486 | the file when storing the result is required. Obviously, you’ll have to add the <code class="docutils literal"><span class="pre">extension</span></code> property to each |
---|
| 487 | supported format (for the <code class="docutils literal"><span class="pre"><Default></span></code> and <code class="docutils literal"><span class="pre"><Supported></span></code> nodes).</p> |
---|
| 488 | <p>You can also add the <code class="docutils literal"><span class="pre">asReference</span></code> property to the <code class="docutils literal"><span class="pre"><Default></span></code> node to define if the output should be |
---|
| 489 | stored on server side per default.</p> |
---|
| 490 | <div class="admonition note"> |
---|
| 491 | <p class="first admonition-title">Note</p> |
---|
| 492 | <p class="last">the client can always modify this behavior by setting <code class="docutils literal"><span class="pre">asReference</span></code> attribute to <code class="docutils literal"><span class="pre">true</span></code> or <code class="docutils literal"><span class="pre">false</span></code> |
---|
| 493 | for this output in the request <code class="docutils literal"><span class="pre">ResponseDocument</span></code> parameter.</p> |
---|
| 494 | </div> |
---|
| 495 | <p>You can see below a sample ComplexData node for default <code class="docutils literal"><span class="pre">application/json</span></code> and <code class="docutils literal"><span class="pre">text/xml</span></code> (encoded in UTF-8 |
---|
| 496 | or base64) mimeTypes support:</p> |
---|
| 497 | <div class="highlight-guess"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1 |
---|
| 498 | 2 |
---|
| 499 | 3 |
---|
| 500 | 4 |
---|
| 501 | 5 |
---|
| 502 | 6 |
---|
| 503 | 7 |
---|
| 504 | 8 |
---|
| 505 | 9 |
---|
| 506 | 10 |
---|
| 507 | 11 |
---|
| 508 | 12 |
---|
| 509 | 13 |
---|
| 510 | 14 |
---|
| 511 | 15 |
---|
| 512 | 16</pre></div></td><td class="code"><div class="highlight"><pre><span class="nt"><ComplexData></span> |
---|
| 513 | <span class="nt"><Default></span> |
---|
| 514 | mimeType = application/json |
---|
| 515 | encoding = UTF-8 |
---|
| 516 | <span class="nt"></Default></span> |
---|
| 517 | <span class="nt"><Supported></span> |
---|
| 518 | mimeType = text/xml |
---|
| 519 | encoding = base64 |
---|
| 520 | schema = http://fooa/gml/3.1.0/polygon.xsd |
---|
| 521 | <span class="nt"></Supported></span> |
---|
| 522 | <span class="nt"><Supported></span> |
---|
| 523 | mimeType = text/xml |
---|
| 524 | encoding = UTF-8 |
---|
| 525 | schema = http://fooa/gml/3.1.0/polygon.xsd |
---|
| 526 | <span class="nt"></Supported></span> |
---|
| 527 | <span class="nt"></ComplexData></span> |
---|
| 528 | </pre></div> |
---|
| 529 | </td></tr></table></div> |
---|
| 530 | </div> |
---|
| 531 | </div> |
---|
| 532 | </div> |
---|
| 533 | |
---|
| 534 | |
---|
| 535 | </div> |
---|
| 536 | <footer> |
---|
| 537 | |
---|
| 538 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
---|
| 539 | |
---|
| 540 | <a href="process-profiles.html" class="btn btn-neutral float-right" title="Process profiles registry">Next <span class="fa fa-arrow-circle-right"></span></a> |
---|
| 541 | |
---|
| 542 | |
---|
| 543 | <a href="what.html" class="btn btn-neutral" title="What are ZOO-Services ?"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
---|
| 544 | |
---|
| 545 | </div> |
---|
| 546 | |
---|
| 547 | |
---|
| 548 | <hr/> |
---|
| 549 | <div class="pfoot"> |
---|
| 550 | <div role="contentinfo"> |
---|
| 551 | <p> |
---|
| 552 | © Copyright 2009-2015, ZOO-Project team. |
---|
| 553 | </p> |
---|
| 554 | </div> |
---|
| 555 | Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> inspired by <a href="https://readthedocs.org">Read the Docs</a>. |
---|
| 556 | </div> |
---|
| 557 | </footer> |
---|
| 558 | |
---|
| 559 | </div> |
---|
| 560 | </div> |
---|
| 561 | |
---|
| 562 | </section> |
---|
| 563 | |
---|
| 564 | </div> |
---|
| 565 | |
---|
| 566 | |
---|
| 567 | |
---|
| 568 | |
---|
| 569 | |
---|
| 570 | <script type="text/javascript"> |
---|
| 571 | var DOCUMENTATION_OPTIONS = { |
---|
| 572 | URL_ROOT:'../', |
---|
| 573 | VERSION:'1.4a0', |
---|
| 574 | COLLAPSE_INDEX:false, |
---|
| 575 | FILE_SUFFIX:'.html', |
---|
| 576 | HAS_SOURCE: true |
---|
| 577 | }; |
---|
| 578 | </script> |
---|
| 579 | <script type="text/javascript" src="../_static/jquery.js"></script> |
---|
| 580 | <script type="text/javascript" src="../_static/underscore.js"></script> |
---|
| 581 | <script type="text/javascript" src="../_static/doctools.js"></script> |
---|
| 582 | |
---|
| 583 | |
---|
| 584 | |
---|
| 585 | |
---|
| 586 | |
---|
| 587 | <script type="text/javascript" src="../_static/js/theme.js"></script> |
---|
| 588 | |
---|
| 589 | |
---|
| 590 | |
---|
| 591 | |
---|
| 592 | <script type="text/javascript"> |
---|
| 593 | jQuery(function () { |
---|
| 594 | SphinxRtdTheme.StickyNav.enable(); |
---|
| 595 | }); |
---|
| 596 | </script> |
---|
| 597 | |
---|
| 598 | |
---|
| 599 | </body> |
---|
| 600 | </html> |
---|