- See also
- Enabling autosave
- How autosave works
See Database Support for the detail of which persistence layers and Orbeon Forms versions support the autosave feature.
The following conditions must be met for autosave to happen:
- The user must be logged in.
- The user must have update permissions (if permissions are enabled for the form).
- The form mode must be
- The persistence layer must support autosave and have the
oxf.fr.persistence.$name.autosaveproperty set to
trueby default for the built-in relational databases).
- The autosave delay (set with
oxf.fr.detail.autosave-delay) must be greater than
0(which is the case by default).
NOTE: Form Builder doesn't support autosave as of Orbeon Forms 4.8.
How autosave works
When autosave is enabled and you are an authenticated user, form data is automatically saved as drafts in the background as you enter and modify form data. This reduces the chance that you will lose data if something goes wrong and you haven't explicitly saved the data.
The summary page shows the drafts, on separate lines and clearly marked as such. From the summary page, users can click on a draft to open it, or select it to then delete it, assuming they have the permission to do so.
If users edit a form for which there is a draft, they will be asked whether they want to open the saved data, or start from the autosaved draft.
If users started filling out a new form, but didn't save the data, if starting to fill out a new form later, they will be asked whether they wish to start from scratch, or from one of the drafts saved earlier. In this case, the prompt will be different whether there is just one draft for new data, or multiple drafts available, as in the latter case, users will need to select which draft they want to use.
When multiple drafts are available, choosing the "View auto-saved drafts" button takes you to the form's Summary page in a special mode where only the relevant drafts are visible:
With Orbeon Forms 4.3
With Orbeon Forms 4.3 specifically, you need to:
- If using MySQL, update your database by running this DDL. (The tables for DB2 on 4.3 already contain the required changes out-of-the-box.)
- Set the following properties:
<property as="xs:boolean" name="oxf.fr.support-owner-group" value="true"/> <property as="xs:boolean" name="oxf.fr.support-autosave" value="true"/>
With Orbeon Forms 4.4 and newer
You don't need to do anything special to use this feature.
<property as="xs:integer" name="oxf.fr.detail.autosave-delay.*.*" value="5000"/>
[SINCE Orbeon Forms 4.4]
If the value of
oxf.fr.detail.autosave-delay is 0 or negative, autosaving is disabled.
The following property enables or disable autosave for a given persistence provider, as autosave requires support from the persistence provider.
<property as="xs:boolean" name="oxf.fr.persistence.*.autosave" value="false"/>
For example, as of Orbeon Forms 4.4, the
exist provider does not support autosave yet. But the
oracle provider does:
<property as="xs:boolean" name="oxf.fr.persistence.oracle.autosave" value="true"/>
For database support, see Database Support.