Loading...
 

History: Webservice Handler

View page Collapse Into Edit Sessions

Preview of version: 2

One of tikiwiki's new features is the ability to register webservices to be used by plugins. Combined with Plugin Alias Handler, this allows to create brand new plugins exploiting data from external systems.

Bugzilla Webservice example


This plugin would ask for the real data export URL for the webservice. This is not mandatory.

YAML
preferences:
 enable: [ wikiplugin_$profileobject:bugzilla_ws$ ]
objects:
 -
  type: webservice
  ref: bugzilla_ws
  data:
   name: $profilerequest:Webservice Name$bugzilla$
   url: $profilerequest:Bugzilla Webservice URL$http://example.com/bugzilla/json_export.pl?id=%bugid%$
   schema_version: 1.0
   schema_documentation: http://example.com/bugzilla_exporter/doc/1.0
 -
  type: webservice_template
  ref: base
  data:
   webservice: $bugzilla_ws
   name: base
   engine: smarty
   output: tikiwiki
   content: |
            Title: $profileobject:response.title$
            Status: $profileobject:response.status$
            Assigned to: $profileobject:response.assignee.full_name$
-
 type: plugin_alias
 ref: plugin
 data:
  name: $bugzilla_ws
  implementation: webservice
  description:
   name: Bugzilla
   description: Displays bugs from remote hosts
   prefs: [ wikiplugin_$profileobject:bugzilla_ws$ ]
   params:
    template:
     name: Template
     required: n
     description: Name of the template to use. Default to base.
    id:
     name: Bug ID
     required: y
     description: Bug number from Bugzilla
  body:
   input: ignore
   default: ""
  params:
   service: $bugzilla_ws
   template: base
   id: 0


Webservice Object

NameMandatoryValue
nameyesAlpha-only name of the webservice
urlyesURL of the web service with arguments entered as No value assigned
schema_version Schema version number disclosed by the web service
schema_documentation URL of the documentation for the web service


Webservice Template Object

NameMandatoryValue
webserviceyesWebservice to add the template to
nameyesAlpha-only name of the webservice
engineyesRendering engine used (smarty or javascript at this time)
outputyesOutput produced by the engine (tikiwiki or html)
contentyesTemplate content


History

Advanced
Information Version
Mon 13 of Sep, 2010 22:21 GMT-0000 Marc Laporte cleaner 7
Sat 20 of Dec, 2008 22:47 GMT-0000 Marc Laporte 6
Thu 25 of Sep, 2008 00:36 GMT-0000 Marc Laporte 5
Wed 24 of Sep, 2008 18:31 GMT-0000 Marc Laporte WebservicePlugin 4
Wed 24 of Sep, 2008 18:27 GMT-0000 System Administrator 3
Wed 24 of Sep, 2008 17:56 GMT-0000 System Administrator 2
Wed 24 of Sep, 2008 17:11 GMT-0000 System Administrator 1