Orbeon Forms
  • Getting started
  • Installation
    • Logging
    • Configuration banner
    • Docker
    • Azure
    • Tomcat
    • WildFly
    • WebSphere
    • WebLogic
    • GlassFish
    • Caches
    • Replication
    • Upgrading
  • Configuration
    • Properties
      • General
        • HTTP client
      • Form Runner
        • Detail page
          • Attachments
          • Email properties
          • PDF
          • Table of contents
        • Persistence
        • Summary page
      • Form Builder
      • XForms
    • Advanced
      • Workflows
      • Session management
      • State handling
      • Client-side error handling
      • Clustering and High Availability
      • Configuring a Form Runner eXist database
      • Creating a production WAR
      • Environments
      • JavaScript and CSS assets
      • Limiter filter
      • Run modes
      • Security
        • Content-Security-Policy header
      • SAP Hybris Module
      • XForms logging
    • Troubleshooting
      • Troubleshooting with the orbeon.log
      • Memory and threads
      • Relational database logging
      • Misc
  • Form Builder
    • Form settings
      • Time window
    • Form editor
      • Form area
      • Toolbox
      • Buttons bar
      • Control settings
      • Dependent fields and sections
      • Validation
      • Choices editor
      • Publishing
      • Cut, copy and paste
      • Section and grid settings
      • Section settings
      • Grid settings
      • Quick control search
      • Repeat settings
      • Repeated grids
      • Undo and redo
      • Keyboard shortcuts
    • Formulas
      • Examples of formulas
      • Formulas inspector
      • Formulas console
    • Summary page
    • Form localization
    • Advanced
      • Edit source
      • Services and actions
        • HTTP services
        • Database services
        • Simple Actions
        • Action Syntax
        • Action Syntax examples
        • Synchronizing repeated content
      • Testing a form in web mode
      • Testing PDF production
      • Testing offline functionality
      • Email Settings dialog
      • Field-level encryption
      • Messages
      • Section templates
      • Template syntax
      • XML Schemas support
      • Extensibility
        • Extension API
        • Integration
        • Toolbox component metadata
  • Form Runner
    • Overview
      • Terminology
    • Pages
      • Landing page
      • Published Forms page
      • Forms Admin page
      • Summary page
    • Components
      • Alert dialog
      • Attachment
      • Autocomplete
      • Captcha
      • Character counter
      • Checkbox input
      • Currency
      • Date
      • Dropdown date
      • Static and dynamic dropdown
      • Error summary
      • Grid
      • Handwritten signature
      • Hidden field
      • Image
      • Image annotation
      • Image attachment
      • Number
      • Open selection
      • Repeater
      • Formatted Text / Rich Text Editor
      • Section
      • Single-selection tree
      • Source code editor
      • Time
      • US phone
      • US state
      • Video
      • Video attachment
      • Wizard
      • XForms inspector
      • Yes/No answer
    • Features
      • Automatic calculations dependencies
      • Datasets
      • Excel and XML import
      • Excel and XML export
      • Summary page Excel Export
      • Form definitions and form data Zip Export
      • Purging historical data
      • Lease
      • Localization
      • Supported languages
      • Mobile support
      • Multitenancy
      • Form Runner navigation bar
      • PDF production
        • Automatic PDF
        • Automatic PDF header and footer configuration
        • PDF templates
      • Responsive design
      • Revision history
      • S3 storage
      • Simple data migration
      • TIFF production
      • Versioning
      • Wizard view
      • Workflow stage
    • Persistence
      • Using a relational database
      • Relational database schema
      • Purging old data using SQL
      • Auditing
      • Autosave
      • Database support
      • Flat view
    • Linking and embedding
      • Linking
      • Java Embedding API
      • JavaScript Embedding API
      • Liferay full portlet
      • Liferay proxy portlet
      • Securing Form Runner access
      • Form Runner offline embedding API
      • Angular component
      • React component
    • Access control and permissions
      • Users
      • Login & Logout
      • Deployed forms
      • Form fields
      • Editing forms
      • Owner and group member
      • Organizations
      • Scenarios
      • Token-based permissions
    • Styling
      • CSS
      • Grids CSS
      • Automatic PDF styling and CSS
    • APIs
      • Authentication of server-side service APIs
      • Persistence API
        • CRUD API
        • Search API
        • List form data attachments API
        • Form Metadata API
        • Lease API
        • Reindexing API
        • Caching
        • Versioning
        • Revision History API
        • Zip Export API
        • Custom persistence providers
      • Other APIs
        • Connection context API
        • Duplicate form data API
        • File scan API
        • Form Runner JavaScript API
        • Generate XML Schema API
        • PDF API
        • Publish form definition API
        • Run form in the background API
      • Data formats
        • Form data
        • Date and time
        • Form definition
    • Architecture and integration
      • Architecture
      • Access form data
      • Integration
    • Advanced
      • Buttons and processes
        • Simple process syntax
        • Core actions
        • Form Runner actions
          • Save action
          • Send action
          • Email action
        • XForms actions
        • Predefined buttons, processes and dialogs
        • Summary page buttons and processes
      • Custom dialogs/model logic
      • Services
      • Singleton form
      • Monitoring HTTP requests
  • XForms
    • Core
      • Attribute Value Templates (AVTs)
      • Binds
      • Validation
      • Variables
      • Keyboard focus
      • XForms JavaScript API
      • Error handling
        • Detailed behavior
      • Model-Bind variables
      • XForms 2.0 support
    • Events
      • Standard support
      • UI refresh events
      • Keyboard events
      • Extension events
      • Extension context information
      • Other event extensions
    • Actions
      • Repeat, insert and delete
      • Scripting actions
      • Extensions
    • Controls
      • Label, hint, help
      • Input
      • Output
      • Text area
      • Button
      • Upload
      • Dialog
    • Submission
      • Standard support
      • JSON support
      • Asynchronous submissions
      • Caching extension
      • Other submission extensions
    • XPath
      • Type annotations
      • Expression analysis
      • Tips
      • Compatibility
      • Standard functions
      • Maps and arrays Functions
      • Extension functions
        • Core functions
        • Utility functions
        • Model functions
        • Controls functions
        • XML functions
        • JSON functions
        • HTTP functions
        • Form Runner functions
        • Other functions
        • Deprecated functions
    • XBL components
      • FAQ
      • Guide
        • XBL Tutorial
        • Bindings
        • XForms models
        • Including content
        • Event handling
        • Conventions
        • Map XBL example
        • Learning from existing components
      • Advanced topics
        • XBL Modes
        • JavaScript companion classes
        • XBL library
        • Extensions
        • Attachment controls
    • XForms tutorial
      • Introduction
      • Installation
      • The Hello application
      • The Bookcast application
        • The basic app
        • Database access
        • Polishing the app
        • Adding a feed
    • Using XForms from Java apps
  • XML Platform
    • Page Flow Controller
      • Basics
      • XML submission
      • Navigating between pages
      • Paths and matchers
      • Other configuration elements
      • Typical combinations of page model and page view
      • Examples
      • Authorizing pages and services
    • Processors
      • URL generator
      • Request generator
      • PDF to image converter
    • Resources
      • Resource managers
      • Setting up an external resources directory
    • Other
      • Binary and text documents
  • FAQ
    • Licensing
    • PE and Dev Support
    • Form Builder and Form Runner
    • Resources and support
    • Other technical questions
  • Contributors
    • Automated tests
    • Building Orbeon Forms
    • Localizing Orbeon Forms
    • Validation functions
    • Contributor License Agreement
  • Release notes
    • Orbeon Forms 2022.1.9
    • Orbeon Forms 2024.1.1
    • Orbeon Forms 2023.1.7
    • Orbeon Forms 2024.1
    • Orbeon Forms 2023.1.6
    • Orbeon Forms 2023.1.5
    • Orbeon Forms 2021.1.11
    • Orbeon Forms 2022.1.8
    • Orbeon Forms 2023.1.4
    • Orbeon Forms 2023.1.3
    • Orbeon Forms 2023.1.2
    • Orbeon Forms 2022.1.7
    • Orbeon Forms 2023.1.1
    • Orbeon Forms 2023.1
    • Orbeon Forms 2022.1.6
    • Orbeon Forms 2021.1.10
    • Orbeon Forms 2022.1.5
    • Orbeon Forms 2021.1.9
    • Orbeon Forms 2022.1.4
    • Orbeon Forms 2022.1.3
    • Orbeon Forms 2021.1.8
    • Orbeon Forms 2022.1.2
    • Orbeon Forms 2022.1.1
    • Orbeon Forms 2022.1
    • Orbeon Forms 2021.1.7
    • Orbeon Forms 2021.1.6
    • Orbeon Forms 2021.1.5
    • Orbeon Forms 2021.1.4
    • Orbeon Forms 2021.1.3
    • Orbeon Forms 2021.1.2
    • Orbeon Forms 2021.1.1
    • Orbeon Forms 2021.1
    • Orbeon Forms 2020.1.6
    • Orbeon Forms 2019.2.4
    • Orbeon Forms 2019.1.2
    • Orbeon Forms 2018.2.5
    • Orbeon Forms 2018.1.4
    • Orbeon Forms 2020.1.5
    • Orbeon Forms 2020.1.4
    • Orbeon Forms 2020.1.3
    • Orbeon Forms 2020.1.2
    • Orbeon Forms 2019.2.3
    • Orbeon Forms 2020.1.1
    • Orbeon Forms 2020.1
    • Orbeon Forms 2019.2.2
    • Orbeon Forms 2019.2.1
    • Orbeon Forms 2019.1.1
    • Orbeon Forms 2019.2
    • Orbeon Forms 2019.1
    • Orbeon Forms 2018.2.4
  • Release history
  • Use cases
  • Product roadmap
  • Index of features
