From Knowledge Center
1. Define credentials
Help
First choose one of the protocols REST, Linked Data or SOAP depending on the web service you like to use. Enter the URL of the web service. If you use a SOAP web service, the address (URL) has to direct to a WSDL file (e. g. http://domain.de/soap_webservice.wsdl). If you use a RESTful web service or a Linked Data source, the value for the URL parameter is optional. You can pass the URL later when you call the web service. Define optionally authentication credentials, when the defined URL requires authentication. Note that currently only the basic HTTP authentication is supported.
2. Select method
Help
Each web service provides different methods, which deliver different types of data. If you like to use several methods of one web service, then you have to define for each method a new WWSD.
Help
Choose one of the methods HTTP-get or HTTP-postfor calling the web service. In most cases HTTP-get is appropriate.3. Define parameters
| Note: | Some of the type-definitions used in this WSDL are ambiguous. Those type definitions are highlighted in darkred. It is strongly recommended that you review and edit them later in the textual representation of the WWSD. |
| Path: | Use: | Alias:  | Optional: | Default value: |
|---|
Help
Each parameter is identified by a path, which addresses it in the parameter type hierarchy and an alias, which displaces the path of the parameter. Alias are necessary to use parameters later in an easy way. Browse the parameters by expanding and collapsing the type hierarchy in the tree view. Web services with a plain hierarchy don’t have a tree view.
In some cases it is not necessary to pass a value for each parameter when calling a web service. If you do not need a parameter, leave it empty or mark it as optional. Activate the ‘Use’-Checkboxes, to include the parameters into the WWSD. Thus users are later able to provide values for parameters when calling the web service.
You can use the “Auto generate alias” function 
to generate an alias based on the selected parameter. If a parameter is not required for the web service, you can mark this parameter as optional. Mark a parameter as optional, if users call the web service without passing a value for this parameter. Otherwise users will get an error message.
Define a default value for a parameter, this value will be used if a parameter is not optional and if no value for that parameter was passed to the web service call.
Subparameters are child nodes of parameters, they may be useful for handling complex parameters. Normally, subparameters are not needed. Click the Plus sign to add a subparameter. Visit the online help for more information.
Help
Click on Add parameter and the table for defining parameters will be displayed. Enter the path of the parameter. If you do not enter a path for a parameter, then this parameter will not be included into the WWSD. Enter an alias for the parameter; otherwise the parameter path will be used as alias.
If a parameter is not required for the web service, you can mark this parameter as optional. Mark a parameter as optional, if users call the web service without passing a value for this parameter. Otherwise users will get an error message.
Define a default value for a parameter; this value will be used if a parameter is not optional and if no value for that parameter was passed to the web service call.
Subparameters are child nodes of parameters; they may be useful for handling complex parameters. Normally, subparameters are not needed. Click on the Plus icon to add a subparameter. Visit the online help for more information.4. Choose result parts
| Note: | Some of the type-definitions used in this WSDL are ambiguous. Those type definitions are highlighted in darkred. It is strongly recommended that you review and edit them later in the textual representation of the WWSD. |
| Path: | Use: | Alias: | Format: | Path: |
|---|
Namespace prefixes:| Prefix: | URL: |
|---|
| Enable triplification | ||
| Subject creation pattern: | Add result parts to subject creation pattern Finish adding result partsClick on an alias input field to add the corresponding result part to the subject creation pattern. |
Help
Define the result parts to display in Wiki articles. Activate the ‘Use’-Checkboxes, if users later should be able to use the selected result part it in a Wiki article. Each result part is identified by a path, which addresses it in the result type hierarchy and an alias, which displaces the path of the parameter.
If the result parts contain information encoded in XML or JSON, add subpaths to extract the relevant information. Subpaths can have the JSON or XPath format. (Currently only the XPath format is supported.) Enter the path to the information you like to extract. Add an alias to each subpath. Manually defined result parts will be displayed below a grey line in editing mode.
Help
Define which result parts of the web service the user should be able to use later in wiki articles. RESTful web services return a string as their result. This string can be a simple text or it can contain information encoded in a format like JSON or XML for example. Activate the Use complete result as result part checkbox, if you like to import the complete results of the web service. To define further result parts, click on Add result parts. Define which further parts of this result users should be able to display in Wiki articles. Enter an alias for each result part. This alias will later be used to address the result part when the web service is called within an article. If you do not specify an alias, then a random one will be created.
Choose the JSON, the XPath or the property format depending on the path you like to use for extracting result parts. Enter the path which will be used to extract the result part from the complete result. The property format can be used, if the web service result is encoded in one of the RDF serializations, e.g. RDF/XML or RDFa. Then the value of the path has to be a URI of a triple property.
If you use the property format for one of your result parts, the Add namespace prefixes button will be displayed. Click the button to define namespace prefixes in a table, which you then can use when defining result parts. Define a namespace prefix for Linked Data instead of using the complete URI. Use e.g. the prefix dbpedia for the URI http://dbpedia.org/.../
Help
Linked Data sources are encoded in one of the RDF serializations, e.g. RDF/XML or RDFa. Special result parts, e.g. for extracting all subjects, properties and objects, which occur in one of the triples, are generated by the system by default. You can use these later, when calling the web service in an article via the allSubjects, allProperties or allObjects aliases.
Click the Add result parts link, to define further result parts for certain properties. Define in the table which further parts of this result users should be able to display in Wiki articles. Enter an alias for each result part. This alias will later be used to address the result part when the web service is used in an article. If you do not specify an alias, then a random one will be created.
Enter the URI of the property which should be extracted. Press the Add namespace prefixes button if you want to define namespace prefixes. A table will be shown where you can define namespace prefixe, which you then can use when defining result parts.
5. Define update policy
| Display policy: | OnceMax age | days hours minutes |
| Query policy: | OnceMax age | days hours minutes |
| Delay value (in seconds): | ||
| Span of life (in days): | Expires after update: YesNo |
Help
The update policies define the time period for updating the results delivered by a web service. Choose the display policy for displaying results in an article. E. g. if the display policy is set to a max age of 2 days the results of the web service call will be display the cached web service results for 2 days. After that period the web service will be called again and the cached results will be replaced with the new ones. Otherwise the web service will be called again and the cached result will be replaced. The display policy once means that the web service result will never be updated. Choose the query policy for semantic queries, this updates the gardening bots in your Wiki.
The delay value (in seconds) is applied between two subsequent calls of a web service. So you can prevent, calling a web service too often in a short time, which may violate the terms of use of the web service provider. The span of life defines how long a result of a web service call will be kept in the cache. Providing no value, web service results will be kept in the cache for an unlimited time span. Depending on defined span of life, you can appoint the expiry of the cached results. If the cached results should expire after their last update, choose ‘No’. If they should expire after their last access (e. g. by viewing an article), choose ‘Yes’.
6. Save Wiki Web Service Definition
Help
Enter name of the web service.
Now you can use that web service in an article. You can do that manually by using the #ws parser function or via the GUI for using a web service. This GUI is available via the semantic toolbar.
Your web service will from now on be available in the list of available WebServices.
You can now go on and define another WWSD.
