文档AEM 6.5用户指南

处理提交的Forms

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 适用对象：
  • Experience Manager 6.5
  • 主题：

创建对象：

  • 开发人员

本文档中的示例和示例仅适用于JEE环境上的AEM Forms。

使用户能够填写交互式表单的基于Web的应用程序要求将数据提交回服务器。 使用Forms服务，您可以检索用户在交互式表单中输入的数据。 检索数据后，您可以处理数据以满足业务要求。 例如，您可以将数据存储在数据库中，将数据发送到另一个应用程序，将数据发送到另一个服务，在表单设计中合并数据，在Web浏览器中显示数据，等等。

表单数据将作为XML或PDF数据(在Designer中设置的一个选项)提交到Forms服务。 以XML形式提交的表单允许您提取单个字段数据值。 即，您可以提取用户在表单中输入的每个表单字段的值。 作为PDF数据提交的表单是二进制数据，而不是XML数据。 您可以将表单另存为PDF文件，或将表单发送到其他服务。 如果要从以XML形式提交的表单中提取数据，然后使用该表单数据创建PDF文档，请调用另一个AEM Forms操作。 (请参阅使用提交的XML数据创建PDF文档)

下图显示了从Web浏览器中显示的交互式表单提交到名为HandleData的Java Servlet的数据。

hs_hs_handlesubmit

下表说明了图中的步骤。

步骤
描述
1
用户填写交互式表单，然后单击该表单的“提交”按钮。
2
数据作为XML数据提交到HandleData Java Servlet。
3
HandleData Java Servlet包含用于检索数据的应用程序逻辑。

处理提交的XML数据

以XML格式提交表单数据时，您可以检索表示所提交数据的XML数据。 所有表单字段在XML架构中显示为节点。 节点值对应于用户填充的值。 考虑一个贷款表单，其中表单中的每个字段都显示为XML数据中的一个节点。 每个节点的值对应于用户填充的值。 假设用户使用下表中显示的数据填写贷款表单。

hs_hs_loanformdata

下图显示了使用Forms服务客户端API检索到的相应XML数据。

hs_hs_loandata

贷款表单中的字段。 可以检索这些值
使用Java XML类。

NOTE
必须在Designer中正确配置表单设计，才能将数据作为XML数据提交。 要正确配置表单设计以提交XML数据，请确保将表单设计上的提交按钮设置为提交XML数据。 有关设置“提交”按钮以提交XML数据的信息，请参阅AEM Forms Designer。

处理提交的PDF数据

假定一个Web应用程序调用Forms服务。 Forms服务向客户端Web浏览器呈现交互式PDF表单后，用户填写表单并将其作为PDF数据提交回来。 当Forms服务收到PDF数据时，它可以将PDF数据发送到另一个服务或另存为PDF文件。 下图显示了应用程序的逻辑流。

hs_hs_savingforms

下表描述了此图中的步骤。

步骤
描述
1
网页包含一个链接，该链接访问调用Forms服务的Java Servlet。
2
Forms服务向客户端Web浏览器呈现交互式PDF表单。
3
用户填写交互式表单并单击提交按钮。 该表单将作为PDF数据提交回Forms服务。 此选项是在Designer中设置的。
4
Forms服务将PDF数据另存为PDF文件。

处理提交的URL UTF-16数据

如果表单数据作为URL UTF-16数据提交，则客户端计算机需要Adobe Reader或Acrobat 8.1或更高版本。 此外，如果表单设计包含具有URL编码数据(HTTP Post)的提交按钮，并且数据编码选项是UTF-16，则必须在文本编辑器（例如记事本）中修改表单设计。 您可以为提交按钮将编码选项设置为UTF-16LE或UTF-16BE。 Designer不提供此功能。

NOTE
有关Forms服务的详细信息，请参阅AEM Forms的服务参考。

步骤摘要

要处理已提交的表单，请执行以下任务：

  1. 包括项目文件。
  2. 创建Forms客户端API对象。
  3. 检索表单数据。
  4. 确定表单提交是否包含文件附件。
  5. 处理提交的数据。

包含项目文件

在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序，请包含必要的JAR文件。 如果使用Web服务，请确保包含代理文件。

创建Forms客户端API对象

您必须先创建Forms服务客户端，然后才能以编程方式执行Forms服务客户端API操作。 如果您使用的是Java API，请创建一个FormsServiceClient对象。 如果您使用的是Forms Web服务API，请创建一个FormsService对象。