Powered by GitBook
On this page
  • Children pages
  • Default values
  • Form Runner properties documented elsewhere
  • Language
  • Default language
  • Available languages
  • Timezone
  • Summary Page
  • Detail page
  • Show Orbeon Forms version
  • Default logo
  • Adding your own CSS
  • Adding your own JavaScript
  • Overriding resources
  • Email settings
  • Sections and grids
  • Appearance of repeated sections
  • Appearance of repeated grids
  • Insert position of repeated sections
  • Insert position of repeated grids
  • Section collapsing
  • Grid markup
  • Deprecated properties
  • Noscript properties
  • Show noscript link
  • Noscript: use table layout
  1. Configuration
  2. Properties

Form Runner

PreviousHTTP clientNextDetail page

Last updated 7 days ago

Children pages

Default values

For the latest default values of Form Runner properties, see .

Form Runner properties documented elsewhere

    • oxf.fr.detail.model.custom

    • oxf.fr.detail.dialogs.custom

    • oxf.fr.detail.view.appearance

    • oxf.fr.detail.buttons.inner

    • oxf.xforms.xbl.fr.wizard.validate

    • oxf.xforms.xbl.fr.wizard.separate-toc

    • oxf.xforms.xbl.fr.wizard.section-status

    • oxf.xforms.xbl.fr.wizard.subsections-nav

    • oxf.xforms.xbl.fr.wizard.subsections-toc

    • oxf.fr.detail.autosave-delay

    • oxf.fr.persistence.*.autosave

    • oxf.fr.detail.data-migration

    • oxf.fr.persistence.provider

    • oxf.fr.persistence.[provider].uri

    • oxf.fr.persistence.[provider].active

    • oxf.fr.persistence.[provider].autosave

    • oxf.fr.persistence.[provider].permissions

    • oxf.fr.persistence.[provider].versioning

    • oxf.fr.persistence.[provider].data-format-version

    • oxf.fr.support-owner-group

    • oxf.fr.authentication.method

    • oxf.fr.authentication.container.roles

    • oxf.fr.authentication.container.roles.split

    • oxf.fr.authentication.header.username

    • oxf.fr.authentication.header.group

    • oxf.fr.authentication.header.roles

    • oxf.fr.authentication.header.roles.split

    • oxf.fr.authentication.header.roles.property-name

    • oxf.fr.authentication.header.sticky

    • oxf.fr.home.page-size

    • oxf.fr.home.table.link-to

    • oxf.fr.home.remote-servers

    • oxf.fr.detail.tiff.compression.type

    • oxf.fr.detail.tiff.compression.quality

    • oxf.fr.detail.tiff.scale

    • oxf.fr.detail.tiff.filename

