使用自适应表单的最佳实践

概述

Adobe Experience Manager(AEM)表单可帮助您将复杂的事务转换为简单、令人愉快的数字体验。 但是,它需要齐心协力来实施、构建、执行和维护一个高效和生产性的AEM Forms生态系统。

本文档提供了管理员、作者和开发人员在使用AEM Forms(特别是自适应表单组件)时可从中受益的准则和建议。 它讨论了从设置表单开发项目到配置、自定义、创作和优化AEM Forms的最佳实践。 这些最佳做法共同促进了AEM Forms生态系统的整体绩效。

此外,以下是一些常规AEM最佳实践的推荐读法:

设置和配置AEM Forms

设置表单开发项目

简化和标准化的项目结构可以显着减少开发和维护工作。 Apache Maven是一种构建AEM项目推荐的开源工具。

  • 使用Apache Maven aem-project-archetype为AEM项目创建和管理结构。 它会为您的AEM项目创建推荐的结构和模板。 此外,它还提供构建自动化和更改控制系统,以帮助管理项目。

    • 使用maven archetype:generate命令生成初始结构。
    • 使用maven eclipse:eclipse命令生成eclipse项目文件并将项目导入eclipse。

有关更多信息,请参阅如何使用Apache Maven构建AEM项目。

  • FileVault工具或VLT可帮助您将CRX或AEM实例的内容映射到文件系统。 它提供变更控制管理操作,如AEM项目内容的签入和签出。 请参阅如何使用VLT工具

  • 如果您使用Eclipse集成的开发环境,则可以使用AEM开发人员工具将Eclipse IDE与AEM实例无缝集成,以创建AEM应用程序。 有关详细信息,请参阅AEM Eclipse开发人员工具

  • 请勿在/libs文件夹中存储任何内容或进行任何修改。 在/app文件夹中创建叠加以扩展或覆盖默认功能。

  • 在创建包以移动内容时,请确保包过滤器路径正确,并且只提及所需的路径。

  • 请勿在/libs文件夹中存储任何内容或进行任何修改。 在/app文件夹中创建叠加以扩展或覆盖默认功能。

  • 为软件包定义正确的依赖项以强制执行预先确定的安装顺序/顺序。

  • 请勿在/libs或/apps中创建任何可引用的节点。

规划创作环境

设置AEM项目后,定义用于创作和自定义自适应表单模板和组件的策略。

  • 自适应表单模板是一个专用的AEM页面,用于定义自适应表单的结构和页眉和页脚信息。 模板已为自适应表单预配置了布局、样式和基本结构。 AEM Forms提供了现成的模板和组件,您可以使用这些模板和组件创作自适应表单。 但是,您可以根据需要创建自定义模板和组件。 建议收集对自适应表单中所需的其他模板和组件的要求。 有关详细信息,请参阅自定义自适应表单和组件

  • AEM Forms允许您根据以下表单模型创建自适应表单。 表单模型充当表单与AEM系统之间数据交换的接口,并为自适应表单内外的数据流提供基于XML的结构。 此外,表单模型以模式和XFA约束的形式对自适应表单施加规则和约束。

    • :使用此选项创建的自适应表单不使用任何表单模型。从这种表单生成的数据XML具有平坦结构,其中具有字段和相应的值。
    • XML或JSON架构:XML和JSON架构表示组织内的后端系统生成或使用数据的结构。您可以将架构与自适应表单相关联,并使用其元素向自适应表单添加动态内容。 架构的元素位于内容浏览器的“数据模型对象”选项卡中,用于创作自适应表单。 您可以拖放架构元素以构建表单。
    • XFA表单模板:如果您在基于XFA的HTML5表单中进行了投资,则它是理想的表单模型。它提供了一种将基于XFA的表单转换为自适应表单的直接方法。 任何现有的XFA规则都将保留在关联的自适应表单中。 生成的自适应表单支持XFA构建,如验证、事件、属性和模式。
    • 表单数据模型:如果您希望集成后端系统(如数据库、Web服务和AEM用户配置文件)以预填充自适应表单并将提交的表单数据写回后端系统,则它是首选的表单模型。通过表单数据模型编辑器,您可以在表单数据模型中定义和配置实体和服务,以用于创建自适应表单。 有关更多信息,请参阅AEM Forms数据集成

