Orbeon Forms
Search…
⌃K

Services

Introduction

Form Runner supports implementing services using XPL (the XML pipeline language), associated with an application or a specific form.
NOTE: This is an advanced feature which requires programming.

Mapping an XPL file to a service URL

Assuming the following:
  • App name: acme
  • Form name: order
If you place a file called foo.xpl under
WEB-INF/resources/form/acme/service/
A service called foo is made available the following URL:
/fr/service/custom/acme/foo
Similarly, if you place a file called bar.xpl under
WEB-INF/resources/form/acme/order/service/
A service called bar is made available the following URL:
/fr/service/custom/acme/order/bar

Implementation of the service

The XPL has the following interface:
  • instance input: contains the XML data POSTed to the service URL
  • data output: XML data produced by the service
The following example XPL just echoes the incoming data:
<p:config
xmlns:p="http://www.orbeon.com/oxf/pipeline"
xmlns:oxf="http://www.orbeon.com/oxf/processors">
<p:param type="input" name="instance"/>
<p:param type="output" name="data"/>
<p:processor name="oxf:identity">
<p:input name="data" href="#instance"/>
<p:output name="data" ref="data"/>
</p:processor>
</p:config>