oxf.xforms.renderer.contextparameter specifies the context into which you have deployed Orbeon Forms. By default, Orbeon forms deploys to
/orbeonso this value is usually safe. If you deploy Orbeon Forms to another context, you need to change this value accordingly.
<url-pattern>defined under the first
<filter-mapping>has the value
/xforms-jsp/*. This means that all the data generated by URLs starting with
/xforms-jsp/is post-processed by Orbeon Forms. You can change this value as desired.
<url-pattern>defined under the second
<filter-mapping>has the value
/orbeon/*value is related to the default context into which you deploy Orbeon Forms: if you change you context, you change this value as well.
oxf.xforms.renderer.default-encodingallows you to specify a default character encoding when the content provided by the servlet or JSP page doesn't specify one. Previously, the default character encoding was hardcoded to
ISO-8859-1. Since 4.6.1 the hardcoded default remains this, but you can change it with
oxf.xforms.renderer.default-encoding. The default Orbeon Forms web.xml overrides this default to
UTF-8, which is what most modern HTML uses.
xforms-jspin your WAR are processed by the XForms engine. However, it is likely that you will prefer another location. In that case, you just change the
/orbeon/directory, as that directory is reserved for Orbeon Forms resources.
web.xmlkicks in for those resources and that you produce well-formed XML as output. For this to happen, you modify the
<filter-mapping>accordingly to enable the filter for the URLs handled by your framework.
web.xml. It is not possible to access your application's XForms pages by accessing Orbeon Forms URLs directly: your application controls the generation of XForms content, not Orbeon Forms.
WEB-INF/lib/orbeon-xforms-filter.jarfrom the Orbeon Forms WAR into your application's
web.xmlas described in the previous section to setup the Orbeon Forms XForms filter.
orbeon``.war, you can remove:
WEB-INF/resources, except the directory
WEB-INF/resources``/configand its content. (This directory contains configuration files which you might want to change, in particular the properties files.)
weblogic.xml. (The application-server specific files contain an example of how to declare a data source, so you can safely remove those files even if they are for the application server you are using.)
request.getSession(), even if you're not going to store anything in that session.
HttpServletRequestobject which is passed to servlets (and also accessible in JSP through the
"oxf.xforms.renderer.document". It may contain XHTML and XForms as an XML Document Object Model (DOM), as a dom4j
Document, or as a String containing XML.
<xf:instance src="oxf:/path/file.xml">. You can also use XInclude to include arbitrary parts of your form with:
<xi:include href="``oxf:/path/file.xml">. The
oxf:scheme tells Orbeon Forms that the file is loaded from the resource directory, typically from
WEB-INF/resourcesinside the Orbeon Forms war file.
<xf:instance src="http://wiki.orbeon.com/file.xml">. If the URL for your form is
http://localhost/myapp/forms/registration.jsp, then Orbeon Forms will load the file to include from
http://localhost/myapp/forms/file.xml. Most likely this will work, but you will incur the cost of an additional HTTP request every time the page is loaded.
input:instanceURI to access XML data submitted to the current page:
PUT1. Page generates XForms 2. XForms is processed by the Orbeon filter and XForms engine 3. XForms engine has access to the submitted XML data through the
input:instanceURI 4. HTML is sent to the browser NOTE: In separate deployment, you can use
input:instanceonly if your JSP or servlet has not attempted to read the request body first!
<xf:submission>. Most of the time, XML is being posted to the service and XML is returned by the service. Since services take XML as input and generate XML, XML pipelines are an ideal tool to implement services.
web.xml, the Orbeon Forms XForms filter kicks in and intercepts the output of your JSP or servlet (whether produced the regular way or passed as a request attribute).
/xforms-rendererby extracting the XHTML and XForms document from the forwarded request.
/config/epilogue-servlet.xpl. The epilogue performs several tasks, including transforming XHTML and XForms into HTML that the browser can understand. The default configuration of this pipeline should be fine for most use cases, which means you usually don't need to worry about it.
/config/theme-plain.xsl. However, it does not perform further URL rewriting by default.
OrbeonXFormsFiltersets the following request attributes:
/xforms-jsp/guess-the-number/test.jsp- used for
xml:baseresolution by XForms