请务必仔细选择数据模型,该模型不仅符合您的要求,而且还可扩展您在XFA和XSD资产(如果有)中的现有投资。 建议使用XSD模型创建表单模板,因为生成的XML包含由架构定义的按XPATH定义的数据。 使用XSD模型作为表单数据模型的默认选项也有帮助,因为它可以从处理和使用数据的后端系统中分离表单设计,并且由于表单字段的一对一映射而提高了表单性能。 此外,字段的BindRef可以作为其XML中数据值的XPATH。

有关更多信息,请参阅创建自适应表单

  • 自适应表单中有一些常见部分。 您可以识别它们并定义策略以促进内容重复使用。 自适应表单允许您创建独立的片段并在表单中重复使用。 您还可以将自适应表单中的面板另存为片段。 片段中的任何更改都会反映在所有关联的表单中。 它有助于您缩短创作时间并确保表单之间的一致性。 此外,使用片段使自适应表单变得更加轻巧,从而改善了创作体验,尤其是大型表单的创作体验。 有关更多信息,请参阅自适应表单片段

自定义自适应表单和组件

  • AEM Forms提供了现成的自适应表单模板,您可以使用这些模板创建自适应表单。 您还可以创建自己的模板。 AEM提供静态和可编辑的模板。

    • 静态模板由开发人员定义和配置。
    • 可编辑的模板由作者使用模板编辑器创建。 利用模板编辑器,可定义模板的基本结构和初始内容。 结构层中的任何修改都会反映在使用该模板的所有表单中。 初始内容可以包括预配置的主题、预填充服务、提交操作等。 但是,可以使用表单编辑器为表单修改这些设置。 有关更多信息,请参阅自适应表单模板
  • 要为特定字段或面板实例设置样式,请使用内联样式。 或者,您也可以在CSS文件中定义类,并在组件的CSS类属性中指定类名称。

  • 将客户端库包含在组件中,以便始终如一地在使用该组件的自适应表单或片段中应用样式。 有关更多信息,请参阅创建自适应表单页面组件

  • 应用客户端库中定义的样式以选择自适应表单,方法是在自适应表单容器属性的CSS文件路径字段中指定客户端库的路径。

  • 要创建样式的客户端库,您可以在主题编辑器基本clientlib或表单容器属性中配置自定义CSS文件。

  • 自适应表单提供了面板布局(如响应式、选项卡式、折叠式和向导),以控制表单组件在面板中的布局方式。 您可以创建自定义面板布局,并使其可供表单作者使用。 有关更多信息,请参阅为自适应表单创建自定义布局组件

  • 您还可以自定义特定的自适应表单组件,如字段和面板布局。

    • 使用AEM的Overlay功能修改组件副本。 不建议修改默认组件。
    • 要在/libs中自定义现成自适应表单组件的布局,除了默认布局之外, 还要创建自定义布局组件
    • 通过创建自定义小组件或外观来引入自定义交互活动。 不建议修改默认组件。 有关更多信息,请参阅外观框架
  • 有关处理PII数据的建议,请参阅处理个人身份信息

创作自适应表单

使用触屏优化UI进行创作

  • 在侧栏中使用对象浏览器快速访问表单层次结构中的深层字段。 您可以使用搜索框在表单或对象树中搜索对象,以从一个对象导航到另一个对象。

  • 要在侧栏的组件浏览器中查看和编辑组件的属性,请选择组件,然后单击cmppr-1。 您还可以双击某个组件,以在属性浏览器中查看其属性。

  • 使用键盘快捷键对表单执行快速操作。 请参阅AEM Forms键盘快捷键

  • 建议仅在自适应表单页面中使用自适应表单组件。 这些组件依赖于其父层次结构。 因此,请不要在AEM页面中使用它们。

