Changes between Version 6 and Version 7 of ZooWebSite/ZooServices/ZCFGReference

Timestamp:

Jan 16, 2011, 5:46:33 AM (14 years ago)

Author:

djay

Comment:

Small modifications

ZooWebSite/ZooServices/ZCFGReference

@@ -1 @@
-= .zcfg Reference =
+= ZOO Configuration File Reference =
 
-.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.
+The ZOO Service configuration file (.zcfg) describes the service and will be parsed by ZOO Kernel to know how to handle it. You can use the generic example bellow to compose your own .zcfg files, and take a look at working examples on the ZOO-Project SVN source tree.
 
 A ZOO Configuration file is divided in three distinct sections :
@@ -13 +13 @@
 == 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.
+The fist part in a ZOO Configuration contains the metadata informations relatives to the service. Note that the "name of your service", between bracket on the first line, have to be the exact same name as the function you defined in you service code.
+
+You can see bellow a description of the main metadata informations:
 {{{
 #!Lineno
@@ -22 +24 @@
 storeSupported = true/false
 statusSupported = true/false
-serviceType = the programming language used to implement the service (C/Python/Java/PHP/Fortran/Javascript)
-serviceProvider = Name of your service provider (.zo)
+serviceType = the programming language used to implement the service (C/Fortran/Python/Java/PHP/Javascript)
+serviceProvider = name of your services provider (shared library/Python Module/Java Class/PHP Script/JavaScript script)
 <MetaData>
   title = Metadata title of your service
@@ -31 +33 @@
 == List of Inputs ==
 
-The list of inputs your service can handle, it contains metadata informations of each services and it is a {{{<DataInputs>}}} node.
+The list of inputs contains metadata information of each defined input and it is a {{{<DataInputs>}}} node.
 
-A tipical list of inputs ({{{<DataInputs>}}}) look like the following:
+A typical list of inputs ({{{<DataInputs>}}}) look like the following:
 {{{
 #!Lineno
@@ -52 +54 @@
 }}}
 
+Note that you can add {{{<MetaData>}}} node as in the main metadata information.
+
 == List of Outputs ==
 
+The list of outputs is similar to a list of inputs except it is designed as a {{{<DataOutputs>}}} node.
+
+A typical {{{<DataOutputs>}}} node look like the following:
 {{{
 #!Lineno
@@ -69 +76 @@
 
 You can define your data as:
-  * LiteralData 
-  * BoundingBoxData
-  * ComplexData
+  * [#LiteralDatanode LiteralData] 
+  * [#BoundingBoxDatanode BoundingBoxData]
+  * [#ComplexDatanode ComplexData]
 
-=== LiteralData node ===
+Each Type Of Data node have at least one {{{<Default>}}} and one {{{<Supported>}}} node. Even if one of those are empty it has to be present as an opening and closing tag.
 
-A tipical {{{<LiteralData>}}} node look like the following:
+=== !LiteralData node ===
 
+A {{{<LiteralData>}}} node get one {{{<Default>}}}, one or more {{{<Supported>}}} node depending on the number of Unity Of Mesures (UOM) and a {{{dataType}}} property. The {{{dataType}}} property define the type of literal data, a string, an interger and so on ([http://www.w3.org/TR/xmlschema-2/#built-in-datatypes complete list] of supported data types).
+
+For input {{{<LiteralData>}}} nodes, you can add value to the {{{<Default>}}} properties to define a default value for this input. This means that when your Service will be run even if the input wasn't defined, this default value will be set as the current value for this input.
+
+A typical {{{<LiteralData>}}} node look like the following:
 {{{
 #!Lineno
 <LiteralData>
-  DataType = float
+  dataType = float
   <Default>
     uom = meters
-    value = 10
   </Default>
   <Supported>
@@ -91 +102 @@
 }}}
 
-=== BoundingBoxData node ===
+=== !BoundingBoxData node ===
 
-A {{{<BoundingBoxData>}}} node contains one {{{<Defautl>}}} node defining the default Coordinate Reference Systems (CRM) and same number of {{{<Supported>}}} nodes as number of CRM your service support (note that you can also use a list of supported CRS separated them by coma in only one {{{<Supported>}}} node.
+A {{{<BoundingBoxData>}}} node contains one {{{<Defautl>}}} node getting a CRS property defining the default Coordinate Reference Systems (CRS) and one or more {{{<Supported>}}} nodes depending on the number of CRS your service support (note that you can also use a list of supported CRS separated them by coma in only one {{{<Supported>}}} node).
 
 A tipical {{{<BoundingBoxData>}}} node, for two supported CRM ([http://www.epsg-registry.org/indicio/query?request=GetRepositoryItem&id=urn:ogc:def:crs:EPSG::4326 EPSG:4326] and [http://www.epsg-registry.org/indicio/query?request=GetRepositoryItem&id=urn:ogc:def:crs:EPSG::3785 EPSG:3785] ), look like the following:
@@ -112 +123 @@
 }}}
 
-=== ComplexData node ===
+=== !ComplexData node ===
+
+A ComplexData node get a {{{<Default>}}} and one or more {{{<Supported>}}} nodes depending on the number of supported format. A format is this set of properties : {{{mimeType}}}, {{{encoding}}} and optionaly {{{schema}}}.
+
+For output ComplexData nodes, you can add the {{{extension}}} property to define what extension to use to name the file when storing the result is required. Obviously, you'll have to add the extension to each supported format. You can also add the {{{asReference}}} property for each input to define if the output should be stored on server side per default. Note, that the client can always modify this behavior setting {{{asReference}}} attribute to {{{true}}} or {{{false}}} for this output in the {{{ResponseDocument}}}.
+
+You can see above a sample ComplexData node for default {{{application/json}}} and {{{text/xml}}} mimeTypes support:
 {{{
 #!Lineno