Language

Default language

The following property determines Form Runner's default language:

<property
    as="xs:string"
    name="oxf.fr.default-language.*.*"
    value="en">

When wildcards are specified, this property can control the default language for a given app or form.

The property without wildcards can also be used to control the default language of pages which don't involve a specific form, such as the Form Runner Home Page

<property
    as="xs:string"
    name="oxf.fr.default-language"
    value="en">

Available languages

For a given form, you can filter which languages are available in the language selector with a space-separated list of language codes:

<property
  as="xs:string"
  name="oxf.fr.available-languages.*.*"
  value="en fr"/>

The language selector by default shows all languages available in the form definition. When this property is specified, only the intersection of the languages is shown in the selector. For example:

  • Example 1

    • form languages: en fr jp

    • property: en fr

    • resulting languages: en fr

  • Example 2

    • form languages: en fr jp

    • property: en jp kr

    • resulting languages: en jp

If the property is blank or contains the wildcard *, all the form languages are available.

[SINCE Orbeon Forms 4.3]

For pages which don't involve a specific form, such as the Form Runner Home Page, the following property controls the available languages:

<property
  as="xs:string"
  name="oxf.fr.available-languages"
  value="en fr"/>

Timezone

[SINCE Orbeon Forms 2021.1]

The Summary and Home pages display timestamps showing the created and last modified dates of forms and data.

