自适应表单提交操作

上次更新: 2024-02-21
版本 文章链接
AEM 6.5 单击此处
AEM as a Cloud Service 本文

应用于:✔️用自适应表单基础组件。 ❌ 自适应表单核心组件. Adobe建议使用核心组件来 将自适应Forms添加到AEM Sites页面创建独立的自适应Forms.

当用户单击 提交 按钮。 Formsas a Cloud Service提供了以下开箱即用的提交操作。

您还可以 扩展默认提交操作 以创建您自己的提交操作。

您可以在中配置提交操作 提交 侧边栏中的自适应表单容器属性部分。

配置提交操作

提交到 REST 端点

使用​提交到 REST 端点​操作将提交的数据发布到 REST URL。该 URL 可以属于内部服务器(呈现表单的服务器)或外部服务器。

要将数据发布到内部服务器,请提供资源的路径。数据将发布到资源的路径。例如,/content/restEndPoint。对于此类 POST 请求,将使用提交请求的身份验证信息。

要将数据发布到外部服务器,请提供 URL。URL 的格式为 https://host:port/path_to_rest_end_point。确保配置以匿名方式处理 POST 请求的路径。

作为感谢页面参数传递的字段值的映射

在上面的示例中,使用参数 param1 捕获用户在 textbox 中输入的信息。用于发布使用 param1 捕获的数据的语法为:

String data=request.getParameter("param1");

同样,用于发布 XML 数据和附件的参数为 dataXmlattachments

例如,您在脚本中使用这两个参数来解析传输到 REST 端点的数据。您使用以下语法来存储和解析数据:

String data=request.getParameter("dataXml");
String att=request.getParameter("attachments");

在此示例中,data 存储 XML 数据,att 存储附件数据。

提交到 REST 端点​提交操作将表单中填入的数据作为 HTTP GET 请求的一部分提交到配置的确认页面。您可以添加要请求的字段的名称。请求的格式为:

{fieldName}={request parameter name}

如下图所示,param1param2 作为参数传递,其值是从下一操作中使用的​文本框​和​数字框​字段复制的。

配置 REST 端点提交操作

您也可以​启用 POST 请求​并提供用于发布请求的 URL。要将数据提交到托管表单的 AEM 服务器,请使用与 AEM 服务器的根路径对应的相对路径。例如,/content/forms/af/SampleForm.html。要将数据提交到任何其他服务器,请使用绝对路径。

注意

要将字段作为 REST URL 中的参数传递,所有字段都必须具有不同的元素名称,即使这些字段位于不同的面板上也是如此。

发送电子邮件

您可以使用 发送电子邮件 “提交操作”可在成功提交表单时向一个或多个收件人发送电子邮件。 生成的电子邮件可以包含预定义格式的表单数据。 例如,在以下模板中,将从提交的表单数据中检索客户名称、送货地址、州名和邮政编码。

```

${customer_Name},您好!

以下内容设定为您的默认配送地址:
${customer_Name},
${customer_Shipping_Address},
${customer_State},
${customer_ZIPCode}

此致,
WKND

```
注意
  • 所有表单字段必须具有不同的元素名称,即使这些字段位于自适应表单的不同面板上也是如此。
  • AEMas a Cloud Service要求对出站邮件进行加密。 默认情况下,出站电子邮件处于禁用状态。 要激活它,请将支持票证提交到 请求访问.

您还可以在电子邮件中包含附件和记录文档(DoR)。 要启用 附加记录文档 选项,配置自适应表单以生成记录文档(DoR)。 您可以启用相应选项,以从自适应表单属性生成记录文档。

使用表单数据模型提交

使用表单数据模型提交​提交操作将表单数据模型中指定的数据模型对象的已提交自适应表单数据写入其数据源。在配置该提交操作时,可以选择要将其提交数据写回其数据源的数据模型对象。

此外,您可以使用表单数据模型和记录文档 (DoR) 将表单附件提交到数据源。有关表单数据模型的信息,请参阅AEM Forms 数据集成

