Comments? Feedback?

This wiki does not yet support public comments (a limitation of Google Sites), so we encourage you to post your comments on Twitter by responding to @orbeon.

Recent site activity

Configuration Properties


Overview

Orbeon can be configured with a number of properties. The default values for those properties are provided in 4 files:
  • config/properties-form-base.xml
  • config/properties-xforms.xml
  • config/properties-form-runner.xml
  • config/properties-form-builder.xml

Overriding properties

Instead of directly modifying the above files, the recommended way is to create a file called config/properties-local.xml . Any property defined in that file overrides properties in the standard property files.

By following this advice, you avoid modifying files that ships with Orbeon Forms, which makes upgrading to newer versions of Orbeon Forms easier.

If you don't already have a file called config/properties-local.xml:
  • Copy config/properties-local.xml.template. to config/properties-local.xml.
  • Add your own properties to config/properties-local.xml
NOTE: config/properties-local.xml.template. is initially an empty template for config/properties-local.xml. We recommend you do not modify config/properties-local.xml.template.

Wildcards in properties

Some properties support wildcards ("*" characters). In general these are used with Form Runner or Form Builder and in these cases:
  • The first wildcard matches a forms "application name"
  • The second wildcard matches a forms "form name"

Defining your own properties

In addition to the properties described below, you can define your own properties. You can then access them from:
  • XPath expressions in XForms with xxforms:property().
  • XPath expressions in XPL with p:property(), where the prefix p is mapped to the namespace http://www.orbeon.com/oxf/pipeline.
  • XPath expressions in XSLT with pipeline:property(), where the prefix pipeline is mapped to namespace java:org.orbeon.oxf.processor.pipeline.PipelineFunctionLibrary.
In all cases, for security reasons, those functions won't return the value of properties that contain the string "password" in the name of the property.