You can configure an explicit timezone to display these timestamps:

<property
      as="xs:string"
      name="oxf.fr.default-timezone"
      value="America/Los_Angeles"/>
<property
      as="xs:string"
      name="oxf.fr.default-timezone"
      value="Asia/Kolkata"/>

If the property is blank (the default), the Java environment's default timezone is used.

[UNTIL Orbeon Forms 2020.1]

The Java environment's default timezone is used.

Summary Page

Detail page

Show Orbeon Forms version

[UNTIL Orbeon Forms 4.6, use oxf.show-version starting Orbeon Forms 4.6.1]

<property
    as="xs:boolean"
    name="oxf.fr.version.*.*"
    value="true"/>

Whether to show the Orbeon Forms version at the bottom.

Default logo

With this property, you can set the default logo URI. This logo appears on the Summary, Detail and Home pages for a given form. You can omit (or comment out) this property or set its value to the empty string if you don't want a default logo at all.

[SINCE Orbeon Forms 2024.1.1] When the URI ends with .svg, Orbeon Forms generates markup that implements a fallback strategy - it first attempts to load the SVG version, then automatically falls back to a PNG version (using the same path but with .png extension) if SVG is not supported by the renderer. In practice, this means browsers will display the SVG version, while PDF generation will use the PNG version.

<property as="xs:anyURI"  name="oxf.fr.default-logo.uri.*.*">
    /apps/fr/style/orbeon-logo.svg
</property>
  1. Place your logo file(s) under one of the following recommended locations:

    • WEB-INF/resources/forms/assets: logo for all forms

    • WEB-INF/resources/forms/APP/assets: logo for app name APP

    • WEB-INF/resources/forms/APP/FORM/assets: logo for app name APP and form name FORM

  2. Define the oxf.fr.default-logo.uri.*.* property to point to the file(s) you added. The path points to location under the WEB-INF/resources directory.

For example, to change the default logo for all forms and pages to an image called my-logo.png, place the image at the proper location and use the following property:

<property as="xs:anyURI"  name="oxf.fr.default-logo.uri.*.*">
    /forms/assets/my-logo.png
</property>

