Creating adaptive forms using JSON Schema creating-adaptive-forms-using-json-schema

Last update: Mon Jun 24 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Topics:
Adaptive Forms,Foundation Components

CREATED FOR:

Beginner
Intermediate
User
Developer

Adobe recommends using the modern and extensible data capture Core Componentsfor creating new Adaptive Formsor adding Adaptive Forms to AEM Sites pages. These components represent a significant advancement in Adaptive Forms creation, ensuring impressive user experiences. This article describes older approach to author Adaptive Forms using foundation components.

Version

Article link

AEM as a Cloud Service

Click here

AEM 6.5

This article

Prerequisites prerequisites

Authoring an adaptive form using a JSON Schema as its form model requires basic understanding of JSON Schema. It is recommended to read through the following content before this article.

Using a JSON Schema as form model using-a-json-schema-as-form-model

Adobe Experience Manager Forms supports creation of an adaptive form by using an existing JSON Schema as the form model. This JSON Schema represents the structure in which data is produced or consumed by the back-end system in your organization. The JSON Schema you use should be compliant with v4 specifications.

The key features of using a JSON Schema are:

The structure of the JSON is displayed as a tree in the Content Finder tab in the authoring mode for an adaptive form. You can drag and add element from the JSON hierarchy to the adaptive form.
You can pre-populate the form using JSON that is compliant with the associated schema.
On submission, the data entered by the user is submitted as JSON that aligns with the associated schema.

A JSON Schema consists of simple and complex element types. The elements have attributes that add rules to the element. When these elements and attributes are dragged onto an adaptive form, they are automatically mapped to the corresponding adaptive form component.

This mapping of JSON elements with adaptive form components is as follows:

