Versioning

Availability

This an Orbeon Forms PE feature available since Orbeon Forms 4.5. It is available with all supported relational databases but not the eXist database.

What is form definition versioning?

Without form definition versioning

Without form definition versioning, Orbeon Forms only keeps track of a single published form definition for a given application name/form name (see terminology). This means that if you republish a form, the previously-published form definition gets overwritten (although there is an auditing trail).

This also means that when opening existing data for editing or viewing, Orbeon Forms always uses the latest published version of the form definition. This can lead to unexpected results, as fields might have been added, removed, or renamed in the new form definition. In fact, the form definition could be completely different from the form definition used to create and save the data currently stored in the database!

With form definition versioning

Form definition versioning introduces the idea that published form definitions for a given application name/form name also have a version number. When creating a new version upon publishing, the version number is "1", and when publishing again with a new version the number increases: "2", "3", etc. So you can talk about "version 2 of the Acme Order form".

Creating a new version

When saving form data, the data in the database is associated not only with the application name and form name, but also with the version of the form definition that was used to create or edit that data. So when you open that data for editing or viewing at a later time, Form Runner can use the matching version of the form definition.

When publishing, if versioning is supported by the persistence layer, you have a choice to create a new form version or to override an existing one. This is detailed in Publishing.

Compatibility of changes

There are different types of changes you can make to a form definition which impact whether existing data in the database will be compatible with those changes.

NOTE: If there is not yet any data created by that given form definition version in the database, then compatibility is not a problem.

Examples of compatible changes:

updating labels, hints, help messages, and explanatory texts
adding items to selection controls
changing the initial value of a control, either directly with the control or via an Initial Value formula
moving a control within the same grid or section
changing grid column widths
adding a language
updating permissions
updating email settings

Examples of incompatible changes:

renaming a control
adding a control, grid, or section
removing a control, grid, or section
renaming a control, grid, or section
moving a control between grids or sections
changing the nesting of grids or section within subsections

See also Simple data migration, which enables some of the incompatible changes listed above.

Limitations

[SINCE Orbeon Forms 2021.1] If you are using the built-in implementation of the persistence API for relational databases to store data, if you want to use another implementation to store your forms, then that implementation needs to support versioning.
[UP TO Orbeon Forms 2020.1] You are using a provider that uses the built-in implementation of the persistence API for relational databases to store data, then you also need to use the same provider to store forms (see #3926). This limitation is lifted starting in Orbeon Forms 2021.1.