调用 AEM 工作流

调用 AEM 工作流​提交操作将自适应表单与 AEM 工作流相关联。在提交表单时,关联的工作流将在创作实例上自动启动。您可以将数据文件、附件和记录文档保存到工作流的负载位置或变量。如果已为外部数据存储标记和配置工作流,则仅变量选项可用。您可以从可用于工作流模型的变量的列表中进行选择。如果在稍后阶段而不是在创建工作流时为外部数据存储标记了工作流,请确保所需的变量配置已到位。

该提交操作将以下内容放置在工作流的负载位置或变量中(如果为外部数据存储标记了工作流):

  • 数据文件:它包含已提交到自适应表单的数据。您可以使用​数据文件路径​选项来指定文件名和相对于负载的文件路径。例如,/addresschange/data.xml 路径会创建一个名为 addresschange 的文件夹,并将它放置在负载的相对位置。您也可以仅指定 data.xml 以仅发送提交的数据而不创建文件夹层次结构。如果为外部数据存储标记了工作流,请使用变量选项,并从对工作流模型可用的变量列表中选择变量。

  • 附件:您可以使用​附件路径​选项指定用于存储已上传到自适应表单的附件的文件夹名称。该文件夹是相对于负载创建的。如果为外部数据存储标记了工作流,请使用变量选项,并从对工作流模型可用的变量列表中选择变量。

  • 记录文档:它包含为自适应表单生成的记录文档。您可以使用​记录文档路径​选项来指定记录文档的文件名以及相对于负载的文件路径。例如,/addresschange/DoR.pdf 路径将创建一个相对于负载的名为 addresschange 的文件夹,并相对于负载放置 DoR.pdf。您也可以仅指定 DoR.pdf 以仅保存记录文档而不创建文件夹层次结构。如果为外部数据存储标记了工作流,请使用变量选项,并从对工作流模型可用的变量列表中选择变量。

使用​调用 AEM 工作流​提交操作之前,为 AEM DS 设置服务​配置进行以下设置:

  • 处理服务器 URL:处理服务器是触发表单或 AEM 工作流的服务器。这可以与 AEM 创作实例或其他服务器的 URL 相同。

  • 处理服务器用户名:工作流用户的用户名

  • 处理服务器密码:工作流用户的密码

提交到 SharePoint

提交到 SharePoint​提交操作将自适应表单与 Microsoft® SharePoint 存储连接起来。您可以将表单数据文件、附件或记录文档提交到连接的Microsoft® Sharepoint存储。

通过使用提交到SharePoint,您可以:

将自适应表单连接到SharePoint文档库

要使用 提交到SharePoint文档库 以自适应表单提交操作:

  1. 创建SharePoint文档库配置:用于将AEM Forms连接到Microsoft® Sharepoint存储。
  2. 在自适应表单中使用“提交到 SharePoint”提交操作:它将自适应表单连接到配置的 Microsoft® SharePoint。

创建SharePoint文档库配置

要将AEM Forms连接到Microsoft®Sharepoint文档库存储,请执行以下操作:

  1. 转到您的 AEM Forms Author 实例> 工具 > Cloud Service > Microsoft®SharePoint.

  2. 一旦您选择 Microsoft®SharePoint,您将被重定向到 SharePoint Browser.

  3. 选择​配置容器。配置存储在选定的配置容器中。

  4. 单击 创建 > SharePoint文档库 下拉列表中。 这将显示 SharePoint 配置向导。

    SharePoint 配置

  5. 指定​标题客户端 ID客户端密码​和 OAuth URL。有关如何检索 OAuth URL 的客户端 ID、客户端密码、租户 ID 的信息,请参阅 Microsoft® 文档

    • 您可以从 Microsoft® Azure 门户检索应用程序的Client IDClient Secret
    • 在 Microsoft® Azure 门户中,将重定向 URI 添加为 https://[author-instance]/libs/cq/sharepoint/content/configurations/wizard.html。将 [author-instance] 替换为创作实例 URL。
    • 添加 API 权限 offline_accessSites.Manage.All 以提供读/写权限。
    • 使用 OAuth URL:https://login.microsoftonline.com/tenant-id/oauth2/v2.0/authorize。将 <tenant-id> 替换为 Microsoft® Azure 门户中应用程序的 tenant-id
    注意

    客户端密码​字段是必填还是可选字段取决于 Azure Active Directory 应用程序配置。如果应用程序配置为使用客户端密码,则必须提供客户端密码。

  6. 单击​连接。连接成功后,将显示Connection Successful消息。

  7. 现在,选择 SharePoint站点 > 文档库 > SharePoint文件夹,以保存数据。

    注意
    • 默认情况下, forms-ootb-storage-adaptive-forms-submission 在选定的SharePoint站点上出现。
    • 创建文件夹为 forms-ootb-storage-adaptive-forms-submission,如果列表中尚未存在 Documents 选定SharePoint站点的库,方法是单击 创建文件夹.

