source: branches/PublicaMundi_David-devel/docs/_build/html/client/what.html @ 659

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>What is ZOO-Client ? &mdash; ZOO-Project 1.4a0 documentation</title>
  
  <link href="http://fonts.googleapis.com/css?family=Days+One" rel="stylesheet" type="text/css">
  
  

  

  
  
    
      <link rel="search" type="application/opensearchdescription+xml" title="Search within ZOO-Project 1.4a0 documentation" href="../_static/opensearch.xml"/>
    

  

  
  
    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="ZOO-Project 1.4a0 documentation" href="../index.html"/>
        <link rel="up" title="ZOO-Client" href="index.html"/>
        <link rel="next" title="Using ZOO-Client" href="howto.html"/>
        <link rel="prev" title="ZOO-Client" href="index.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-nav-search">
        

        
          <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>
        

        
        </a>

        
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

        
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
        
          
          
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../intro.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../intro.html#what-is-zoo-project">What is ZOO-Project ?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../intro.html#zoo-project-components">ZOO-Project components</a></li>
<li class="toctree-l2"><a class="reference internal" href="../intro.html#open-source">Open Source</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../install/index.html">ZOO-Project installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../install/install-prerequisites.html">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="../install/install-download.html">Download</a></li>
<li class="toctree-l2"><a class="reference internal" href="../install/install-confoptions.html">Configure options</a></li>
<li class="toctree-l2"><a class="reference internal" href="../install/install-installation.html">Installation on Unix/Linux</a></li>
<li class="toctree-l2"><a class="reference internal" href="../install/install-onwindows.html">Installation on Windows ™</a></li>
<li class="toctree-l2"><a class="reference internal" href="../install/install-onmacos.html">Installation on MacOSX ™</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../kernel/index.html">ZOO-Kernel</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../kernel/what.html">What is ZOO-Kernel ?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../kernel/configuration.html">ZOO-Kernel configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../kernel/mapserver.html">Optional MapServer support</a></li>
<li class="toctree-l2"><a class="reference internal" href="../kernel/orfeotoolbox.html">Optional Orfeo Toolbox support</a></li>
<li class="toctree-l2"><a class="reference internal" href="../kernel/sagagis.html">Optional SAGA GIS support</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../services/index.html">ZOO-Services</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../services/what.html">What are ZOO-Services ?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../services/zcfg-reference.html">ZOO-Service configuration file</a></li>
<li class="toctree-l2"><a class="reference internal" href="../services/process-profiles.html">Process profiles registry</a></li>
<li class="toctree-l2"><a class="reference internal" href="../services/howtos.html">Create your own ZOO-Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="../services/status.html">ZOO Status Service</a></li>
<li class="toctree-l2"><a class="reference internal" href="../services/debug.html">Debugging ZOO Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="../services/zoo-services.html">Available ZOO-Services</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../api/index.html">ZOO-API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../api/what.html">What is ZOO-API ?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api/howto.html">Using ZOO-API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api/classes.html">ZOO-API Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api/examples.html">Examples</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">ZOO-Client</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="">What is ZOO-Client ?</a></li>
<li class="toctree-l2"><a class="reference internal" href="howto.html">Using ZOO-Client</a></li>
<li class="toctree-l2"><a class="reference internal" href="example.html">Example application</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contribute/index.html">Contributor Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../contribute/howto.html">How to contribute ?</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contribute/code.html">Contribute code</a></li>
</ul>
</li>
</ul>

          
        
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../contents.html">ZOO-Project</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">

    <li><a href="../contents.html"> Docs</a> &#8725; &#160;</li>
      
          <li><a href="index.html">ZOO-Client</a> &#8725; &#160;</li>
      
    <li>What is ZOO-Client ?</li>
      <li class="wy-breadcrumbs-aside">
        
          <a href="../_sources/client/what.txt" rel="nofollow"> View page source</a>
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document">
            
  <div class="section" id="what-is-zoo-client">
