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
  • Introduction
  • General Settings
  • Form Options
  • Time Window
  • Control Settings
  • Appearance
  • Settings
  • Form Density
  • Wizard
  • PDF
  • Formulas
  • About this Form
  • Versions
  • Form Statistics
  • See also
  1. Form Builder

Form settings

PreviousForm BuilderNextTime window

Last updated 1 month ago

Introduction

Some settings apply to the entire form definition. You access these settings with the "Form Settings" wrench icon on the top right of Form Builder. The General Settings also show initially when creating a new form definition.

General Settings

General settings allow you to set the following form definition metadata:

  • Application name

  • Form name

  • Form title in the current language

  • Form description in the current language

[SINCE Orbeon Forms 2020.1]

The description can optionally use rich text.

Form Options

[SINCE Orbeon Forms 2016.2]

Form options include options which apply to the entire form definition.

  • Singleton Form

    • Enable or disable singleton form behavior.

  • Allow use as form template

    • When this is checked, this form can be used as a template for new forms.

    • The default is unchecked.

  • Simple Data Migration

    • [SINCE Orbeon Forms 2018.2]

  • Grid Tab Order

  • Maximum Attachment Size per File

    • [SINCE Orbeon Forms 2017.1]

    • Other: the maximum size allowed in bytes

  • Maximum Aggregate Attachment Size

    • [SINCE Orbeon Forms 2017.1]

    • Other: the maximum size allowed in bytes

  • Maximum Number of Files

    • [SINCE Orbeon Forms 2025.1]

    • Other: the maximum number of files allowed per multiple file attachment control

  • Allowed File Types

    • [SINCE Orbeon Forms 2017.1]

    • Other: a space-separated list of mediatypes or wildcard mediatypes

  • Use Automatic Hints

    • Use property: use the oxf.fr.detail.hint.automatic.*.* property

    • Yes/No: show or don't show the automatic hints for all controls on this form

Here is how hints appear depending on the type of control they are associated with:

Time Window

Control Settings

[SINCE Orbeon Forms 2018.2]

This tab shows settings for specific controls. Those settings apply to all control on the form except when they are overridden by individual settings in the "Control Settings" dialog.

For example, you can set a "Digits After Decimal" setting global to the form, and then override it on specific number controls as needed.

Appearance

Settings

[SINCE Orbeon Forms 2018.1] These options are now in a separate tab.

  • Browser page layout

    • [SINCE Orbeon Forms 2019.2]

    • Fixed width: the form sections and grids take a fixed and predefined width of approximately 940px for large displays (the layout becomes responsive for smaller displays sizes).

    • Fluid width: the form sections and grids take the entire web browser's viewport size.

  • Density

    • Sets the spacing between elements in the interface, Compact being the most compact (default) and Roomy being the most spacious.

  • Appearance of Control Labels

    • Inline: labels show inline above the control

  • Use Placeholder for Text Fields and Text Areas

    • Labels show inline above the control for most fields.

    • For text, date, and time input fields, labels show as an HTML placeholder within the field when the field is empty.

    • For text areas, labels show as an HTML placeholder within the field when the field is empty. [SINCE Orbeon Forms 2017.1]

  • Appearance of Control Hints

    • Use property: use the oxf.xforms.hint.appearance property

    • Inline: hints show inline below the control

    • Tooltips: hints show as tooltips upon mouseover

  • Use Placeholder for Text Fields and Text Areas

    • Hints show inline or as tooltips upon mouseover.

    • For text, date, and time input fields, hints show as an HTML placeholder within the field when the field is empty.

    • For text areas, hints show as an HTML placeholder within the field when the field is empty. [SINCE Orbeon Forms 2017.1]

See also:

Form Density

Here is how the same form layout looks with the three different form density settings. First, the default "Compact" setting:

Second, the "Comfortable" setting. Notice how the controls are spaced out more:

Finally, the "Roomy" setting:

See also:

