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

Timestamp:

Jan 16, 2011, 4:44:26 AM (14 years ago)

Author:

djay

Comment:

First version containing examples

ZooWebSite/ZooServices/ZCFGReference

@@ -3 +3 @@
 .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.
 
+A ZOO Configuration file is divided in three distinct sections :
+
+   * Main metadata informations
+   * List of Inputs metadata informations
+   * List of Outputs metadata informations
+
+'''The ZOO Configuration File is case sensitive.'''
+
+== Main metadata informations ==
+
+The 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.
 {{{
-#!python
+#!Lineno
 [Name of your service]
 Title = Title of your service
@@ -11 +22 @@
 storeSupported = true/false
 statusSupported = true/false
-serviceType = C/Python/Java/PHP/Fortran/Javascript
+serviceType = the programming language used to implement the service (C/Python/Java/PHP/Fortran/Javascript)
 serviceProvider = Name of your service provider (.zo)
-‹MetaData lang="en"›
-title = Metadata title of your service
-‹/MetaData›
-‹DataInputs›
-[F]
-Title = Format of the input data
-Abstract = Select the input format.
-minOccurs = 0
-maxOccurs = 1
-‹LiteralData›
-DataType = Data type of your service InputData (string)
-‹Default›
-value = Default InputData format for your service
-‹/Default›
-‹Supported›
-value = Supported InputData formats for your service
-‹/Supported›
-‹/LiteralData›
-[InputDSN]
-Title = Input data source name
-Abstract = Description of the input data source name
-minOccurs = 1
-maxOccurs = 1
-‹LiteralData›
-DataType = Type of the input data source (string)
-‹Default›
-uom = Default unit for your input data source
-‹/Default›
-‹Supported›
-value = Supported format for your input data source
-‹/Supported›
-‹/LiteralData›
-[OutputDSN]
-Title = Output data source name
-Abstract = Description of your output data source
-minOccurs = 1
-maxOccurs = 1
-‹LiteralData›
-DataType = Type of the input data source (string)
-‹Default›
-uom = Default unit for your input data source
-‹/Default›
-‹Supported›
-value = Supported format for your input data source
-‹/Supported›
-‹/LiteralData›
-‹/DataInputs›
-‹DataOutputs›
-[OutputedDataSourceName]
-Title = Name of the resulting file
-Abstract = Description of the resulting file
-‹LiteralData›
-DataType = Type of the output data source (string)
-‹Default›
-uom = Default unit for your output data source
-‹/Default›
-‹Supported›
-value = Supported format for your output data source
-‹/Supported›
-‹/LiteralData›
-‹/DataOutputs›
+<MetaData>
+  title = Metadata title of your service
+</MetaData>
 }}}
+
+== List of Inputs ==
+
+The list of inputs your service can handle, it contains metadata informations of each services and it is a {{{<DataInputs>}}} node.
+
+A tipical list of inputs ({{{<DataInputs>}}}) look like the following:
+{{{
+#!Lineno
+<DataInputs>
+  [Name of the first input]
+    Title = Title of the first input
+    Abstract = Abstract describing the first input
+    minOccurs = Minimum occurence of the first input
+    maxOccurs = Maximum occurence of the first input
+    <Type Of Data Node />
+  [Name of the second input]
+    Title = Title of the second input
+    Abstract = Abstract describing the second input
+    minOccurs = Minimum occurence of the second input
+    maxOccurs = Maximum occurence of the second input
+    <Type Of Data Node />
+</DataInputs>
+}}}
+
+== List of Outputs ==
+
+{{{
+#!Lineno
+<DataOutputs>
+  [Name of the output]
+    Title = Title of the output
+    Abstract = Description of the output
+    <Type Of Data Node />
+</DataOutputs>
+}}}
+
+== Type Of Data Nodes ==
+
+From the begining we spoke about Type Of Data Nodes to describe data type of inputs and outputs.
+
+You can define your data as:
+  * LiteralData 
+  * BoundingBoxData
+  * ComplexData
+
+=== LiteralData node ===
+
+{{{
+#!Lineno
+<LiteralData>
+  DataType = float
+  <Default>
+    uom = meters
+    value = 10
+  </Default>
+  <Supported>
+    uom = feet
+  </Supported>
+</LiteralData>
+}}}
+
+=== BoundingBoxData node ===
+
+{{{
+#!Lineno
+<BoundingBoxData>
+  <Default>
+    CRS = urn:ogc:def:crs:EPSG:6.6:4326
+  </Default>
+  <Supported>
+    CRS = urn:ogc:def:crs:EPSG:6.6:4326
+  </Supported>
+  <Supported>
+    CRS = urn:ogc:def:crs:EPSG:6.6:27573
+  </Supported>
+</BoundingBoxData>
+}}}
+
+=== ComplexData node ===
+{{{
+#!Lineno
+<ComplexData>
+  <Default>
+    mimeType = application/json
+    encoding = UTF-8
+  </Default>
+  <Supported>
+    mimeType = text/xml
+    encoding = base64
+    schema = http://fooa/gml/3.1.0/polygon.xsd
+  </Supported>
+  <Supported>
+    mimeType = text/xml
+    encoding = UTF-8
+    schema = http://fooa/gml/3.1.0/polygon.xsd
+  </Supported>
+</ComplexData>
+}}}