现在,您可以在自适应表单中将此SharePoint Sites配置用于提交操作。

在自适应表单中使用SharePoint文档库配置

您可以在自适应表单中使用创建的SharePoint文档库配置,将数据或生成的记录文档保存到SharePoint文件夹中。 执行以下步骤以在自适应表单中使用SharePoint文档库存储配置,如下所示:

  1. 创建自适应表单

    注意
    • 选择相同的 配置容器 用于自适应表单,您已在该表单中创建了SharePoint Document Library存储。
    • 如果未选择配置容器,则全局存储配置文件夹将显示在提交操作属性窗口中。
  2. 选择​提交到 SharePoint 作为​提交操作
    SharepointGIF

  3. 选择要用于保存数据的​存储配置

  4. 单击​保存​以保存提交设置。

提交表单时,数据将保存在指定的Microsoft® Sharepoint文档库存储中。
用于保存数据的文件夹结构是 /folder_name/form_name/year/month/date/submission_id/data

将自适应表单连接到Microsoft® SharePoint列表

要使用 提交到SharePoint列表 以自适应表单提交操作:

  1. 创建SharePoint列表配置:用于将AEM Forms连接到Microsoft® Sharepoint List Storage。
  2. 在自适应表单中使用表单数据模型提交:它将您的自适应表单连接到配置的Microsoft® SharePoint。

创建SharePoint列表配置

要将AEM Forms连接到Microsoft®Sharepoint列表:

  1. 转到 工具 > Cloud Service > Microsoft®SharePoint.

  2. 选择​配置容器。配置存储在选定的配置容器中。

  3. 单击 创建 > SharePoint列表 下拉列表中。 这将显示 SharePoint 配置向导。

  4. 指定​标题客户端 ID客户端密码​和 OAuth URL。有关如何检索 OAuth URL 的客户端 ID、客户端密码、租户 ID 的信息,请参阅 Microsoft® 文档

    • 您可以从 Microsoft® Azure 门户检索应用程序的Client IDClient Secret

    • 在 Microsoft® Azure 门户中,将重定向 URI 添加为 https://[author-instance]/libs/cq/sharepointlist/content/configurations/wizard.html。将 [author-instance] 替换为创作实例 URL。

    • 添加API权限 offline_accessSites.Manage.AllMicrosoft® Graph 选项卡以提供读/写权限。 添加 AllSites.Manage 中的权限 Sharepoint 选项卡,以与SharePoint数据远程交互。

    • 使用 OAuth URL:https://login.microsoftonline.com/tenant-id/oauth2/v2.0/authorize。将 <tenant-id> 替换为 Microsoft® Azure 门户中应用程序的 tenant-id

      注意

      客户端密码​字段是必填还是可选字段取决于 Azure Active Directory 应用程序配置。如果应用程序配置为使用客户端密码,则必须提供客户端密码。

  5. 单击​连接。连接成功后,将显示Connection Successful消息。

  6. 选择 SharePoint站点SharePoint列表 下拉列表中。

  7. 选择 创建 创建Microsoft® SharePointList的云配置。