检索表单数据

要检索提交的表单数据，请调用FormsServiceClient对象的processFormSubmission方法。 调用此方法时，您必须指定已提交表单的内容类型。 当数据从客户端Web浏览器提交到Forms服务时，它可以作为XML或PDF数据提交。 要检索输入到表单字段中的数据，可以作为XML数据提交这些数据。

您还可以通过设置以下运行时选项，从作为PDF数据提交的表单中检索表单字段：

  • 将以下值作为内容类型参数传递给processFormSubmission方法： CONTENT_TYPE=application/pdf。
  • 将RenderOptionsSpec对象的PDFToXDP值设置为true
  • 将RenderOptionsSpec对象的ExportDataFormat值设置为XMLData

调用processFormSubmission方法时，请指定已提交表单的内容类型。 以下列表指定了适用的内容类型值：

  • text/xml：表示在PDF表单以XML形式提交表单数据时使用的内容类型。
  • application/x-www-form-urlencoded：表示在HTML表单以XML形式提交数据时使用的内容类型。
  • application/pdf：表示在PDF表单将数据提交为PDF时使用的内容类型。
NOTE
您会注意到有三个与处理提交的Forms部分相关的快速启动。 使用Java API快速入门以PDF形式提交的处理PDF forms演示了如何处理提交的PDF数据。 此快速入门中指定的内容类型为application/pdf。 使用Java API快速入门以XML形式提交的处理PDF forms演示了如何处理从PDF表单提交的提交的XML数据。 此快速入门中指定的内容类型为text/xml。 同样，使用Java API快速入门以XML形式提交的处理HTML表单演示了如何处理从HTML表单提交的提交的XML数据。 此快速入门中指定的内容类型为application/x-www-form-urlencoded。

您可以检索发布到Forms服务的表单数据，并确定其处理状态。 也就是说，将数据提交到Forms服务时，这并不一定意味着Forms服务已完成数据处理，数据已准备好进行处理。 例如，可以将数据提交到Forms服务，以便执行计算。 计算完成后，表单会呈现回用户并显示计算结果。 在处理提交的数据之前，建议您确定Forms服务是否已完成数据处理。

Forms服务将返回以下值，以指示它是否已完成处理数据：

  • 0 （提交）： ​提交的数据已准备好处理。
  • 1 （计算）： Forms服务对数据执行了计算操作，结果必须呈现回用户。
  • 2（验证）： Forms服务已验证表单数据，必须将结果呈现回用户。
  • 3 （下一步）： ​当前页面已更改，结果必须写入客户端应用程序。
  • 4 （上一页）：当前页面已更改，结果必须写入客户端应用程序。