"birthDate": {
              "type": "string",
              "format": "date",
              "pattern": "date{DD MMMM, YYYY}",
              "aem:affKeyword": [
                "DOB",
                "Date of Birth"
              ],
              "description": "Date of birth in DD MMMM, YYYY",
              "aem:afProperties": {
                "displayPictureClause": "date{DD MMMM, YYYY}",
                "displayPatternType": "date{DD MMMM, YYYY}",
                "validationPatternType": "date{DD MMMM, YYYY}",
                "validatePictureClause": "date{DD MMMM, YYYY}",
                "validatePictureClauseMessage": "Date must be in DD MMMM, YYYY format."
              }

JSON element, properties, or attributes

Adaptive form component

String properties with enum and enumNames constraint.

Syntax,

{

"type" : "string",

"enum" : ["M", "F"]

"enumNames" : ["Male", "Female"]

}

Drop down component:

Values listed in enumNames are displayed in the drop box.
Values listed in the enum are used for calculation.

String property with format constraint. For example, email, and date.

Syntax,

{

"type" : "string",

"format" : "email"

}

Email component is mapped when the type is string and format is email.
Textbox component with validation is mapped when the type is string and format is hostname.

{

"type" : "string",

}

Text field

number property

Numeric Field with sub type set to float

integer property

Numeric Field with sub type set to integer

boolean property

Switch

object property

Panel

array property

Repeatable Panel with min and max equal to minItems and maxItems respectively. Only Homogenous arrays are supported. So the items constraint must be an object and not an array.

Common schema properties common-schema-properties

Adaptive Form uses information available in JSON Schema to map each generated field. In particular:

The title property serves as label for the adaptive form components.
The description property is set as long description for an adaptive form component.
The default property serves as initial value of an adaptive form field.
The maxLength property is set as maxlength attribute of the text field component.
The minimum, maximum, exclusiveMinimum, and exclusiveMaximum properties are used for Numeric box component.
To support range for DatePicker component additional JSON Schema properties minDate and maxDate are provided…
The minItems and maxItems properties are used to restrict the number of items/fields that may be added or removed from a panel component.
The readOnly property sets the readonly attribute of an adaptive form component.
The required property marks the adaptive form field as mandatory whereas in panel(where type is object), the final submitted JSON data has fields with empty value corresponding to that object.
The pattern property is set as the validation pattern (regular expression) in adaptive form.
The extension of JSON Schema file must be kept .schema.json. For example, <filename>.schema.json.

Sample JSON Schema sample-json-schema

Here’s an example of a JSON Schema.

{
 "$schema": "https://json-schema.org/draft-04/schema#",
 "definitions": {
  "employee": {
   "type": "object",
   "properties": {
    "userName": {
     "type": "string"
    },
    "dateOfBirth": {
     "type": "string",
     "format": "date"
    },
    "email": {
     "type": "string",
     "format": "email"
    },
    "language": {
     "type": "string"
    },
    "personalDetails": {
     "$ref": "#/definitions/personalDetails"
    },
    "projectDetails": {
     "$ref": "#/definitions/projectDetails"
    }
   },
   "required": [
    "userName",
    "dateOfBirth",
    "language"
   ]
  },
  "personalDetails": {
   "type": "object",
   "properties": {
    "GeneralDetails": {
     "$ref": "#/definitions/GeneralDetails"
    },
    "Family": {
     "$ref": "#/definitions/Family"
    },
    "Income": {
     "$ref": "#/definitions/Income"
    }
   }
  },
  "projectDetails": {
   "type": "array",
   "items": {
    "properties": {
     "name": {
      "type": "string"
     },
     "age": {
      "type": "number"
     },
     "projects": {
      "$ref": "#/definitions/projects"
     }
    }
   },
   "minItems": 1,
   "maxItems": 4
  },
  "projects": {
   "type": "array",
   "items": {
    "properties": {
     "name": {
      "type": "string"
     },
     "age": {
      "type": "number"
     },
     "projectsAdditional": {
      "$ref": "#/definitions/projectsAdditional"
     }
    }
   },
   "minItems": 1,
   "maxItems": 4
  },
  "projectsAdditional": {
   "type": "array",
   "items": {
    "properties": {
     "Additional_name": {
      "type": "string"
     },
     "Additional_areacode": {
      "type": "number"
     }
    }
   },
   "minItems": 1,
   "maxItems": 4
  },
  "GeneralDetails": {
   "type": "object",
   "properties": {
    "age": {
     "type": "number"
    },
    "married": {
     "type": "boolean"
    },
    "phone": {
     "type": "number",
     "aem:afProperties": {
      "sling:resourceType": "/libs/fd/af/components/guidetelephone",
      "guideNodeClass": "guideTelephone"
     }
    },
    "address": {
     "type": "string"
    }
   }
  },
  "Family": {
   "type": "object",
   "properties": {
    "spouse": {
     "$ref": "#/definitions/spouse"
    },
    "kids": {
     "$ref": "#/definitions/kids"
    }
   }
  },
  "Income": {
   "type": "object",
   "properties": {
    "monthly": {
     "type": "number"
    },
    "yearly": {
     "type": "number"
    }
   }
  },
  "spouse": {
   "type": "object",
   "properties": {
    "name": {
     "type": "string"
    },
    "Income": {
     "$ref": "#/definitions/Income"
    }
   }
  },
  "kids": {
   "type": "array",
   "items": {
    "properties": {
     "name": {
      "type": "string"
     },
     "age": {
      "type": "number"
     }
    }
   },
   "minItems": 1,
   "maxItems": 4
  }
 },
 "type": "object",
 "properties": {
  "employee": {
   "$ref": "#/definitions/employee"
  }
 }
}

Reusable schema definitions reusable-schema-definitions

Definition keys are used to identify reusable schemas. The reusable schema definitions are used to create fragments. It is similar to identifying complex types in XSD. A sample JSON Schema with definitions is given below:

{
  "$schema": "https://json-schema.org/draft-04/schema#",

  "definitions": {
    "address": {
      "type": "object",
      "properties": {
        "street_address": { "type": "string" },
        "city":           { "type": "string" },
        "state":          { "type": "string" }
      },
      "required": ["street_address", "city", "state"]
    }
  },

  "type": "object",

  "properties": {
    "billing_address": { "$ref": "#/definitions/address" },
    "shipping_address": { "$ref": "#/definitions/address" }
  }
}

The above example defines a customer record, where each customer has both a shipping and a billing address. Structure of both the addresses is same—addresses have a street address, city and state— so it is a good idea to not duplicate the addresses. It also makes addition and deletion of fields easy for any future changes.

Pre-Configuring fields in JSON Schema Definition pre-configuring-fields-in-json-schema-definition

You can use the aem:afProperties property to preconfigure JSON Schema field to map to a custom adaptive form component. An example is listed below:

{
    "properties": {
        "sizeInMB": {
            "type": "integer",
            "minimum": 16,
            "maximum": 512,
            "aem:afProperties" : {
                 "sling:resourceType" : "/apps/fd/af/components/guideTextBox",
                 "guideNodeClass" : "guideTextBox"
             }
        }
    },
    "required": [ "sizeInMB" ],
    "additionalProperties": false
}

Configure scripts or expressions for form objects configure-scripts-or-expressions-for-form-objects

JavaScript is the expression language of adaptive forms. All the expressions are valid JavaScript expressions and use adaptive forms scripting model APIs. You can pre-configure form objects to evaluate an expression on a form event.

Use the aem:afproperties property to preconfigure adaptive form expressions or scripts for adaptive form components. For example, when the initialize event is triggered, the below code sets value of telephone field and prints a value to the log :

"telephone": {
  "type": "string",
  "pattern": "/\\d{10}/",
  "aem:affKeyword": ["phone", "telephone","mobile phone", "work phone", "home phone", "telephone number", "telephone no", "phone number"],
  "description": "Telephone Number",
  "aem:afProperties" : {
    "sling:resourceType" : "fd/af/components/guidetelephone",
    "guideNodeClass" : "guideTelephone",
    "events": {
      "Initialize" : "this.value = \"1234567890\"; console.log(\"ef:gh\") "
    }
  }
}

You should be a member of the forms-power-user group to configure scripts or expressions for form object. The below table lists all the script events supported for an adaptive form component.

Component \ Event

initialize

Calculate

Visibility

Validate

Enabled

Value Commit

Click

Options

Text Field

Numeric Field

Numeric Stepper

Radio Button

Telephone

Switch

Button

Check Box

Drop-down

Image Choice

Date Input Field

Date Picker

File Attachment

Image

Draw

Panel

Some examples of using events in a JSON are hiding a field on initialize event and configure value of another field on value commit event. For detailed information about creating expressions for the script events, see Adaptive Form Expressions.

Here is the sample JSON code for previously mentioned examples.

Hiding a field on initialize event hiding-a-field-on-initialize-event


"name": {
    "type": "string",
    "aem:afProperties": {
        "events" : {
            "Initialize" : "this.visible = false;"
        }
    }
}

Configure value of another field on value commit event configure-value-of-another-field-on-value-commit-event

"Income": {
    "type": "object",
    "properties": {
        "monthly": {
            "type": "number",
            "aem:afProperties": {
                "events" : {
                    "Value Commit" : "IncomeYearly.value = this.value * 12;"
                }
            }
        },
        "yearly": {
            "type": "number",
            "aem:afProperties": {
                "name": "IncomeYearly"
            }
        }
    }
}

Limit acceptable values for an adaptive form component limit-acceptable-values-for-an-adaptive-form-component

You can add the following restrictions to JSON Schema elements to limit the values acceptable to an adaptive form component:

Schema property

Data Type

Description

Component

maximum

String

Specifies the upper bound for numeric values and dates. By default, the maximum value is included.

Numeric box
Numeric Stepper
Date Picker

minimum

String

Specifies the lower bound for numeric values and dates. By default, the minimum value is included.

Numeric box
Numeric Stepper
Date Picker

exclusiveMaximum

Boolean

If true, the numeric value or date specified in the component of the form must be less than the numeric value or date specified for the maximum property.

If false, the numeric value or date specified in the component of the form must be less than or equal to the numeric value or date specified for the maximum property.

Numeric box
Numeric Stepper
Date Picker

exclusiveMinimum

Boolean

If true, the numeric value or date specified in the component of the form must be greater than the numeric value or date specified for the minimum property.

If false, the numeric value or date specified in the component of the form must be greater than or equal to the numeric value or date specified for the minimum property.

Numeric box
Numeric Stepper
Date Picker

minLength

String

Specifies the minimum number of characters allowed in a component. The minimum length must be equal to or greater than zero.

Text box

maxLength

String

Specifies the maximum number of characters allowed in a component. The maximum length must be equal to or greater than zero.

Text box

pattern

String

Specifies the sequence of the characters. A component accepts the characters if the characters conform to specified pattern.

The pattern property maps to the validation pattern of the corresponding adaptive form component.

All adaptive forms components which are mapped to an XSD schema

maxItems

String

Specifies the maximum number of items in an array. The maximum items must be equal to or greater than zero.

minItems

String

Specifies the minimum number of items in an array. The minimum items must be equal to or greater than zero.

Enable schema compliant data enablig-schema-compliant-data

To enable all JSON schema-based Adaptive Forms to generate schema-compliant data upon form submission, follow these steps:

Go to Experience Manager web console at https://server:host/system/console/configMgr.
Locate Adaptive Form and Interactice Communication Web Channel Configuration.
Select to open the configuration in edit mode.
Select the Generate Schema Compliant Data checkbox.
Save the settings.

adaptive form and interactive communication web channel configuration

Non-supported constructs non-supported-constructs

Adaptive forms do not support the following JSON Schema constructs:

Null type
Union types such as any, and
OneOf, AnyOf, AllOf, and NOT
Only Homogenous arrays are supported. So, the items constraint must be an object and not be an array.

Frequently asked questions frequently-asked-questions

Why I am not able to drag individual elements of a subform (structure generated from any complex type) for repeatable subforms (minOccours or maxOccurs values are greater than 1)?

In a repeatable subform, you must use the complete subform. If you want only selective fields, use the entire structure and delete the unwanted ones.

I have a long complex structure in Content Finder. How can I find a specific element?

You have two options:

Scroll through the tree structure
Use the Search box to find an element

What should be the extension of the JSON schema file?

The extension of JSON Schema file must be .schema.json. For example, <filename>.schema.json.

recommendation-more-help

19ffd973-7af2-44d0-84b5-d547b0dffee2