<span id="client-what"></span><h1>What is ZOO-Client ?<a class="headerlink" href="#what-is-zoo-client" title="Permalink to this headline">¶</a></h1>
<p>ZOO-Client is a client-side JavaScript API which provides simple methods
for interacting with <a class="reference external" href="http://www.opengeospatial.org/standards/wps/">WPS</a> server from web
applications. It is helpful for sending requests to any WPS compliant
server (such as <a class="reference internal" href="../kernel/index.html#kernel-index"><span>ZOO-Kernel</span></a>) and to parse the output responses
using simple JavaScript.</p>
<div class="section" id="javascript">
<h2>JavaScript<a class="headerlink" href="#javascript" title="Permalink to this headline">¶</a></h2>
<p>ZOO-Client relies on modern JavaScript libraries and can be seamlessly
integrated in new or existing web platforms or applications. ZOO-Client works by expanding the tags available in WPS specific
templates using values provided by a JavaScript hash or object. It
allows to build valid WPS requests and to send them to a WPS server. It
also provides functions to easily parse and reuse the output XML
responses. Read the <a class="reference internal" href="howto.html#client-howto"><span>next section</span></a> to get started.</p>
</div>
<div class="section" id="templates">
<h2>Templates<a class="headerlink" href="#templates" title="Permalink to this headline">¶</a></h2>
<p>ZOO-Client uses logic-less <a class="reference external" href="http://mustache.github.io/">Mustache</a>
templates for creating well-formed WPS requests. Templates are called
<em>logic-less</em> because they do not contain any <em>if</em> statements, <em>else</em>
clauses, or <em>for</em> loops, but only <strong>tags</strong>. Some tags are dynamically replaced by a
value or a series of values.</p>
<div class="section" id="getcapabilities">
<h3>GetCapabilities<a class="headerlink" href="#getcapabilities" title="Permalink to this headline">¶</a></h3>
<p><em>GetCapabilities</em> requests are created using the following template:</p>
<div class="highlight-python"><div class="highlight"><pre>&lt;wps:GetCapabilities xmlns:ows=&quot;http://www.opengis.net/ows/1.1&quot; xmlns:wps=&quot;http://www.opengis.net/wps/1.0.0&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:schemaLocation=&quot;http://www.opengis.net/wps/1.0.0 ../wpsGetCapabilities_request.xsd&quot; language=&quot;{{language}}&quot; service=&quot;WPS&quot;&gt;
 &lt;wps:AcceptVersions&gt;
     &lt;ows:Version&gt;1.0.0&lt;/ows:Version&gt;
 &lt;/wps:AcceptVersions&gt;