另请参阅创作自适应表单简介中的组件描述和最佳实践。

在自适应表单中使用规则

AEM Forms提供了一个规则编辑器,用于创建规则以将动态行为添加到自适应表单组件。 使用这些规则,您可以评估条件并触发对组件的操作,例如显示或隐藏字段、计算值、动态更改下拉列表等。

规则编辑器提供了用于编写规则的可视化编辑器和代码编辑器。 使用代码编辑器模式编写规则时,请考虑以下事项:

  • 为表单字段和组件使用有意义且唯一的名称,以避免在编写规则时出现任何可能的冲突。

  • 对组件使用this运算符,以便在规则表达式中引用其自身。 它可确保即使组件名称发生更改,规则也保持有效。 例如,field1.valueCommit script: this.value > 10

  • 引用其他表单组件时,请使用组件名称。 使用value属性获取字段或组件的值。 例如,field1.value

  • 按相对唯一的层次结构引用组件以避免任何冲突。 例如,parentName.fieldName

  • 在处理复杂或常用的规则时,请考虑将业务逻辑编写为函数,在单独的客户端库中编写,您可以在自适应表单中指定和重复使用这些函数。 客户端库应为自包含库,除jQuery和Underscore.js外,不应有任何外部依赖项。 您还可以使用客户端库对提交的表单数据强制执行服务器端重新验证

  • 自适应表单提供了一组API,您可以使用这些API与自适应表单通信并对自适应表单执行操作。 一些关键API如下所示。 有关更多信息,请参阅自适应Forms的JavaScript库API引用

    • guideBridge.reset():重置表单。

    • guideBridge.submit():提交表单。

    • guideBridge.setFocus(somExp, focusOption, runCompletionExp):将焦点设置到字段。

    • guideBridge.validate(errorList, somExpression, focus):验证表单。

    • guideBridge.getDataXML(options):将表单数据作为XML获取。

    • guideBridge.resolveNode(somExpression):获取表单对象。

    • guideBridge.setProperty(somList, propertyName, valueList):设置表单对象的属性。

    • 此外,您还可以使用以下字段属性:

      • field.value 更改字段的值。
      • f ield.enabled启用/禁用字段。
      • field.visible 更改字段的可见性。
  • 自适应表单作者可能需要编写JavaScript代码以在表单中构建业务逻辑。 尽管JavaScript功能强大且有效,但它可能会损害安全预期。 因此,您必须确保表单作者是可信任的人物,并且在表单投入生产之前,需要先审核和批准JavaScript代码的流程。 管理员可以根据用户组的角色或功能限制对规则编辑器访问权限。 请参阅授予规则编辑器对选定用户组的访问权限

  • 您可以在规则中使用表达式来使自适应表单动态。 所有表达式都是有效的JavaScript表达式,且使用自适应表单脚本模型API。 这些表达式返回某些类型的值。 有关表达式及其最佳实践的更多信息,请参阅自适应表单表达式

处理主题

主题自适应允许您创建可在表单中应用的可重用样式,以保持一致的外观和样式。 建议使用主题为表单组件和面板定义样式。 有关主题的一些最佳实践如下:

  • 使用资产库可快速应用文本样式、背景和图像。 在资产库中添加样式后,该样式可用于其他主题和表单编辑器的样式模式。
  • 使用页面级别选择器应用全局设置,如字体和页面背景。
  • 使用客户端库将现有或高级样式导入您的主题。
  • 您可以覆盖表单样式层中特定字段、面板或按钮的样式。
  • 如果主题不符合您的样式要求,您可以使用预定义类(如guideFieldNode、guideFieldLabel、guideFieldWidget和guidePanelNode)来跨表单应用通用样式。

有关更多信息,请参阅主题

优化大型和复杂表单的性能

