XFA support in XDP-based adaptive forms

Last update: May 3, 2023

CREATED FOR:

  • User
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

Introduction

Adaptive forms provides support for various XFA events, properties, scripts, and validations defined in an XDP file, including:

  • Execution of scripts defined on events in the XDP file.
  • Capturing default values and behavioral properties for fields in the XDP file.
  • Execution of validation scripts defined in the XDP file.

When an adaptive form is created based on an XDP file, the properties, events, and validations are auto-populated in the form authoring UI. However, form authors can override some of these elements to create an alternate experience.

This article lists supported XFA events, properties, and validations honored in adaptive forms and explains how to override them in adaptive forms.

Supported XFA elements and their mapping in adaptive forms

Fields

When an adaptive form is created using an XDP file, you can drag-drop an XFA field onto the adaptive form. The following table lists how XFA fields are mapped to adaptive form fields.

XFA field or containerCorresponding adaptive form component
ButtonButton
Check BoxCheck Box
List BoxDrop-down List
Date/Time FieldDate Picker
Signature ScribbleScribble Signature
Numeric FieldNumeric Box
Decimal FieldNumeric Box
Text FieldText Box
Password FieldPassword Box
ImageImage
TextText
SubformPanel
Area (Group)Panel
Subform SetPanel

Properties

The following table captures how various XFA scripts defined in the XDP files behave in adaptive forms.

XFA component propertiesCorresponding behavior in adaptive forms
somExpressionMapped to the Bind reference (bindRef) property in adaptive form.
presenceMapped to the visible property in adaptive form. You can override it using the Visibility expression.
accessMapped to the enabled property in adaptive form. You can override it using the Access expression.
Accessibility: roleMapped to the role property in adaptive form.
Accessibility: speakPriorityMapped to the speakPriority property in adaptive form.
Accessibility: speakTextMapped to the custom Accessibility text in adaptive form.
Accessibility: toolTipMapped to the short description property in adaptive form.
caption (all Field types)Mapped to the Title property in adaptive form.
displayFormat (all Field types)Mapped to the Display Pattern in adaptive form.
rawValue (all Field types)Mapped to value property in adaptive Form.
items (List Box, Check Box)Mapped to options property in adaptive form. You can override it using the Options expression.
maxChar (Text Field)Mapped to the Maximum characters allowed property in adaptive form.
multiline (Text Field)Mapped to the Allow multiple lines property in adaptive form.
fracDigit (Numeric Field, Decimal Field)Mapped to the Frac digits property in adaptive form.
leadDigit (Numeric Field, Decimal Field)Mapped to the Lead digits property in adaptive form.
multiSelect (List Box)Mapped to the Allows multiple selection property in adaptive form.

Scripts

The following table captures how various XFA scripts defined in the XDP file behave in adaptive forms.

XFA script eventsCorresponding behavior in adaptive forms
initializeThis script is executed at runtime and cannot be overridden in adaptive form.
calculateMapped to the Calculate expression in adaptive form.
validateMapped to the Validation expression in adaptive form.
validationStateThis script is executed at runtime and cannot be overridden in adaptive form.
exitThis script is executed at runtime and cannot be overridden in adaptive form.
click (button fields)Mapped to the Click expression of the button.
Support for server-side scriptThis script is executed at runtime and cannot be overridden in adaptive form.
Support for web servicesThis script is executed at runtime and cannot be overridden in adaptive form.
Change (scribble field, radio button, check box)This script is executed at runtime and cannot be overridden in adaptive form.