在自适应表单中使用表单数据模型提交

您可以在自适应表单中使用创建的SharePoint列表配置,以在SharePoint列表中保存数据或生成的记录文档。 执行以下步骤以在自适应表单中使用SharePoint List存储配置,如下所示:

  1. 使用Microsoft® SharePoint列表配置创建表单数据模型
  2. 配置表单数据模型以检索和发送数据
  3. 创建自适应表单
  4. 使用表单数据模型配置提交操作

提交表单时,数据将保存在指定的Microsoft® Sharepoint列表存储中。

注意

在Microsoft® SharePoint List中,不支持以下列类型:

  • 图像列
  • 元数据列
  • 人员列
  • 外部数据列

提交到 OneDrive

提交到 OneDrive​提交操作将自适应表单与 Microsoft® OneDrive 连接起来。您可以将表单数据、文件、附件或记录文档提交到连接的 Microsoft® OneDrive 存储。要在自适应表单中使用提交到 OneDrive 提交操作,请执行以下操作:

  1. 创建 OneDrive 配置:它将 AEM Forms 连接到 Microsoft® OneDrive 存储。
  2. 在自适应表单中使用“提交到 OneDrive”提交操作:它将自适应表单
    连接到配置的 Microsoft® OneDrive。

创建 OneDrive 配置

要将 AEM Forms 连接到 Microsoft® OneDrive 存储,请执行以下操作:

  1. 转到 AEM Forms 创作​实例 > 工具 > Cloud Service > Microsoft® OneDrive

  2. 选定 Microsoft® OneDrive 后,您将重定向到 OneDrive 浏览器

  3. 选择​配置容器。配置存储在选定的配置容器中。

  4. 单击​创建。这将显示 OneDrive 配置向导。

    OneDrive 配置屏幕

  5. 指定​标题客户端 ID客户端密码​和 OAuth URL。有关如何检索 OAuth URL 的客户端 ID、客户端密码、租户 ID 的信息,请参阅 Microsoft® 文档

    • 您可以从 Microsoft® Azure 门户检索应用程序的Client IDClient Secret
    • 在 Microsoft® Azure 门户中,将重定向 URI 添加为 https://[author-instance]/libs/cq/onedrive/content/configurations/wizard.html。将 [author-instance] 替换为创作实例 URL。
    • 添加 API 权限 offline_accessFiles.ReadWrite.All 以提供读/写权限。
    • 使用 OAuth URL:https://login.microsoftonline.com/tenant-id/oauth2/v2.0/authorize。将 <tenant-id> 替换为 Microsoft® Azure 门户中应用程序的 tenant-id
    注意

    客户端密码​字段是必填还是可选字段取决于 Azure Active Directory 应用程序配置。如果应用程序配置为使用客户端密码,则必须提供客户端密码。

  6. 单击​连接。连接成功后,将显示Connection Successful消息。

  7. 现在,选择 OneDrive 容器 > [OneDrive 文件夹]​以保存数据。

    注意
    • 默认情况下,forms-ootb-storage-adaptive-forms-submission 位于 OneDrive 容器中。
    • 通过单击​创建文件夹​来创建一个 forms-ootb-storage-adaptive-forms-submission 形式的文件夹(如果该文件夹不存在)。

现在,您可以在自适应表单中将此 OneDrive 存储配置用于提交操作。

在自适应表单中使用 OneDrive 配置

您可以在自适应表单中使用创建的 OneDrive 存储配置,将数据或生成的记录文档保存在 OneDrive 文件夹中。在以下情况下,执行以下步骤可在自适应表单中使用 OneDrive 存储配置:

  1. 创建自适应表单

    注意
    • 为自适应表单选择相同的配置容器,您已在其中创建 OneDrive 存储。
    • 如果未选择配置容器,则全局存储配置文件夹将显示在提交操作属性窗口中。
  2. 选择​提交到 OneDrive 作为​提交操作
    OneDrive GIF

  3. 选择要用于保存数据的​存储配置

  4. 单击​保存​以保存提交设置。