表单作者和最终用户在创作模式或运行时加载大型表单时通常会遇到性能问题。 随着表单中对象(字段和面板)数量的增加,创作和运行时体验开始降级。 它还可防止多个作者同时协作和创作表单。

请考虑以下最佳实践,以克服大型表单的性能问题:

  • 建议在将XFA转换为自适应表单(如果可能)时,也使用XSD表单数据模型创建自适应表单。

  • 在自适应表单中仅包括那些从用户处捕获信息的字段和面板。 请考虑将静态内容保持为最小,或使用URL在单独的窗口中打开它们。

  • 虽然每个表单都是为特定目的而设计的,但大多数表单中有一些常见的区段。 例如,个人详细信息、地址、雇佣详细信息等。 为常用表单元素和部分创建自适应表单片段,并在表单中使用它们。 您还可以将现有表单中的面板另存为片段。 片段中的任何更改都会反映在所有关联的自适应表单中。 它促进协作创作,因为多个作者可以同时处理构成表单的不同片段。

    • 与自适应表单类似,建议使用片段容器对话框在客户端库中定义所有特定于片段的样式和自定义脚本。 此外,请尝试创建不依赖外部对象的自足片段。
    • 避免使用跨片段脚本。 如果片段外有您必须引用的任何对象,请尝试将该对象设为父表单的一部分。 如果对象仍必须位于其他片段中,请在脚本中按其名称引用它。
  • 使用自动保存的保存和恢复功能定期保存自适应表单,并允许用户稍后重新访问以完成表单。

  • 配置片段以懒惰加载。 在运行时,标记为懒惰加载的片段仅在需要时才呈现。 它显着缩短了大型表单的加载时间。 片段中还支持使用可重复面板的此功能。 有关更多信息,请参阅配置延迟加载

    • 请勿在响应式网格布局或第一个面板中对片段配置延迟加载。
    • 懒散加载的片段不支持文件附件和条款和条件组件。
    • 如果延迟加载面板中的某个值在表单的其他部分中使用,则将该值标记为全局使用值,以便该值在卸载容器面板时可用。
    • 考虑为应根据条件显示或隐藏的片段编写可见性规则。

预填自适应表单

您可以使用从后端获取的数据预填自适应表单字段,以帮助用户快速填写表单并避免键入错误。

  • AEM Forms提供预填充服务,用于从预定义的数据XML文件中读取数据,并使用预填充XML文件中的内容预填充自适应表单的字段。

  • 预填充数据XML必须与与自适应表单关联的表单模型架构兼容。

  • 在预填充XML中包括afBoundedDataafUnBoundedData部分,以在自适应表单中预填充绑定字段和未绑定字段。

  • 对于基于表单数据模型的自适应表单,AEM Forms提供了现成的表单数据模型预填充服务。 预填充服务查询自适应表单中数据模型对象的数据源,并在呈现表单时预填充字段值。

  • 您还可以使用文件、crx、服务或http协议预填自适应表单。

  • AEM Forms支持自定义预填充服务,您可以将这些服务作为OSGi服务插入来预填充自适应表单。

有关更多信息,请参阅预填自适应表单字段

签署和提交自适应表单

自适应表单需要提交操作才能处理用户指定的数据。 “提交”操作确定使用自适应表单对您提交的数据执行的任务。

  • 自适应表单中有几个现成可用的提交操作。 有关详细信息,请参阅配置Submit操作
  • 如果默认提交操作不符合您的用例,您可以编写自定义提交操作。 有关更多信息,请参阅编写自适应表单的自定义提交操作
  • 包括服务器端验证,以防止提交无效的数据。

您可以在自适应表单中利用Adobe Sign的多符号体验。 在自适应表单中配置Adobe Sign时,请考虑以下事项。 有关详细信息,请参阅在自适应表单中使用Adobe Sign

  • 只有在所有签名者都签署了表单后,才会提交启用了Adobe Sign的自适应表单。 Forms将以“待签名”状态显示,直到表单由所有签名者签名为止。
  • 您可以配置表单内签名体验,或在提交时将签名者重定向到签名页面。
  • 根据需要配置顺序或并行签名体验。

