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
  • Introduction
  • Built-in support
  • Configuration
  • REST-based
  • Optional features
  • Virtual hierarchy of data
  • Headers
  1. Form Runner
  2. APIs

Persistence API

PreviousAuthentication of server-side service APIsNextCRUD API

Last updated 10 months ago

Children pages

Introduction

Orbeon Forms form definitions and form data are stored via an abstraction called the persistence API. This allows storing form definitions and form data for all or specific forms in different places. For example, you could store your form definitions into Oracle, and your form data into your own, custom database.

Built-in support

Configuration

REST-based

The Form Runner/Form Builder persistence API is based on REST. This means that Form Builder and Form Runner use HTTP to communicate with a persistence layer implementation.

Following the REST philosophy, HTTP methods are used to determine what CRUD operation to perform:

  • GET: read a resource

  • PUT: create or update a resource

  • DELETE: delete a resource

For example, to deal with form data:

/fr/service/persistence

Operation
HTTP Method
URL

Create

PUT

/fr/service/persistence/crud/$app/$form/(data|draft)/$document/data.xml

Read

GET

/fr/service/persistence/crud/$app/$form/(data|draft)/$document/data.xml

Update

PUT

/fr/service/persistence/crud/$app/$form/(data|draft)/$document/data.xml

Delete

DELETE

/fr/service/persistence/crud/$app/$form/(data|draft)/$document/data.xml

Search

POST

/fr/service/persistence/search/$app/$form

Metadata

GET

/fr/service/persistence/form

where:

  • $app is the form definition's application name

  • $form is the form definition's form name

  • $document is the form data's document id

Optional features

[SINCE Orbeon Forms 4.4]

Virtual hierarchy of data

Form Runner/Form Builder access data under a virtual hierarchy of URLs, not unlike directories or folders in a filesystem. However, this hierarchy can be physically located in different places:

  • An XML database, like eXist.

  • A disk-based filesystem.

  • Your own system, which you can implement on top of a database or other type of storage.

Following XML database technology, we use the terms collections and resources instead of directories and files.

The hierarchy looks like this:

  • acme/ → app name

    • address/ → form name

      • form/ → form definition

        • form.xhtml → the form definition proper

        • e9ed0270896ac9012612c570698c6955d8c0de67.bin → PDF template attached to form definition

        • d7419b1467b0c0c4df3ed415aaa788325817d478.bin → image attached to form definition

        • 873ee4175a820fe3bac2fabb808b1ce9927d7f3a.bin → other file attached to form definition

      • data/ → form data

        • 74cb880847c638577e7afa15911efc99ceaf2dcb → one instance of form data

          • data.xml → form data proper

          • c738877f52110302e407e9bba87e0ef92531b357.bin → image attached to form data

          • a502ea5404ba8afb9e364a3e73dbd477eb6e40b8.bin → other file attached to form data

      • 4abca3daf30523fd17c3699a6044f2e53b21f933 → another instance of form data

        • data.xml

      • draft/ → draft form data

        • 9438f77ff8326c0c206b02f090f818841affd98a → one instance of draft form data

          • data.xml

          • …

    • contract/

      • form/

        • …

      • data/

        • …

  • foobar/

    • …

The hierarchy is organized as follows:

  • At the top-level there is one collection per application

  • Within an application collection, there is one collection per form definition

  • Within a form definition there is one collection called form for the form definitions produced by Form Builder, and one collection called data for form data produced by Form Runner

  • Each form collection contains:

    • form.xhtml: the main form definition, which is an XHTML+XForms resource

    • optional attachments, such as images, PDF files, and other file attachments uploaded by the form author when editing the form definition

  • Each data collection contains one collection for each form data id, identified by an automatically-generated UUID

    • implementations of the persistence API are expected to remove the draft (with the corresponding attachments) when the corresponding data is saved

  • Each form data collection contains:

    • data.xml: the main form data document

    • optional attachments, such as images uploaded by the user when editing the form data

Headers

All persistence URLs are called with headers matching configuration properties for the given persistence layer implementation. For example:

  • eXist

    • property:

      <property
          as="xs:anyURI"
          name="oxf.fr.persistence.exist.exist-uri"
          value="/exist/rest/db/orbeon/fr">
    • header:

      Orbeon-Exist-Uri: /exist/rest/db/orbeon/fr
  • Oracle

    • properties:

      <property
          as="xs:string"
          name="oxf.fr.persistence.oracle.datasource"
          value="oracle">
      <property
          as="xs:boolean
          name=" oxf.fr.persistence.oracle.create-flat-view"
          value="false">
    • headers:

      Orbeon-Datasource: oracle
      Orbeon-Create-Flat-View: false
  • MySQL

    • property:

      <property
          as="xs:string"
          name="oxf.fr.persistence.mysql.datasource"
          value="mysql">
    • header:

      Orbeon-Datasource: mysql
  • DB2

    • property:

      <property
          as="xs:string"
          name="oxf.fr.persistence.db2.datasource"
          value="db2">
    • header:

      Orbeon-Datasource: db2

Out of the box, Orbeon Forms provides an implementation of the persistence API for a number of databases, and other implementations are provided by third parties. See for details.

For a description of the terminology and configuration properties, see .

Drafts – If your persistence provider does not support drafts, you can specifically turn off the autosave feature for that persistence layer with the oxf.fr.persistence.*.autosave property. See and for details.

User/group permissions – Similarly, if your persistence provider does not support user/group permissions, you can specifically turn off the permissions feature for that persistence layer with the oxf.fr.persistence.*.permissions property. See for details.

The draft collection is analogous to the "data" collection, but used by to store form data before users explicitly save it

CRUD
Search
List form data attachments
Form metadata
Caching
Versioning
Lease API
Reindexing API
Revision History API
Zip Export API
Custom persistence providers
Database Support
Form Runner Configuration Properties
Autosave
persistence layer configuration
persistence layer configuration
autosave