Changes between Version 11 and Version 12 of ZooWebSite/ZooServices/ZCFGReference
- Timestamp:
- Jan 16, 2011, 4:38:15 PM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ZooWebSite/ZooServices/ZCFGReference
v11 v12 3 3 [[TOC(noheading)]] 4 4 5 The ZOO Service configuration file (.zcfg) describes the service and will be parsed by the ZOO Kernel to know how to handle it. We will describe here what such a file contains. You can also take a look at the existing examples of ZCFG file in the {{{cgi-env}}} directory of each services available on the ZOO-Project SVN source tree.5 The ZOO Service configuration file (.zcfg) describes the service and will be parsed by the ZOO Kernel to know how to handle it. We will describe here what such a file contains. You can also take a look at the existing examples of ZCFG file in the {{{cgi-env}}} directory of each services available on [browser:trunk/zoo-services the ZOO-Project SVN source tree]. 6 6 7 7 A ZOO Configuration file is divided in three distinct sections : … … 15 15 == Main metadata informations == 16 16 17 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 your services provider code. 17 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 your services provider code. In most case, this name is also the name of the ZCFG file without the "{{{.zcfg}}}" extension. 18 18 19 19 You can see bellow a description of the main metadata informations: … … 100 100 === !LiteralData node === 101 101 102 A {{{<LiteralData>}}} node get one {{{<Default>}}}, zero or more {{{<Supported>}}} node depending on the existence or 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). {{{<Default>}}} and {{{<Supported>}}} nodes can get the following property : {{{uom}}} to define which UOM havto be used for this input value.102 A {{{<LiteralData>}}} node get one {{{<Default>}}}, zero or more {{{<Supported>}}} node depending on the existence or the number of supported Unity Of Mesures (UOM) and a {{{dataType}}} property. The {{{dataType}}} property define the type of literal data, a string, an interger and so on (consult [http://www.w3.org/TR/xmlschema-2/#built-in-datatypes the complete list] of supported data types). {{{<Default>}}} and {{{<Supported>}}} nodes can get the {{{uom}}} property to define which UOM have to be used for this input value. 103 103 104 104 For input {{{<LiteralData>}}} nodes, you can add the {{{value}}} property to the {{{<Default>}}} node 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.