Wizard

  • Wizard View:

    • Always or Never: enable or disable the wizard view for this form definition, no matter how the property is configured.

  • Wizard Navigation Validation Mode

    • Form Builder setting [SINCE Orbeon Forms 2018.1]

    • Free, Lax or Strict: use the given validation mode for this form definition, no matter how the property is configured.

  • Wizard Subsections Navigation

    • Form Builder setting [SINCE Orbeon Forms 2018.1]

    • Always or Never: enable or disable subsection navigation for this form definition, no matter how the property is configured.

  • Wizard Subsections Table of Contents

    • Form Builder setting [SINCE Orbeon Forms 2018.1]

    • "Show subsections for the active section only", "Show subsections for all sections", "Don't show subsections": use the given setting for this form definition, no matter how the property is configured.

  • Wizard Separate Table of Contents

  • Always Show Wizard Section Status

PDF

[SINCE Orbeon Forms 2019.2]

  • PDF page orientation

    • Portrait: use the portrait (vertical) orientation.

    • Landscape: use the landscape (horizontal) orientation.

  • PDF page size

    • Letter: US letter size.

    • A4: standard A4 size.

    • Legal: US legal size.

Formulas

  • Calculations in Read-Only Modes (Review, PDF)

    • [SINCE Orbeon Forms 2021.1]

      • the property defaults to false, which means that Calculated Value formulas run in readonly modes

    • Enable: Calculated Value formulas run in readonly modes.

    • Disable: Calculated Value formulas do not run in readonly modes.

    • Sometimes calculations should not run in readonly modes, such as the View page. This can now be configured at the form level.

  • Read-Only

    • [SINCE Orbeon Forms 2020.1]

    • Boolean expression specifying whether the entire form is read-only (not editable).

    • If this field is left blank, then the form is editable.

    • Otherwise, it is editable only if the result of the Boolean expression is false().

  • Automatic Calculations Dependencies

    • [SINCE Orbeon Forms 2018.1]

About this Form

Versions

[SINCE Orbeon Forms 2018.2]

This area shows relevant Orbeon Forms versions:

  • "Created with Version": version with which this form definition was created.

    • NOTE: This is blank for forms created prior to Orbeon Forms 2018.1.

  • "Updated with Versions": versions with which this form definition was updated This is updated:

    • when saving the form definition

    • when upgrading the form definition from the Form Runner Home page.

  • "Current Version": the current Orbeon Forms version.

Form Statistics

Form statistics show counts of various form elements.

See also

  • Blog posts

See

For details, see .

For details, see .

Use property: use the

For details, see in the Grid Settings dialog.

Use property: use the

Use property: use the

Use property: use the

Use property: use the

For details, see

See .

See also the .

Use property: use the

Use property: use the

Use property: use the

Blog post:

Blog post:

Wizard

For details, see .

Use property: use the

Use property: use the

Use property: use the

Use property: use the

See also the .

Use property: use the

Use property: use the

See also the .

Use property: use the

For details, see .

Singleton Form
[SINCE Orbeon Forms 2024.1]
Form templates
Simple data migration
[SINCE Orbeon Forms 2023.1]
[SINCE Orbeon Forms 2023.1]
Time Window
blog post
[SINCE Orbeon Forms 2024.1]
New layout choices for PDF and browser views
[SINCE Orbeon Forms 2024.1]
Form Density Setting
Wizard View
blog post
blog post
Automatic calculations dependencies
Wizard View
Simple data migration
Automatic calculations dependencies
New layout choices for PDF and browser views
Improved constraints on attachments uploads
Form-level and control-level settings
oxf.fr.detail.attachment.max-size-per-file property
oxf.fr.detail.attachment.max-size-aggregate-per-form property
oxf.fr.detail.attachment.max-files-per-control property
oxf.fr.detail.attachment.mediatypes property
oxf.xforms.xbl.fr.grid.tab-order property
oxf.fr.detail.html-page-layout property
oxf.fr.detail.density property
oxf.fr.detail.readonly.disable-calculate property
Automatic hints
oxf.xforms.label.appearance property
oxf.fr.detail.view.appearance property
oxf.xforms.xbl.fr.wizard.validate property
oxf.xforms.xbl.fr.wizard.subsections-nav property
oxf.xforms.xbl.fr.wizard.subsections-toc property
General Settings
Form description with rich text
Form Options
Time Window
Number Control Settings
Date Control Settings
Appearance
Compact
Comfortable
Roomy
PDF
Formulas
About this Form
oxf.fr.detail.rendered-page-orientation property
oxf.fr.detail.rendered-page-size property
Hints
Grid Tab Order