Summary page Excel Export

Availability

[SINCE Orbeon Forms 2023.1.3]

This is an Orbeon Forms PE feature.

Context

Orbeon Forms includes a few ways to export form definitions and form data. This page documents a very specific capability: exporting a subset of form data as seen in the Summary Page in Excel format.

For different types of export, see also:

How to use the feature

Locations

You can export form data from the Form Runner Summary page.

Enabling the feature

In order to enable the feature, you need to add the excel-export-with-search token to the oxf.fr.summary.buttons property:

<property as="xs:string"  name="oxf.fr.summary.buttons.*.*">
    home review pdf delete duplicate excel-export-with-search new
</property>

Options

Upon activating the button, a dialog opens which allows you to specify options for the export:

  • Use labels for headings:

    • Default: selected

    • If selected, the column headings in the Excel document use control labels of the form controls, as well as human-readable labels for metadata

    • If deselected, the column headings in the Excel document use control names of the form controls, as well as metadata names

  • Use labels for selection controls:

    • Default: selected

    • If selected, the values of selection controls are exported as human-readable choices labels

    • If deselected, the values of selection controls are exported as choices values

  • Include document id column:

    • Default: deselected

    • If selected, the document id is included in the Excel document as the first column

    • If deselected, the document id is not included in the Excel document

Exported data

Activating the button exports the data currently displayed in the Summary Page, including:

  • all the pages accessible using paging

  • search results if a search is active

  • sorting order if specified

The export only includes data from form controls that the user can already see in the Summary page. These are the form controls marked as "Show on Summary page" in Form Builder's Control Settings dialog.

The Excel document includes:

  • a heading row including the column names

  • one row per form data row

  • form metadata is included as shown in the Summary page, if configured

    • Created: creation date/time

    • Modified: last modification date/time

    • Created By: username of the user who created the data

    • Modified By: username of the user who last modified the data

    • Workflow stage: name of the workflow stage associated with the data

See also

PreviousExcel and XML exportNextForm definitions and form data Zip Export

Last updated