按值呈现Forms

最近更新： 2024年7月15日
  • 适用对象：
  • Experience Manager 6.5
  • 主题：

创建对象：

  • 开发人员

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

通常，在Designer中创建的表单设计会通过引用Forms服务进行传递。 窗体设计可以很大，因此，通过引用传递它们会更有效，从而不必按值封送窗体设计字节。 Forms服务还可以缓存表单设计，以便在缓存表单设计时，它不必持续读取表单设计。

如果表单设计包含UUID属性，则将其缓存。 UUID值对于所有表单设计都是唯一的，可用于唯一标识表单。 按值呈现表单时，仅当表单重复使用时才应缓存表单。 但是，如果表单未重复使用并且必须是唯一的，您可以避免使用使用AEM Forms API设置的缓存选项来缓存表单。

Forms服务还可以解决表单设计中链接内容的位置。 例如，从表单设计内引用的链接图像是相对URL。 始终假定链接的内容与表单设计位置相关。 因此，解决链接内容的问题是通过将相对路径应用于绝对表单设计位置来确定其位置。

您可以按值传递表单设计，而不是按参考传递表单设计。 在动态创建表单设计时，即客户端应用程序在运行时生成用于创建表单设计的XML时，按值传递表单设计是非常有效的。 在这种情况下，表单设计不会存储在物理存储库中，因为它存储在内存中。 在运行时动态创建表单设计并按值传递时，可以缓存表单并提高Forms服务的性能。

按值传递表单的限制

当表单设计按值传递时，以下限制适用：

  • 表单设计中不能包含相对链接的内容。 所有图像和片段必须嵌入到表单设计内或绝对引用。
  • 渲染表单后无法执行服务器端计算。 如果将表单提交回Forms服务，则会提取并返回数据，而无需任何服务器端计算。
  • 由于HTML只能在运行时使用链接的图像，因此无法生成包含嵌入图像的HTML。 这是因为Forms服务通过从引用的表单设计中检索图像来支持带有HTML的嵌入式图像。 由于按值传递的表单设计没有引用位置，因此在显示HTML页面时无法提取嵌入的图像。 因此，图像引用必须是绝对路径，才能在HTML中渲染。
注意
尽管您可以按值呈现不同类型的表单(例如，包含使用权限的HTML表单或表单)，本节将讨论如何呈现交互式PDF forms。
注意
有关Forms服务的详细信息，请参阅AEM Forms的服务参考。

步骤摘要

要按值呈现表单，请执行以下步骤：

  1. 包括项目文件。
  2. 创建Forms客户端API对象。
  3. 参考窗体设计。
  4. 按值呈现表单。
  5. 将表单数据流写入客户端Web浏览器。

包含项目文件

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

创建Forms客户端API对象

您必须先创建数据集成服务客户端，然后才能以编程方式将数据导入PDF表单客户端API。 创建服务客户端时，您可以定义调用服务所需的连接设置。

参考表单设计

在按值呈现表单时，您必须创建包含要呈现的表单设计的com.adobe.idp.Document对象。 您可以引用现有的XDP文件，也可以在运行时动态创建表单设计，并用该数据填充com.adobe.idp.Document。

注意
此部分和相应的快速入门引用了现有XDP文件。

按值呈现表单

要按值渲染表单，请将包含表单设计的com.adobe.idp.Document实例传递到渲染方法的inDataDoc参数（可以是FormsServiceClient对象的任何渲染方法，如renderPDFForm、(Deprecated) renderHTMLForm等）。 此参数值通常为合并到表单的数据保留。 同样，将空字符串值传递给formQuery参数。 通常，此参数需要一个指定窗体设计名称的字符串值。

注意
如果要在表单中显示数据，则必须在xfa:datasets元素中指定该数据。 有关XFA架构的信息，请转到https://www.pdfa.org/norm-refs/XFA-3_3.pdf。

将表单数据流写入客户端Web浏览器

当Forms服务按值呈现表单时，它会返回您必须写入客户端Web浏览器的表单数据流。 在写入客户端Web浏览器时，该表单对用户可见。

另请参阅

使用Java API按值呈现表单

使用Web服务API按值呈现表单

包括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.io.FileInputStream对象，该对象表示要呈现的表单设计，方法是使用其构造函数并传递一个指定XDP文件位置的字符串值。
    • 使用对象的构造函数创建com.adobe.idp.Document对象并传递java.io.FileInputStream对象。

  4. 按值呈现表单

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

    • 空字符串值。 （通常，此参数需要一个用于指定表单设计名称的字符串值。）
    • 包含表单设计的com.adobe.idp.Document对象。 通常，此参数值会保留给与表单合并的数据。
    • 存储运行时选项的PDFFormRenderSpec对象。 这是一个可选参数，如果您不想指定运行时选项，则可以指定null。
    • 包含Forms服务所需URI值的URLSpec对象。
    • 存储文件附件的java.util.HashMap对象。 这是一个可选参数，如果您不想将文件附加到表单，则可以指定null。

    renderPDFForm方法返回的FormsResult对象包含可以写入客户端Web浏览器的表单数据流。

  5. 将表单数据流写入客户端Web浏览器

    • 通过调用FormsResult对象的getOutputContent方法创建com.adobe.idp.Document对象。
    • 通过调用其getContentType方法获取com.adobe.idp.Document对象的内容类型。
    • 通过调用其setContentType方法并传递com.adobe.idp.Document对象的内容类型来设置javax.servlet.http.HttpServletResponse对象的内容类型。
    • 通过调用javax.servlet.http.HttpServletResponse对象的getOutputStream方法，创建用于将表单数据流写入客户端Web浏览器的javax.servlet.ServletOutputStream对象。
    • 通过调用com.adobe.idp.Document对象的getInputStream方法创建java.io.InputStream对象。
    • 创建字节数组并分配InputStream对象的大小。 调用InputStream对象的available方法以获取InputStream对象的大小。
    • 通过调用InputStream对象的read方法并将字节数组作为参数传递，使用表单数据流填充字节数组。
    • 调用javax.servlet.ServletOutputStream对象的write方法将表单数据流发送到客户端Web浏览器。 将字节数组传递给write方法。

另请参阅

按值呈现Forms

快速入门(SOAP模式)：使用Java API按值渲染

包括AEM Forms Java库文件

设置连接属性