Adding your own CSS

Adding your own JavaScript

[SINCE Orbeon Forms 4.4]

  1. Place your JavaScript file(s) under one of the following recommended locations:

    • WEB-INF/resources/forms/assets: scripts for all forms

    • WEB-INF/resources/forms/APP/assets: scripts for app name APP

    • WEB-INF/resources/forms/APP/FORM/assets: scripts for app name APP and form name FORM

<property as="xs:string" name="oxf.fr.js.custom.uri.*.*">
    /forms/acme/assets/acme.js
    /forms/acme/sales/assets/acme-sales.js
</property>

You can add more than one file, and just separate the paths by whitespace in the property.

[SINCE Orbeon Forms 2017.1]

Overriding resources

In some cases, it might make sense to change some of the resources provided out of the box by Form Runner. For instance, the Detail Page can have a submit button, which in English has a label "Submit". For your application, another label might make more sense, for instance "Send". To override Form Runner resources, you define properties with a name that has the following structure:

  1. The name start with oxf.fr.resource.

  2. Followed by the name of the application and form name for which you want to redefine the resource. You can use * for either if you want the redefinition to apply to all the applications or all the forms. For instance: *.*, or my-app.my-form.

  3. The 2-letter code for the language for which you want to override the resource. For instance: en.

  4. Resources are aggressively caches, so you need to restart your application server (or redeploy the web app) after changing a property that overrides resources.

For instance, to change the label of the submit button to be "Send" in English for all applications and forms, write:

<property
    as="xs:string"
    name="oxf.fr.resource.*.*.en.detail.buttons.send"
    value='&lt;i class="icon-arrow-right"/&gt; Send'/>

This also works for resources that don't exist yet. For your own resources, start with a prefix specific to your company or project. For example:

<property
  as="xs:string"
  name="oxf.fr.resource.*.*.en.acme.my-resource-1"
  value="Resource 1 in English"/>

<property
  as="xs:string"
  name="oxf.fr.resource.*.*.fr.acme.my-resource-1"
  value="Resource 1 en français"/>

NOTE: You can add new resources as shown above, but you cannot create new languages.

Email settings

Sections and grids

Appearance of repeated sections

[SINCE Orbeon Forms 2016.1]

The following property allows you to set the appearance of repeated sections to full (the default) or minimal for all forms or for a subset of forms:

<property
    as="xs:string"
    name="oxf.xforms.xbl.fr.section.appearance.*.*"
    value="minimal"/>

Appearance of repeated grids

[SINCE Orbeon Forms 2016.1]

The following property allows you to set the appearance of repeated grids to full (the default) or minimal for all forms or for a subset of forms:

<property
    as="xs:string"
    name="oxf.xforms.xbl.fr.grid.appearance.*.*"
    value="minimal"/>

Insert position of repeated sections

[SINCE Orbeon Forms 2016.2]

The following property allows you to select where new repetitions are added when using the "Add Another" or "+" button. Allowed values are index (default for the full appearance) and bottom (default for the minimal appearance):

<property
    as="xs:string"
    name="oxf.xforms.xbl.fr.section.insert.*.*"
    value="index"/>

Insert position of repeated grids

[SINCE Orbeon Forms 2016.2]

The following property allows you to select where new repetitions are added when using the "Add Another" or "+" button. Allowed values are index (default for the full appearance) and bottom (default for the minimal appearance):

<property
    as="xs:string"
    name="oxf.xforms.xbl.fr.grid.insert.*.*"
    value="index"/>

Section collapsing

[SINCE Orbeon Forms 2016.1]

The following property allows you to set whether a section content can be collapsed by clicking on its title for all forms or for a subset of forms:

<property
    as="xs:boolean"
    name="oxf.xforms.xbl.fr.section.collapsible.*.*"
    value="false"/>

By default, sections are allowed to collapse.

The following property controls the same behavior in noscript mode:

[UNTIL Orbeon Forms 2018.1]

<property
    as="xs:boolean"
    name="oxf.xforms.xbl.fr.section.noscript.collapsible.*.*"
    value="false"/>

