New render and submit service

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

In Workbench, when you define an AssignTask operation, specify a particular form (XDP or PDF form). Also, specify a set of Render and Submit services, via action profile.

An XDP can be rendered as a PDF form or an HTML form. The new capabilities include the ability to:

  • Render and Submit an XDP form as HTML
  • Render and Submit an XDP form as PDF on desktop, and as HTML on mobile devices (for example, an iPad)

New HTML Forms service

The new HTML Forms service leverages the new feature in Forms to support rendering of XDP form as HTML. The new HTML Forms service exposes the following methods:

/*
 * Generates a URL (for the HTML Form) to be passed to client, given a TaskContext.
 * The output of this API is something like this - /lc/content/xfaforms/profiles/default.ws.html?ContentRoot=repository://Applications/MyApplication/MyFolder&template=MyForm.xdp
 * @param taskContext task context
 * @param profileName Forms servlet URL.
 * @return form URL string
 */
public String generateFormURL(TaskContext taskContext, String profileName);

/*
 * Render the XDP Form as HTML. Can be used directly for updating the runtimeMap in render.
 * It adds the following keys to the map -
 * hint:new html form = true
 * newHTMLFormURL = the URL returned after calling 'generateFormURL' API.
 * @param TaskContext taskContext
 * @param profileName Forms servlet URL.
 * @param runtimeMap runtime map<string,object> associated with form rendering.
 * return runtimeMap
 */
public Map<String, Object> renderHTMLForm (TaskContext taskContext, String profileName, Map<String,Object> runtimeMap);

More information on Mobile Form profiles can be found at Creating a custom profile.

New HTML Form Render & Submit Processes

For every ‘AssignTask’ operation, specify a Render and a Submit process with the form. These processes are called by TaskManager renderFormand submitFormAPIs to allow custom handling. Semantics of these processes for New HTML Form:

Render a new HTML form

The new process to render HTML, like every render process, has the following I/O parameters -

Input - taskContext

Output - runtimeMap

Output - outFormDoc

This method simulates the exact behavior of renderHTMLForm API of the NewHTMLFormsService. It calls the generateFormURL API to get the URL for HTML rendition of the form. It then populates the runtimeMap with following key or values:

new html form = true

newHTMLFormURL = the URL returned after calling generateFormURL API.

Submit a new HTML form

This process to submit a new HTML form works with the following I/O parameters -

Input - taskContext

Output - runtimeMap

Output - outputDocument

The process sets the outputDocumentto the inputDocumentretrieved from taskContext.

Default Render or Submit processes, and action profiles

The default Render and Submit services enable support to render PDFs on a desktop, and HTML on mobile devices (iPad).

Default Render Form

This process renders an XDP Form on multiple platforms, seamlessly. The process retrieves the user agent from taskContext, and uses the data to call the process to render either HTML or PDF.

default-render-form

Default Submit Form

This process submits an XDP form on multiple platforms seamlessly. It retrieves the user agent from taskContextand uses the data to call the process to submit either HTML or PDF.

default-submit-form

Switch the rendering of mobile forms from PDF to HTML

Browsers are gradually withdrawing support for NPAPI-based plug-ins, including plug-ins for Adobe Acrobat and Adobe Acrobat Reader. You can change rendering of mobile forms from PDF to HTML using the following steps:

  1. Log in to Workbench as a valid user.

  2. Select File > Get Applications.

    Get Applications dialog appears.

  3. Select the applications for which you want to change the mobile form rendering and click OK.

  4. Open the process for which you want to change the rendering.

  5. Open the targeted startpoint/task, navigate to the Presentation & Data section, and click Manage Action Profiles.

    Manage Action Profiles dialog appears.

  6. Change Default render profile configurations from PDF to HTML and click OK.

  7. Check in the process.

  8. Repeat the steps to change the rendering for other processes.

  9. Deploy the application relevant to the processes you have changed.