配置AEM自适应Forms的异步提交

上次更新: 2023-12-12
  • 创建对象:
  • Intermediate
    User
版本 文章链接
AEM 6.5 单击此处
AEM as a Cloud Service 本文

传统上,Web窗体配置为同步提交。 在同步提交中,当用户提交表单时,他们将被重定向到确认页面、感谢页面,或者在提交失败的情况下被重定向到错误页面。 但是,单页应用程序等现代Web体验越来越受欢迎,这是因为在后台进行客户端 — 服务器交互时,网页保持静态。 您可以配置异步提交以通过自适应Forms提供此体验。

在异步提交中,当用户提交表单时,表单开发人员会插入单独的体验,例如重定向到网站的其他表单或单独的部分。 作者还可以插入单独的服务(如将数据发送到不同的数据存储)或添加自定义分析引擎。 在异步提交的情况下,自适应表单的行为类似于单页应用程序,因为当在服务器上验证提交的表单数据时,表单不会重新加载或其URL不会更改。

请阅读并详细了解自适应Forms中的异步提交。

配置异步提交

要为自适应表单配置异步提交,请执行以下操作:

  1. 在自适应表单创作模式下,选择表单容器对象,然后选择 cmppr1 以打开其属性。

  2. 提交 属性部分,启用 使用异步提交.

  3. 在提交时 部分,选择下列选项之一以在成功提交表单时执行。

    • 重定向到URL:在提交表单时重定向到指定的URL或页面。 您可以指定URL或浏览以选择页面的路径 重定向URL/路径 字段。
    • 显示消息:在表单提交时显示消息。 您可以在下方的文本字段中编写消息 显示消息 选项。 文本字段支持富文本格式。
  4. 选择 check-button1 以保存属性。

异步提交的工作方式

Experience Manager Forms 为表单提交提供现成的成功和错误处理程序。 处理程序是根据服务器响应执行的客户端函数。在提交表单时,数据被传输到服务器进行验证,服务器将响应返回到客户端,其中包含有关提交的成功或错误事件的信息。 信息将作为参数传递给相关处理程序以执行函数。

此外,表单作者和开发人员可以在表单级别编写规则以覆盖默认处理程序。 有关更多信息,请参阅 使用规则覆盖默认处理程序.

让我们首先查看服务器响应中的成功和错误事件。

提交成功事件的服务器响应

针对提交成功事件的服务器响应的结构如下所示:

{oneOf: [
{  properties : {
     contentType : {"type" : "string",  "enum" : ["xmlschema", "jsonschema"]},
    data : {type : "string", description : "Form data in XML or  JSON  format"},
   thankYouOption : {type : "string"}
   }},
  properties : {
     contentType : {"type" : "string",  "enum" : ["xmlschema", "jsonschema"]},
    data : {type : "string", description : "Form data in XML or  JSON  format"},
   thankYouContent: {type: "string"}
   }
]

}

成功提交表单时的服务器响应包括:

  • 表单数据格式类型:XML或JSON
  • XML或JSON格式的表单数据
  • 已选择选项,用于重定向到页面或显示表单中配置的消息
  • 页面URL或消息内容,如表单中所配置

成功处理程序读取服务器响应,并相应地重定向到配置的页面URL或显示消息。

提交错误事件的服务器响应

针对提交错误事件的服务器响应的结构如下所示:

{
   errorCausedBy : "<CAPTCHA_VALIDATION or SERVER_SIDE_VALIDATION>",

   errors : [
               { "somExpression" : "<SOM Expression>",
                 "errorMessage"  : "<Error Message>"
               },
               ...
             ]
 }

在提交表单时出现错误时,服务器响应包括:

  • 错误原因,验证码或服务器端验证失败
  • 错误对象列表,其中包括验证失败的字段的SOM表达式和相应的错误消息

错误处理程序会读取服务器响应,并在表单上显示相应的错误消息。

使用规则覆盖默认处理程序

表单开发人员和作者可以在表单级别编写规则以覆盖默认处理程序。 成功和错误事件的服务器响应在表单级别公开,开发人员可以使用进行访问 $event.data 在规则中。

执行以下步骤来编写规则以处理成功和错误事件。

  1. 在创作模式下打开自适应表单,选择任意表单对象,然后选择 edit-rules1 以打开规则编辑器。

  2. 选择 表单 在“表单对象”树中选择 创建.

  3. 选择 已成功提交提交失败选择状态 下拉列表。

  4. 定义 所选状态的操作。 例如,选择 导航到 然后键入或粘贴一个URL。 您也可以使用 函数 选项卡。

    提交处理程序成功

  5. 选择 完成 以保存规则。

在此页面上