A value of false may make sections more accessible and less confusing to screen reader users.

The following property controls the whether collapsing/opening of sections uses an animation. The default is true:

<property
    as="xs:boolean"
    name="oxf.xforms.xbl.fr.section.animate.*.*"
    value="false"/>

A value of false can be more efficient with slower browsers or large forms.

Grid markup

Current behavior (Orbeon Forms 2022.1 and later)

<property
    as="xs:string"
    name="oxf.xforms.xbl.fr.grid.markup.*.*"
    value="html-table"/>

Older versions (before Orbeon Forms 2022.1)

<property
    as="xs:string"
    name="oxf.xforms.xbl.fr.grid.markup.*.*"
    value="css-grid"/>

Deprecated properties

Before Orbeon Forms 2016.1, you could use the following properties, deprecated since Orbeon Forms 2016.1. Section collapsing:

<property
    as="xs:boolean"
    name="oxf.fr.detail.ajax.section.collapse.*.*"
    value="false"/>

Section collapsing in noscript mode:

[UNTIL Orbeon Forms 2018.1]

<property
    as="xs:boolean"
    name="oxf.fr.detail.noscript.section.collapse.*.*"
    value="false"/>

Section collapsing animation:

<property
    as="xs:boolean"
    name="oxf.fr.detail.ajax.section.animate.*.*"
    value="true"/>

Noscript properties

[DEPRECATED SINCE Orbeon Forms 2016.3]

[UNTIL Orbeon Forms 2018.1]

Show noscript link

<property
    as="xs:boolean"
    name="oxf.fr.noscript-link.*.*"
    value="true"/>

Whether to show the link to the noscript/full version.

Noscript: use table layout

<property
    as="xs:boolean"
    name="oxf.fr.detail.noscript.table.*.*"
    value="true"/>

Whether forms in noscript mode are allowed to use a layout based on tables. If false, no tables are used. WYSIWYG is lost, but the form may be more accessible. The default is true.

For more details, see

For more details, see

See .

See .

If you use two * wildcards, as in the example above, the property also sets the logo on the and the

NOTE: Since Orbeon Forms 4.0, this property doesn't have an impact on the Form Builder logo. To override the Form Builder logo, you can use custom CSS (see the configuration).

See the .

Define the property to point to the file(s) you added. The path points to location under the WEB-INF/resources directory.

In addition to , you can also use the following properties, which apply only to the Summary and Detail pages respectively:

A dot-separated path corresponding to the path of the resource you want to override as defined by Form Runner .

See .

See also the attribute of the .

See also the attribute of the .

See also the attribute of the .

See also the attribute of the .

By default, grids in your forms are rendered using the modern with div elements. This provides better compatibility with modern browsers and improved layout capabilities. If your custom CSS relies on the older HTML table-based structure (with table, tr, and td elements), you can revert to the previous behavior by setting the following property:

Before Orbeon Forms 2022.1, grids were rendered using HTML tables by default. This was because older browsers, in particular IE11, provided only limited support for CSS grids. Starting with Orbeon Forms 2020.1.7 and 2021.1.1, anticipating the drop of IE11 support, you could opt-in to use CSS grid layout by setting the following property. For more details on grid rendering in different versions, see the .

Detail page
Attachments
Email
PDF
Persistence
Summary page
properties-form-runner.xml
Custom dialogs and model Logic
Wizard View
Autosave
Simple data migration
Configuration Properties ~ Persistence
Form Runner Access Control
Form Runner Published Forms Page
TIFF Production
Summary page configuration properties
Detail page configuration properties
Published Forms page
Forms Admin page
oxf.fr.css.custom.uri
CSS page
resources.xml
Email
CSS grid layout
Grids CSS documentation
oxf.fr.js.custom.uri
oxf.fr.js.custom.uri
section component
grid component
section component
grid component
appearance
insert
Language selection at runtime
Language selection at runtime
appearance
insert
oxf.fr.summary.js.custom.uri
oxf.fr.detail.js.custom.uri