生成记录文档

记录文档(DoR)是可打印、签名或存档的自适应表单的扁平化PDF版本。

  • 根据自适应表单所基于的表单数据模型,您可以按如下方式为DoR配置模板:

    • XFA表单模板:使用关联的XDP文件作为DoR模板。
    • XSD架构:使用与自适应表单使用的相同XML架构的关联XFA模板。
    • :使用自动生成的DoR。
  • 从自适应表单编辑器的“记录文档”选项卡中,直接配置页眉、页脚、图像、颜色、字体等。

  • 使用DoRService以编程方式生成DoR。

  • 从DoR中排除隐藏字段。

  • 使用afAcceptLang请求参数查看其他区域设置中的DoR。

调试和测试自适应表单

AEM Chrome插件是 适用于Google Chrome的浏览器扩展,提供了调试自适应表单的工具。表单作者和开发人员可以使用这些工具:

  • 找出瓶颈并优化表单渲染的性能
  • 调试表单中的关键词和bindRef错误
  • 启用和配置日志
  • 调试表单中的规则和脚本
  • 探索和了解guideBridge API

有关更多信息,请参阅AEM Chrome插件 — 自适应表单

Calvin SDK是一个实用程序API,供自适应Forms开发人员测试自适应Forms。 Calvin SDK是基于Hobbes.js测试框架构建的。 您可以使用框架来测试以下内容:

  • 自适应表单的演绎版体验
  • 自适应表单的预填体验
  • 提交自适应表单的体验
  • 表达式规则
  • 验证
  • 延迟加载

有关更多信息,请参阅自动测试自适应表单

在AEM服务器上验证自适应表单

需要进行服务器端验证,以防止任何绕过客户端验证的尝试,以及数据提交和业务规则违规的任何可能危害。 服务器端验证通过加载所需的客户端库来执行。

  • 在客户端库中包含用于验证自适应表单中表达式的函数,并在自适应表单容器对话框中指定客户端库。 有关更多信息,请参阅服务器端重新验证
  • 服务器端验证可验证表单模型。 建议创建单独的客户端库以进行验证,但不要将其与同一客户端库中的HTML样式和DOM操作等其他内容混合使用。

本地化自适应表单

AEM提供了翻译工作流,您可以使用这些工作流将自适应表单本地化。 有关信息,请参阅使用AEM翻译工作流将自适应表单本地化

本地化自适应表单的一些最佳实践如下所示:

  • 将自适应表单片段用于表单中的常见元素,并将片段本地化。 它确保将片段本地化一次,并且它反映在使用本地化片段的所有表单中。

  • 任何修改(如添加新组件或在本地化表单中应用脚本)都不会自动本地化。 因此,您必须在将表单本地化之前完成表单,以避免多次本地化周期。

  • 使用afAcceptLang请求参数覆盖浏览器区域设置,并在指定的区域设置中呈现表单。 例如,以下URL将强制以日语区域设置呈现表单,而不考虑浏览器设置中指定的区域设置:

    https://'[server]:[port]'/<contextPath>/<formFolder>/<formName>.html?wcmmode=disabled&afAcceptLang=ja

  • AEM Forms目前支持以英语(en)、西班牙语(es)、法语(fr)、意大利语(it)、德语(de)、日语(ja)、葡萄牙语 — 巴西语(pt-BR)、中文(zh-CN)、中国 — 台湾语(zh-TW)和韩语(ko-KR)区域设置本地化自适应表单内容。 但是,您可以在运行时为自适应表单添加新区域设置支持。 有关更多信息,请参阅支持自适应表单本地化的新区域设置

准备用于生产的表单项目

添加表单处理服务器

