Editing Webservice CMDI Metadata

From WebLichtWiki

(Difference between revisions)
Jump to: navigation, search
(Created page with "For a webservice to be usable in WebLicht it must have an orchestration description in a CMDI format designed for WebLicht webservices. To make this process easier a CMDI orch...")
 
Line 16: Line 16:
 
* When creating feature names:
 
* When creating feature names:
 
** use the suggested feature names whenever possible
 
** use the suggested feature names whenever possible
−
** do not use the same feature name twice
+
** do not use the same feature name twice within the same table (input/output)
 +
 
 +
* When creating value names:
 +
** use the suggested value names whenever possible
 +
** do not use the same value name twice within a feature
 +
 
 +
'' Input value arguments'' represent the query string parameters value that is being added to the webservice URL when the webservice is executed by WebLicht. The query string parameter name can be specified for any input feature.
 +
 
 +
* When editing input value arguments:
 +
** if a feature has an argument (query string parameter) all its values must have arguments.
 +
** if a feature has no values it can not have an argument.
 +
** if a feature has only one value, having an argument makes not sense, since the same query string parameter will be supplied to the webservice all the time, the same effect could be achieved by supplying it in the URL.
 +
 
 +
* When editing output value input references:
 +
** Multiple values cannot refer to the same input value
  
 
==Error Codes==
 
==Error Codes==

Revision as of 16:26, 11 December 2012

For a webservice to be usable in WebLicht it must have an orchestration description in a CMDI format designed for WebLicht webservices. To make this process easier a CMDI orchestration metadata editing tool was created. It can be found here (coming soon).

Contents

Using the COMET editing tool

In the front page you are presented with a choice of uploading an exiting CMDI file or creating a new one either starting from scratch or from an existing CMDI. Once this choice is made you will be redirected to the editing page. This page is split into two sections as described below.

General Information

In this section general information about the webservice is edited. Please make sure to fill all the fields. If any of the fields is highlighted in red, an error has occurred. In the accompanying error message the precise nature of the error will be explained. Pay particular attention to the PID field which must contained a unique PID for your webservice. Some fields are greyed out, that means that they will be filled in automatically.

Orchestration Information

This section is dedicated to the orchestration metadata used by WebLicht to chain the webservice. The orchestration metadata view is split into two tables, one for input and one for output. The editor is designed to assist you in the registration process, but one must still have the basic understanding of the chaining process to edit the orchestration metadata.

Follow these general guidelines when editing orchestration metadata:

  • When creating feature names:
    • use the suggested feature names whenever possible
    • do not use the same feature name twice within the same table (input/output)
  • When creating value names:
    • use the suggested value names whenever possible
    • do not use the same value name twice within a feature

Input value arguments represent the query string parameters value that is being added to the webservice URL when the webservice is executed by WebLicht. The query string parameter name can be specified for any input feature.

  • When editing input value arguments:
    • if a feature has an argument (query string parameter) all its values must have arguments.
    • if a feature has no values it can not have an argument.
    • if a feature has only one value, having an argument makes not sense, since the same query string parameter will be supplied to the webservice all the time, the same effect could be achieved by supplying it in the URL.
  • When editing output value input references:
    • Multiple values cannot refer to the same input value

Error Codes