&lt;/wps:GetCapabilities&gt;
</pre></div>
</div>
</div>
<div class="section" id="describeprocess">
<h3>DescribeProcess<a class="headerlink" href="#describeprocess" title="Permalink to this headline">¶</a></h3>
<p><em>DescribeProcess</em> requests are created using the following template:</p>
<div class="highlight-python"><div class="highlight"><pre>&lt;DescribeProcess xmlns=&quot;http://www.opengis.net/wps/1.0.0&quot; xmlns:ows=&quot;http://www.opengis.net/ows/1.1&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:schemaLocation=&quot;http://www.opengis.net/wps/1.0.0 ../wpsDescribeProcess_request.xsd&quot; service=&quot;WPS&quot; version=&quot;1.0.0&quot; language=&quot;{{language}}&quot;&gt;
{{#identifiers}}
&lt;ows:Identifier&gt;{{.}}&lt;/ows:Identifier&gt;
{{/identifiers}}
&lt;/DescribeProcess&gt;
</pre></div>
</div>
</div>
<div class="section" id="execute">
<h3>Execute<a class="headerlink" href="#execute" title="Permalink to this headline">¶</a></h3>
<p><em>Execute</em> requests are created using a more complex template, as shown bellow:</p>
<div class="highlight-python"><div class="highlight"><pre>&lt;wps:Execute service=&quot;WPS&quot; version=&quot;1.0.0&quot; xmlns:wps=&quot;http://www.opengis.net/wps/1.0.0&quot; xmlns:ows=&quot;http://www.opengis.net/ows/1.1&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:schemaLocation=&quot;http://www.opengis.net/wps/1.0.0../wpsExecute_request.xsd&quot; language=&quot;{{language}}&quot;&gt;
&lt;!-- template-version: 0.21 --&gt;
     &lt;ows:Identifier&gt;{{Identifier}}&lt;/ows:Identifier&gt;
     &lt;wps:DataInputs&gt;
     {{#DataInputs}}
     {{#is_literal}}
             &lt;wps:Input&gt;
                     &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
                     &lt;wps:Data&gt;
                             &lt;wps:LiteralData{{#dataType}} dataType=&quot;{{dataType}}&quot;{{/dataType}}&gt;{{value}}&lt;/wps:LiteralData&gt;
                     &lt;/wps:Data&gt;
             &lt;/wps:Input&gt;
             {{/is_literal}}
             {{#is_bbox}}
             &lt;wps:Input&gt;
                     &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
                     &lt;wps:Data&gt;
                             &lt;wps:BoundingBoxData ows:crs=&quot;{{crs}}&quot; ows:dimensions=&quot;{{dimension}}&quot;&gt;
         &lt;ows:LowerCorner&gt;{{lowerCorner}}&lt;/ows:LowerCorner&gt;
         &lt;ows:UpperCorner&gt;{{upperCorner}}&lt;/ows:UpperCorner&gt;
      &lt;/wps:BoundingBoxData&gt;
                     &lt;/wps:Data&gt;
             &lt;/wps:Input&gt;
             {{/is_bbox}}
             {{#is_complex}}
             {{#is_reference}}
             {{#is_get}}
             &lt;wps:Input&gt;
                     &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
                     &lt;wps:Reference xlink:href=&quot;{{href}}&quot;{{#schema}} schema=&quot;{{shema}}&quot;{{/schema}}{{#mimeType}} mimeType=&quot;{{mimeType}}&quot;{{/mimeType}}{{#encoding}} encoding=&quot;{{encoding}}&quot;{{/encoding}}/&gt;
             &lt;/wps:Input&gt;
             {{/is_get}}
             {{#is_post}}
             &lt;wps:Input&gt;
                     &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
                     &lt;wps:Reference xlink:href=&quot;{{href}}&quot; method=&quot;{{method}}&quot;&gt;
                     {{#headers}}
                       &lt;wps:Header key=&quot;{{key}}&quot; value=&quot;{{value}}&quot; /&gt;
                       {{/headers}}
                       &lt;wps:Body&gt;{{{value}}}&lt;/wps:Body&gt;
                     &lt;/wps:Reference&gt;
             &lt;/wps:Input&gt;
             {{/is_post}}
             {{/is_reference}}
             {{^is_reference}}
             &lt;wps:Input&gt;
   &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
   &lt;wps:Data&gt;
     &lt;wps:ComplexData{{#schema}} schema=&quot;{{shema}}&quot;{{/schema}}{{#mimeType}} mimeType=&quot;{{mimeType}}&quot;{{/mimeType}}{{#encoding}} encoding=&quot;{{encoding}}&quot;{{/encoding}}&gt;{{#is_XML}}
      {{{value}}}{{/is_XML}}{{^is_XML}}&lt;![CDATA[{{{value}}}]]&gt;{{/is_XML}}
     &lt;/wps:ComplexData&gt;
   &lt;/wps:Data&gt;
 &lt;/wps:Input&gt;
 {{/is_reference}}
 {{/is_complex}}
 {{/DataInputs}}
     &lt;/wps:DataInputs&gt;
     &lt;wps:ResponseForm&gt;
     {{#RawDataOutput}}
     {{#DataOutputs}}
 &lt;wps:RawDataOutput mimeType=&quot;{{mimeType}}&quot;&gt;
   &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
 &lt;/wps:RawDataOutput&gt;
 {{/DataOutputs}}
 {{/RawDataOutput}}
 {{^RawDataOutput}}
 &lt;wps:ResponseDocument{{#storeExecuteResponse}} storeExecuteResponse=&quot;{{storeExecuteResponse}}&quot;{{/storeExecuteResponse}}{{#lineage}} lineage=&quot;{{lineage}}&quot;{{/lineage}}{{#status}} status=&quot;{{status}}&quot;{{/status}}&gt;
 {{#DataOutputs}}
 {{#is_literal}}
   &lt;wps:Output{{#dataType}} dataType=&quot;{{dataType}}&quot;{{/dataType}}{{#uom}} uom=&quot;{{uom}}&quot;{{/uom}}&gt;
     &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
   &lt;/wps:Output&gt;
   {{/is_literal}}
   {{^is_literal}}
   &lt;wps:Output{{#asReference}} asReference=&quot;{{asReference}}&quot;{{/asReference}}{{#schema}} schema=&quot;{{schema}}&quot;{{/schema}}{{#mimeType}} mimeType=&quot;{{mimeType}}&quot;{{/mimeType}}{{#encoding}} encoding=&quot;{{encoding}}&quot;{{/encoding}}&gt;
     &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
   &lt;/wps:Output&gt;
   {{/is_literal}}
   {{/DataOutputs}}
 &lt;/wps:ResponseDocument&gt;
 {{/RawDataOutput}}
 &lt;/wps:ResponseForm&gt;
 &lt;/wps:Execute&gt;
</pre></div>
</div>
</div>
</div>
</div>


          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="howto.html" class="btn btn-neutral float-right" title="Using ZOO-Client">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="index.html" class="btn btn-neutral" title="ZOO-Client"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>
  <div class="pfoot">
  <div role="contentinfo">
    <p>
        &copy; Copyright 2009-2015, ZOO-Project team.
    </p>
  </div>
  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>.
</div>
</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'1.4a0',
            COLLAPSE_INDEX: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>

  

  
  
    <script type="text/javascript" src="../_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>