= ZCFG : the ZOO Service Configuration File = [[TOC(noheading)]] 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. 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 Service Configuration File is case sensitive.''' == Main metadata informations == 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. You can see bellow a description of the main metadata informations: {{{ #!Lineno [Name of your service] Title = Title of your service Abstract = Description of your service processVersion = Version number of your service storeSupported = true/false statusSupported = true/false 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) title = Metadata title of your service }}} == List of Inputs == The list of inputs contains metadata information of each supported input and they are grouped using a {{{}}} node. Each input is defined as : * a name (between brackets as for the name of the service before) * various medata properties ({{{Title}}}, {{{Abstract}}}, {{{minOccurs}}} and {{{maxOccurs}}}) * a Type Of Data node ([#TypeOfDataNodes description]) A typical list of inputs ({{{}}}) look like the following: {{{ #!Lineno [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 [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 }}} Note that you can add {{{}}} node as in the main metadata information. == List of Outputs == The list of outputs is very similar to a list of inputs except it is designed as a {{{}}} node. A typical {{{}}} node look like the following: {{{ #!Lineno [Name of the output] Title = Title of the output Abstract = Description of the output }}} == Type Of Data Nodes == From the begining of this ZCFG presentation, we spoke about "Type Of Data Nodes" to describe data type of inputs and outputs. You can define your data as: * [#LiteralDatanode LiteralData] * [#BoundingBoxDatanode BoundingBoxData] * [#ComplexDatanode ComplexData] Except for {{{LiteralData}}}, each Type Of Data node have at least one {{{}}} and one {{{}}} node. Even if one of those are empty, it '''has to be present''' as an opening and closing tag on two different line. So, something like the following: {{{ #!Lineno }}} In other case, ZOO-Kernel won't be able to parse your ZCFG and will fail to process requests. === !LiteralData node === A {{{}}} node get one {{{}}}, zero or more {{{}}} 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). {{{}}} and {{{}}} nodes can get the following property : {{{uom}}} to define which UOM hav to be used for this input value. For input {{{}}} nodes, you can add the {{{value}}} property to the {{{}}} 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. A typical {{{}}} node, defining a {{{float}}} data type using meters or degree UOM, look like the following: {{{ #!Lineno dataType = float uom = meters uom = feet }}} === !BoundingBoxData node === A {{{}}} node contains one {{{}}} node getting a CRS property defining the default Coordinate Reference Systems (CRS) and one or more {{{}}} 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 {{{}}} node). A tipical {{{}}} 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: {{{ #!Lineno CRS = urn:ogc:def:crs:EPSG:6.6:4326 CRS = urn:ogc:def:crs:EPSG:6.6:4326 CRS = urn:ogc:def:crs:EPSG:6.6:3785 }}} === !ComplexData node === A !ComplexData node get a {{{}}} and one or more {{{}}} 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}}} property to each supported format ( {{{}}} and {{{}}} nodes). You can also add the {{{asReference}}} property to the {{{}}} node to define if the output should be stored on server side per default. Note, that the client can always modify this behavior by setting {{{asReference}}} attribute to {{{true}}} or {{{false}}} for this output in the request {{{ResponseDocument}}} parameter. You can see above a sample !ComplexData node for default {{{application/json}}} and {{{text/xml}}} (encoded in UTF-8 or base64) mimeTypes support: {{{ #!Lineno mimeType = application/json encoding = UTF-8 mimeType = text/xml encoding = base64 schema = http://fooa/gml/3.1.0/polygon.xsd mimeType = text/xml encoding = UTF-8 schema = http://fooa/gml/3.1.0/polygon.xsd }}}