NOTE
计算和验证必须呈现回用户。 (请参阅计算表单数据。

确定表单提交是否包含文件附件

提交到Forms服务的Forms可以包含文件附件。 例如，使用Acrobat的内置附件窗格，用户可以选择要与表单一起提交的文件附件。 此外，用户还可以使用随HTML文件一起呈现的HTML工具栏选择文件附件。

确定表单是否包含文件附件后，即可处理数据。 例如，可以将文件附件保存到本地文件系统。

NOTE
表单必须作为PDF数据提交才能检索文件附件。 如果表单作为XML数据提交，则不会提交文件附件。

处理提交的数据

根据提交数据的内容类型，您可以从提交的XML数据中提取单个表单字段值，或将提交的PDF数据保存为PDF文件（或将其发送到其他服务）。 若要提取单个表单字段，请将提交的XML数据转换为XML数据源，然后使用org.w3c.dom类检索XML数据源值。

另请参阅

包括AEM Forms Java库文件

设置连接属性

Forms服务API快速启动

将文档传递到Forms服务

创建可渲染Forms的Web应用程序

使用Java API处理提交的表单

使用Forms API (Java)处理提交的表单：

  1. 包含项目文件

    在Java项目的类路径中包含客户端JAR文件，例如adobe-forms-client.jar。

  2. 创建Forms客户端API对象

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用构造函数创建FormsServiceClient对象并传递ServiceClientFactory对象。

  3. 检索表单数据

    • 要检索发布到Java Servlet的表单数据，请使用其构造函数创建com.adobe.idp.Document对象，并从构造函数中调用javax.servlet.http.HttpServletResponse对象的getInputStream方法。
    • 使用构造函数创建RenderOptionsSpec对象。 通过调用RenderOptionsSpec对象的setLocale方法并传递指定区域设置值的字符串值来设置区域设置值。
    NOTE
    您可以通过调用RenderOptionsSpec对象的setPDF2XDP方法并传递true以及调用setXMLData并传递true，指示Forms服务从提交的PDF内容创建XDP或XML数据。 然后，您可以调用FormsResult对象的getOutputXML方法来检索与XDP/XML数据对应的XML数据。 （由processFormSubmission方法返回FormsResult对象，下个子步骤将对此进行说明。）

    • 调用FormsServiceClient对象的processFormSubmission方法并传递以下值：

      • 包含表单数据的com.adobe.idp.Document对象。
      • 一个字符串值，它指定包含所有相关HTTP标头的环境变量。 指定要处理的内容类型。 要处理XML数据，请为此参数指定以下字符串值： CONTENT_TYPE=text/xml。 要处理PDF数据，请为此参数指定以下字符串值： CONTENT_TYPE=application/pdf。
      • 一个字符串值，它指定HTTP_USER_AGENT标头值，例如。 Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)。此参数值是可选的。
      • 存储运行时选项的RenderOptionsSpec对象。

      processFormSubmission方法返回包含表单提交结果的FormsResult对象。

    • 确定Forms服务是否通过调用FormsResult对象的getAction方法已完成表单数据的处理。 如果此方法返回值0，则数据已准备好进行处理。

  4. 确定表单提交是否包含文件附件

    • 调用FormsResult对象的getAttachments方法。 此方法返回一个java.util.List对象，其中包含使用表单提交的文件。
    • 循环访问java.util.List对象以确定是否存在文件附件。 如果有文件附件，则每个元素都是一个com.adobe.idp.Document实例。 您可以通过调用com.adobe.idp.Document对象的copyToFile方法并传递java.io.File对象来保存文件附件。
    NOTE
    此步骤仅适用于以PDF形式提交的表单。

  5. 处理提交的数据

    • 如果数据内容类型为application/vnd.adobe.xdp+xml或text/xml，请创建应用程序逻辑以检索XML数据值。

      • 通过调用FormsResult对象的getOutputContent方法创建com.adobe.idp.Document对象。
      • 通过调用java.io.DataInputStream构造函数并传递com.adobe.idp.Document对象来创建java.io.InputStream对象。
      • 通过调用静态org.w3c.dom.DocumentBuilderFactory对象的newInstance方法创建一个org.w3c.dom.DocumentBuilderFactory对象。
      • 通过调用org.w3c.dom.DocumentBuilderFactory对象的newDocumentBuilder方法创建org.w3c.dom.DocumentBuilder对象。
      • 通过调用org.w3c.dom.DocumentBuilder对象的parse方法并传递java.io.InputStream对象来创建org.w3c.dom.Document对象。
      • 检索XML文档中每个节点的值。 完成此任务的一种方法是创建接受两个参数的自定义方法：org.w3c.dom.Document对象以及要检索其值的节点的名称。 此方法返回表示节点值的字符串值。 在此过程之后的代码示例中，此自定义方法称为getNodeText。 给出了该方法的正文。

    • 如果数据内容类型为application/pdf，请创建应用程序逻辑以将提交的PDF数据保存为PDF文件。

      • 通过调用FormsResult对象的getOutputContent方法创建com.adobe.idp.Document对象。
      • 使用公共构造函数创建java.io.File对象。 请确保指定PDF作为文件扩展名。
      • 通过调用com.adobe.idp.Document对象的copyToFile方法并传递java.io.File对象来填充PDF文件。

另请参阅

快速入门(SOAP模式)：使用Java API处理作为XML提交的PDF forms

快速入门(SOAP模式)：使用Java API处理作为XML提交的HTML表单

快速入门(SOAP模式)：使用Java API处理作为PDF提交的PDF forms

包括AEM Forms Java库文件

设置连接属性

使用Web服务API处理提交的PDF数据

