Changes between Version 4 and Version 5 of ZooWebSite/ZooServices/ZCFGReference


Ignore:
Timestamp:
Jan 16, 2011, 4:44:26 AM (10 years ago)
Author:
djay
Comment:

First version containing examples

Legend:

Unmodified
Added
Removed
Modified
  • ZooWebSite/ZooServices/ZCFGReference

    v4 v5  
    33.zcfg is the ZOO Service configuration file which describes the service and being parsed by ZOO Kernel. You can use the generic example bellow to compose .zcfg files, and get working examples on the ZOO Trac.
    44
     5A ZOO Configuration file is divided in three distinct sections :
     6
     7   * Main metadata informations
     8   * List of Inputs metadata informations
     9   * List of Outputs metadata informations
     10
     11'''The ZOO Configuration File is case sensitive.'''
     12
     13== Main metadata informations ==
     14
     15The fist part in a ZOO Configuration containing the metadata informations relatives to the service. Note that the "name of your service" have to be the exact same name as the function you defined in you service code.
    516{{{
    6 #!python
     17#!Lineno
    718[Name of your service]
    819Title = Title of your service
     
    1122storeSupported = true/false
    1223statusSupported = true/false
    13 serviceType = C/Python/Java/PHP/Fortran/Javascript
     24serviceType = the programming language used to implement the service (C/Python/Java/PHP/Fortran/Javascript)
    1425serviceProvider = Name of your service provider (.zo)
    15 ‹MetaData lang="en"›
    16 title = Metadata title of your service
    17 ‹/MetaData›
    18 ‹DataInputs›
    19 [F]
    20 Title = Format of the input data
    21 Abstract = Select the input format.
    22 minOccurs = 0
    23 maxOccurs = 1
    24 ‹LiteralData›
    25 DataType = Data type of your service InputData (string)
    26 ‹Default›
    27 value = Default InputData format for your service
    28 ‹/Default›
    29 ‹Supported›
    30 value = Supported InputData formats for your service
    31 ‹/Supported›
    32 ‹/LiteralData›
    33 [InputDSN]
    34 Title = Input data source name
    35 Abstract = Description of the input data source name
    36 minOccurs = 1
    37 maxOccurs = 1
    38 ‹LiteralData›
    39 DataType = Type of the input data source (string)
    40 ‹Default›
    41 uom = Default unit for your input data source
    42 ‹/Default›
    43 ‹Supported›
    44 value = Supported format for your input data source
    45 ‹/Supported›
    46 ‹/LiteralData›
    47 [OutputDSN]
    48 Title = Output data source name
    49 Abstract = Description of your output data source
    50 minOccurs = 1
    51 maxOccurs = 1
    52 ‹LiteralData›
    53 DataType = Type of the input data source (string)
    54 ‹Default›
    55 uom = Default unit for your input data source
    56 ‹/Default›
    57 ‹Supported›
    58 value = Supported format for your input data source
    59 ‹/Supported›
    60 ‹/LiteralData›
    61 ‹/DataInputs›
    62 ‹DataOutputs›
    63 [OutputedDataSourceName]
    64 Title = Name of the resulting file
    65 Abstract = Description of the resulting file
    66 ‹LiteralData›
    67 DataType = Type of the output data source (string)
    68 ‹Default›
    69 uom = Default unit for your output data source
    70 ‹/Default›
    71 ‹Supported›
    72 value = Supported format for your output data source
    73 ‹/Supported›
    74 ‹/LiteralData›
    75 ‹/DataOutputs›
     26<MetaData>
     27  title = Metadata title of your service
     28</MetaData>
    7629}}}
     30
     31== List of Inputs ==
     32
     33The list of inputs your service can handle, it contains metadata informations of each services and it is a {{{<DataInputs>}}} node.
     34
     35A tipical list of inputs ({{{<DataInputs>}}}) look like the following:
     36{{{
     37#!Lineno
     38<DataInputs>
     39  [Name of the first input]
     40    Title = Title of the first input
     41    Abstract = Abstract describing the first input
     42    minOccurs = Minimum occurence of the first input
     43    maxOccurs = Maximum occurence of the first input
     44    <Type Of Data Node />
     45  [Name of the second input]
     46    Title = Title of the second input
     47    Abstract = Abstract describing the second input
     48    minOccurs = Minimum occurence of the second input
     49    maxOccurs = Maximum occurence of the second input
     50    <Type Of Data Node />
     51</DataInputs>
     52}}}
     53
     54== List of Outputs ==
     55
     56{{{
     57#!Lineno
     58<DataOutputs>
     59  [Name of the output]
     60    Title = Title of the output
     61    Abstract = Description of the output
     62    <Type Of Data Node />
     63</DataOutputs>
     64}}}
     65
     66== Type Of Data Nodes ==
     67
     68From the begining we spoke about Type Of Data Nodes to describe data type of inputs and outputs.
     69
     70You can define your data as:
     71  * LiteralData
     72  * BoundingBoxData
     73  * ComplexData
     74
     75=== LiteralData node ===
     76
     77{{{
     78#!Lineno
     79<LiteralData>
     80  DataType = float
     81  <Default>
     82    uom = meters
     83    value = 10
     84  </Default>
     85  <Supported>
     86    uom = feet
     87  </Supported>
     88</LiteralData>
     89}}}
     90
     91=== BoundingBoxData node ===
     92
     93{{{
     94#!Lineno
     95<BoundingBoxData>
     96  <Default>
     97    CRS = urn:ogc:def:crs:EPSG:6.6:4326
     98  </Default>
     99  <Supported>
     100    CRS = urn:ogc:def:crs:EPSG:6.6:4326
     101  </Supported>
     102  <Supported>
     103    CRS = urn:ogc:def:crs:EPSG:6.6:27573
     104  </Supported>
     105</BoundingBoxData>
     106}}}
     107
     108=== ComplexData node ===
     109{{{
     110#!Lineno
     111<ComplexData>
     112  <Default>
     113    mimeType = application/json
     114    encoding = UTF-8
     115  </Default>
     116  <Supported>
     117    mimeType = text/xml
     118    encoding = base64
     119    schema = http://fooa/gml/3.1.0/polygon.xsd
     120  </Supported>
     121  <Supported>
     122    mimeType = text/xml
     123    encoding = UTF-8
     124    schema = http://fooa/gml/3.1.0/polygon.xsd
     125  </Supported>
     126</ComplexData>
     127}}}

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png