Changeset 967 for trunk/docs/services/howtos.rst

Timestamp:

Dec 18, 2020, 2:13:22 PM (3 years ago)

Author:

djay

Message:

Add support for the two inputs / outputs syntaxes discussed in SWG in both the ZOO-Kernel and the HTML basic UI. Update documentation, add a section for the ZOO-API in Python language section. Rename variables in service.c to ease readabiliy.

File:

• trunk/docs/services/howtos.rst (modified) (4 diffs)

trunk/docs/services/howtos.rst

@@ -27 +27 @@
 
 You'll find here information needed to deploy your own Python Services Provider.
+
+ZOO-API
+*******
+
+From your python module where you define your services, you can access
+the ZOO-API by importing the ``zoo`` module. No need to install
+anything here, the module will be automatically created from the
+ZOO-Kernel code at runtime.
+
+The following attributes are available from the ZOO-API :
+
+SERVICE_SUCCEEDED
+    Value to return in case your service end successfully.
+SERVICE_FAILED
+    Value to retrun in case of failure.
+    
+
+The following functions are defined in the ZOO-API:
+
+_(strToTranslate)
+    return the translated string (using the "zoo-service" `textdomain
+    <http://www.gnu.org/software/libc/manual/html_node/Locating-gettext-catalog.html#index-textdomain>`__)
+
+update_status(dictConf,iPourcent)
+    update the status of the running service
 
 Python ZCFG requirements
@@ -102 +127 @@
   {
   'variable_name': {'minOccurs': '1',
-                    'DataType': 'string',
+                    'dataType': 'string',
                     'value': 'this_is_the_value',
                     'maxOccurs': '1',
@@ -118 +143 @@
 
   {
-  'result': {'DataType': 'string',
+  'result': {'dataType': 'string',
              'inRequest': 'true',
             }
@@ -157 +182 @@
 
 The ZOO-API for the PHP language is automatically available from your
-service code. Tthe following functions are defined in the ZOO-API:
+service code. The following functions are defined in the ZOO-API:
 
 int zoo_SERVICE_SUCCEEDED()