使用Forms API（Web服务）处理提交的表单：

  1. 包含项目文件

    • 创建使用Forms服务WSDL的Java代理类。
    • 将Java代理类包含在类路径中。

  2. 创建Forms客户端API对象

    创建FormsService对象并设置身份验证值。

  3. 检索表单数据

    • 要检索发布到Java Servlet的表单数据，请使用其构造函数创建BLOB对象。

    • 通过调用javax.servlet.http.HttpServletResponse对象的getInputStream方法创建java.io.InputStream对象。

    • 使用对象的构造函数创建java.io.ByteArrayOutputStream对象并传递java.io.InputStream对象的长度。

    • 将java.io.InputStream对象的内容复制到java.io.ByteArrayOutputStream对象中。

    • 通过调用java.io.ByteArrayOutputStream对象的toByteArray方法创建字节数组。

    • 通过调用其setBinaryData方法并将字节数组作为参数传递来填充BLOB对象。

    • 使用构造函数创建RenderOptionsSpec对象。 通过调用RenderOptionsSpec对象的setLocale方法并传递指定区域设置值的字符串值来设置区域设置值。

    • 调用FormsService对象的processFormSubmission方法并传递以下值：

      • 包含表单数据的BLOB对象。
      • 一个字符串值，它指定包含所有相关HTTP标头的环境变量。 指定要处理的内容类型。 要处理XML数据，请为此参数指定以下字符串值： CONTENT_TYPE=text/xml。 要处理PDF数据，请为此参数指定以下字符串值： CONTENT_TYPE=application/pdf。
      • 指定HTTP_USER_AGENT标头值的字符串值；例如，Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)。
      • 存储运行时选项的RenderOptionsSpec对象。
      • 方法填充的空BLOBHolder对象。
      • 方法填充的空javax.xml.rpc.holders.StringHolder对象。
      • 方法填充的空BLOBHolder对象。
      • 方法填充的空BLOBHolder对象。
      • 方法填充的空javax.xml.rpc.holders.ShortHolder对象。
      • 方法填充的空MyArrayOf_xsd_anyTypeHolder对象。 此参数用于存储与表单一起提交的文件附件。
      • 用提交表单的方法填充的空FormsResultHolder对象。

      processFormSubmission方法使用表单提交结果填充FormsResultHolder参数。

    • 确定Forms服务是否通过调用FormsResult对象的getAction方法已完成表单数据的处理。 如果此方法返回值0，则表单数据已准备好进行处理。 您可以通过获取FormsResultHolder对象的value数据成员的值来获取FormsResult对象。

  4. 确定表单提交是否包含文件附件

    获取MyArrayOf_xsd_anyTypeHolder对象的value数据成员的值（已将MyArrayOf_xsd_anyTypeHolder对象传递到processFormSubmission方法）。 此数据成员返回Objects的数组。 Object数组中的每个元素都是一个Object，它与随表单一起提交的文件相对应。 您可以获取数组中的每个元素，并将其强制转换为BLOB对象。

  5. 处理提交的数据

    • 如果数据内容类型为application/vnd.adobe.xdp+xml或text/xml，请创建应用程序逻辑以检索XML数据值。

      • 通过调用FormsResult对象的getOutputContent方法创建BLOB对象。
      • 通过调用BLOB对象的getBinaryData方法创建字节数组。
      • 通过调用java.io.ByteArrayInputStream构造函数并传递字节数组来创建java.io.InputStream对象。
      • 通过调用静态org.w3c.dom.DocumentBuilderFactory对象的newInstance方法创建一个org.w3c.dom.DocumentBuilderFactory对象。
      • 通过调用org.w3c.dom.DocumentBuilderFactory对象的newDocumentBuilder方法创建org.w3c.dom.DocumentBuilder对象。
      • 通过调用org.w3c.dom.DocumentBuilder对象的parse方法并传递java.io.InputStream对象来创建org.w3c.dom.Document对象。
      • 检索XML文档中每个节点的值。 完成此任务的一种方法是创建接受两个参数的自定义方法：org.w3c.dom.Document对象以及要检索其值的节点的名称。 此方法返回表示节点值的字符串值。 在此过程之后的代码示例中，此自定义方法称为getNodeText。 给出了该方法的正文。

    • 如果数据内容类型为application/pdf，请创建应用程序逻辑以将提交的PDF数据保存为PDF文件。

      • 通过调用FormsResult对象的getOutputContent方法创建BLOB对象。
      • 通过调用BLOB对象的getBinaryData方法创建字节数组。
      • 使用公共构造函数创建java.io.File对象。 请确保指定PDF作为文件扩展名。
      • 使用对象的构造函数创建java.io.FileOutputStream对象并传递java.io.File对象。
      • 通过调用java.io.FileOutputStream对象的write方法并传递字节数组来填充PDF文件。

另请参阅

使用Base64编码调用AEM Forms

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2