您可以在安全区域中配置位于防火墙后面的AEM Forms服务器的其他实例。 您可以将此实例用于:

  • 批处理:批量重复或计划的作业,且负载较重。例如,打印语句、生成对应项,以及使用文档服务(如PDF生成器、输出和汇编程序)。
  • 存储PII数据:将PII数据保存到处理服务器。如果您已使用自定义存储提供程序存储PII数据,则不需要此操作。

将项目移动到其他环境

您通常需要将AEM项目从一个环境移动到另一个环境。 移动时要记住的一些关键事项如下:

  • 备份现有客户端库、自定义代码和配置。
  • 在新环境中按指定顺序手动部署产品包和修补程序。
  • 手动部署特定于项目的代码包和包,并将它们作为单独的包或包部署在新的AEM服务器上。
  • (仅在JEE上的AEM Forms)在Forms Workflow服务器上手动部署LCA和DSC。
  • 使用Export-Import功能将资产移动到新环境。 您还可以配置复制代理和发布资产。
  • 升级时,请使用新的API和功能替换所有已弃用的API和功能。

配置AEM

配置AEM以提高整体性能的一些最佳实践如下:

  • 从Felix控制台中为JavaScript和CSS启用HTML客户端库压缩。 请参见Clientlibs,如示例所述。

  • /etc.clientlibs/fd处缓存所有客户端库,并在AEM Dispatcher上缓存任何其他自定义客户端库,以提高已发布表单的响应性和安全性。 有关更多信息,请参阅Dispatcher

  • 请勿缓存/content/forms/af//content/dam/formsanddocuments/*路径。 有关配置自适应表单缓存的详细信息,请参阅缓存自适应表单

  • 通过Web服务器压缩模块启用HTML。 有关更多信息,请参阅AEM Forms服务器的性能调整

  • 为大型表单增加每个请求配置的调用数。 请参阅优化大型和复杂表单的性能

  • 创建由错误处理程序🔗显示的自定义错误页。

  • 安全的AEM Forms服务器。

  • 将堆大小保持为最小8 GB。 有关其他设置,请参阅AEM Forms服务器的性能调整

  • 使用服务用户会话而不是管理员会话来执行服务级别任务。 有关更多信息,请参阅服务身份验证

为草稿和提交的表单数据配置外部存储

在生产环境中,建议不要将提交的表单数据存储在AEM存储库中。 Forms门户存储、存储内容和存储PDF提交操作的默认实施将表单数据存储到AEM存储库中。 这些提交操作仅用于演示目的。 此外,默认情况下,“保存并恢复”和“自动保存”功能使用门户存储。 因此,请考虑以下建议:

  • 存储草稿数据:如果您使用自适应表单的草稿功能,则应该实施自定义服务提供接口(SPI),以将草稿数据存储在更安全的存储中,如数据库。有关更多信息,请参阅将草稿和提交组件与数据库集成的示例。

  • 存储提交数据:如果您使用表单门户提交存储,则应该实施自定义SPI以将提交数据存储在数据库中。有关集成示例,请参阅将草稿和提交组件与数据库集成的示例。

    您还可以编写自定义提交操作,将表单数据和附件存储在安全存储中。 有关更多信息,请参阅编写自适应表单的自定义提交操作

  • 草稿ID的长度:将自适应表单另存为草稿时,将生成草稿ID,以唯一标识草稿。草稿ID字段长度的最小值为26个字符。 Adobe建议将草稿ID长度设置为26个或更多字符。

处理个人身份信息

组织面临的一个关键挑战是如何处理个人身份(PII)数据。 有助于您处理此类数据的一些最佳实践如下:

  • 使用安全的外部存储(如数据库)来存储草稿和提交的表单中的数据。 请参阅为草稿和提交的表单数据配置外部存储
  • 使用“条款和条件”表单组件,在启用自动保存之前获得用户的明确同意。 在这种情况下,仅当用户同意“条款”和“条件”组件中的条件时,才启用自动保存。

在此页面上