在提交表单时,数据将保存在指定的 Microsoft® OneDrive 存储中。
用于保存数据的文件夹结构是 /folder_name/form_name/year/month/date/submission_id/data

提交到 Azure Blob 存储

提交到 Azure Blob 存储​提交操作将自适应表单与 Microsoft® Azure 门户连接起来。您可以将表单数据、文件、附件或记录文档提交到连接的 Azure 存储容器。要使用 Azure Blob 存储的提交操作,请执行以下操作:

  1. 创建 Azure Blob 存储容器:它将 AEM Forms 连接到 Azure 存储容器。
  2. 在自适应表单中使用 Azure 存储配置:它将自适应表单连接到配置的 Azure 存储容器。

创建 Azure Blob 存储容器

要将 AEM Forms 连接到 Azure 存储容器,请执行以下操作:

  1. 转到 AEM Forms 创作​实例 > 工具 > Cloud Service > Azure 存储

  2. 选定 Azure 存储​后,您将重定向到 Azure 存储浏览器

  3. 选择​配置容器。配置存储在选定的配置容器中。

  4. 单击​创建。这将显示“创建 Azure 存储配置”向导。

    Azure 存储配置

  5. 指定​标题Azure 存储帐户​和 Azure 访问密钥

    • 您可以从 Microsoft® Azure 门户中的存储帐户检索 Azure Storage Account名称和 Azure Access key
  6. 单击​保存

现在,您可以在自适应表单中将此 Azure 存储容器配置用于提交操作。

在自适应表单中使用 Azure 存储配置

您可以在自适应表单中使用创建的 Azure 存储容器配置,将数据或生成的记录文档保存在 Azure 存储容器中。执行以下步骤可在自适应表单中使用 Azure 存储容器配置:

  1. 创建自适应表单

    注意
    • 为自适应表单选择相同的配置容器,您已在其中创建 OneDrive 存储。
    • 如果未选择配置容器,则全局存储配置文件夹将显示在提交操作属性窗口中。
  2. 选择​提交到 Azure Blob 存储​作为​提交操作
    Azure Blob 存储 GIF

  3. 选择要用于保存数据的​存储配置

  4. 单击​保存​以保存提交设置。

提交表单时,数据将保存在指定的 Azure 存储容器配置中。
用于保存数据的文件夹结构是 /configuration_container/form_name/year/month/date/submission_id/data

要设置配置的值,请使用 AEM SDK 生成 OSGi 配置,并向 Cloud Service 实例部署配置

提交至 Power Automate

您可以配置自适应表单以在提交时运行 Microsoft® Power Automate Cloud Flow。配置的自适应表单将捕获的数据、附件和记录文档发送到 Power Automate Cloud Flow 进行处理。它可帮助您构建自定义数据捕获体验,同时利用 Microsoft® Power Automate 的强大功能围绕捕获的数据构建业务逻辑并自动执行客户工作流。以下几个示例说明了在将自适应表单与 Microsoft® Power Automate 集成后可执行的操作:

  • 在 Power Automate 业务流程中使用自适应表单数据
  • 使用 Power Automate 将捕获的数据发送到 500 多个数据源或任何公开可用的 API
  • 对捕获的数据执行复杂计算
  • 按预定义的计划将自适应表单数据保存到存储系统

自适应表单编辑器提供​调用 Microsoft® Power Automate 流程​提交操作,以将自适应表单数据、附件和记录文档发送到 Power Automate Cloud Flow。要使用提交操作将捕获的数据发送到 Microsoft® Power Automate,请将 Forms as a Cloud Service 实例与 Microsoft® Power Automate 关联

在成功配置后,使用调用 Microsoft® Power Automate 流程提交操作将数据发送到 Power Automate Flow。

提交到 Workfront Fusion

