Rendering form template for HTML5 forms

Last update: June 24, 2024

CREATED FOR:

  • Admin
  • User
  • Developer

Render Endpoint

HTML5 forms have the notion of Profiles which are exposed as REST Endpoints to enable Mobile Rendering of Form Templates. These Profiles have associated Profile Renderer. They are JSP pages responsible for generating HTML representation of the form by calling the Forms OSGi service. The JCR path of the Profile node determines the URL of the render end point. The default render end point of the form pointing to ‘default’ profile looks like:

https://<host>:<port>/content/xfaforms/profiles/default.html?contentRoot=<path of the folder containg form xdp>&template=<name of the xdp>

For example, http://localhost:4502/content/xfaforms/profiles/default.html?contentRoot=c:/xdps&template=sampleForm.xdp

For a custom profile, the endpoint changes accordingly. For example, the end point for the custom profile with the name hrforms is:

http://localhost:4502/content/xfaforms/profiles/hrforms.html?contentRoot=c:/xdps&template=sampleForm.xdp

If your template resides in the AEM repository in an application called FormSubmission, the URI is:

http://localhost:4502/content/xfaforms/profiles/default.html?
 contentRoot=crx:///content/dam/formsanddocuments/FormSubmission/1.0
 &template=sampleForm.xdp

Render Parameters

The request parameters supported while rendering form as HTML are:

ParameterDescription
templateThis parameter specifies the name of the template file.
contentRootThis parameter specifies the path where the template and the associated resources reside. This path can be the server file system path or a repository path or http or an ftp path.
submitUrlThis parameter specifies the url to which the form data xml is posted.

Merge Data with form template

ParameterDescription
dataRefThis parameter specifies absolute path of the data file that is merged with the template. This parameter can be a URL to a rest service returning the data in xml format.
dataThis parameter specifies the UTF-8 encoded data bytes that are merged with the template. If this parameter is specified, the HTML5 form ignores dataRef parameter.

Passing the render parameter

HTML5 forms support three methods for passing the render parameters. You can pass parameters via URLs, key-value pairs, and profile node. In the render parameter, key-value pair holds highest precedence followed by profile node. The URL Request parameter holds least precedence.

  • URL request parameters: You can specify the render parameters in the URL. In the URL request parameters, the parameters are visible to the end user. For example, the following submit URL contains template parameter in the URL: http://localhost:4502/content/xfaforms/profiles/default.html?contentRoot=/Applications/FormSubmission/1.0&template=sampleForm.xdp

  • SetAttribute request parameters: You can specify the render parameters as a key-value pair. In the SetAttribute request parameters, the parameters are not visible to the end user. You can forward a request from any other JSP to HTML5 form profile renderer JSP and use setAttribute on request object to pass all the render parameters. This method has highest precedence.

  • Profile node request parameters: You can specify the render parameters as node properties of a profile node. In the profile node request parameters, the parameters are not visible to the end user. Profile node is the node where request is sent. To specify parameters as node properties, use CRXDE lite.

Submit Parameters

HTML5 forms submit data; execute server-sided scripts and web-services on AEM servers. For detailed information on parameters used to execute server-sided scripts and web-services on AEM servers, see HTML5 forms Service Proxy.

Experience Manager


Espressos & Experience Manager: AEM Forms

Espressos & Experience Manager

Thursday, Mar 6, 7:00 PM UTC

Join Adobe's AEM product team as they highlight AEM Forms' latest innovations, including: the new Gen AI Assistant, Unified Composition with AEM Sites, and new ways to deploy forms through conversations.

Register

Connect with Experience League at Summit!

Get front-row access to top sessions, hands-on activities, and networking—wherever you are!

Learn more

Register now