您可以配置自适应表单,以便在提交时将数据提交到Workfront Fusion。 Workfront Fusion允许流程自动化,以便用户能够专注于新任务,而不是一次又一次地重复相同的任务。 它自动化了简单和复杂的任务,节省了时间并确保了一致的流程执行。

自适应Forms编辑器提供 调用Workfront Fusion场景 提交操作以将自适应Forms数据或附件发送到Workfront Fusion场景。 要使用提交操作将捕获的数据发送到Workfront Fusion方案,请参阅 将自适应表单提交到Adobe Workfront Fusion.

使用同步或异步提交

提交操作可使用同步或异步提交。

同步提交:传统上,Web 表单配置为以同步方式提交。在同步提交中,当用户提交表单时,他们将重定向到确认页面、感谢页面或(如果提交失败)错误页面。您可以选择​使用异步提交​选项,将用户重定向到网页或在提交时显示消息。

配置提交操作

异步提交:像单页面应用程序这样的现代 Web 体验越来越受欢迎,其中网页保持静态,而客户端与服务器的交互在后台进行。您现在可以通过配置异步提交来使用自适应表单提供此体验。

自适应表单中的服务器端重新验证

通常,在任何在线数据捕获系统中,开发人员都会在客户端放置一些 JavaScript 验证来强制实施一些业务规则。但在现代浏览器中,最终用户有办法绕过这些验证,并使用各种技术(例如,Web Browser DevTools Console)手动进行提交。此类技术也适用于自适应表单。尽管表单开发人员可以创建各种验证逻辑,但从技术上讲,最终用户可以绕过这些验证逻辑并向服务器提交无效数据。无效数据会破坏表单作者强制实施的业务规则。

此外,利用服务器端重新验证功能,可以运行自适应表单作者在服务器上设计自适应表单时提供的验证。这可防止任何可能的数据提交损害和与表单验证相关的业务规则违反情况。

在服务器上进行哪些验证?

在服务器上重新运行的自适应表单的所有现成的 (OOTB) 字段验证包括:

  • 必填
  • 验证图片子句
  • 验证表达式

启用服务器端验证

使用边栏中自适应表单容器下方的​在服务器上重新验证,可以为当前表单启用或禁用服务器端验证。

启用服务器端验证

启用服务器端验证

如果最终用户绕过这些验证并提交表单,服务器将重新执行验证。如果服务器端验证失败,则将停止提交事务。用户将再次看到原始表单。 捕获的数据和提交的数据将作为错误呈现给用户。

注意

服务器端验证将验证表单模型。建议您创建一个单独的客户端库以用于验证,不要将它与同一客户端库中的 HTML 样式和 DOM 操作等其他项混合。

支持验证表达式中的自定义函数

有时,如果存在​复杂的验证规则,则准确的验证脚本驻留在自定义函数中,并且作者从字段验证表达式中调用这些自定义函数。要在执行服务器端验证时使此自定义函数库已知并可用,表单作者可以在自适应表单容器属性的​基本​选项卡下配置 AEM 客户端库的名称,如下所示。

支持验证表达式中的自定义函数

支持验证表达式中的自定义函数

作者可以为每个自适应表单配置自定义 JavaScript 库。该库中只保留可重用的函数,这些函数依赖 jquery 和 underscore.js 第三方库。

提交操作的错误处理

作为 AEM 安全和强化指南的一部分,配置自定义错误页面,例如 400.jsp、404.jsp 和 500.jsp。如果提交表单时出现 400、404 或 500 错误,则将调用这些处理程序。在发布节点上触发这些错误代码时,也将调用处理程序。您还可以为其他 HTTP 错误代码创建 JSP 页面。

在使用符合架构(其中数据不包含 <afData><afBoundData></afUnboundData> 标签)的 XML 或 JSON 数据预填充表单数据模型或基于架构的自适应表单时,自适应表单的未绑定字段的数据将丢失。该架构可以是 XML 架构、JSON 架构或表单数据模型。未绑定的字段是自适应表单字段,不带 bindref 属性。

在此页面上