呈现交互式PDF forms rendering-interactive-pdf-forms

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

适用对象：
Experience Manager 6.5

主题：

创建对象：

开发人员

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

Forms服务向客户端设备（通常是Web浏览器）呈现交互式PDF forms，以从用户那里收集信息。呈现交互式表单后，用户可以在表单字段中输入数据，然后单击表单上的提交按钮以将信息发送回Forms服务。必须在托管客户端Web浏览器的计算机上安装Adobe Reader或Acrobat，以便显示交互式PDF表单。

NOTE

在使用Forms服务呈现表单之前，请先创建表单设计。通常，表单设计在Designer中创建，并保存为XDP文件。有关创建表单设计的信息，请参阅Forms Designer。

示例贷款申请

引入了一个贷款申请示例，以演示Forms服务如何使用交互式表单从用户那里收集信息。通过此应用程序，用户可在表单中填写保护贷款所需的数据，然后将数据提交到Forms服务。下图显示了贷款申请的逻辑流程。

ri_ri_finsrv_loanapp_v1

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

步骤

描述

从HTML页调用GetLoanForm Java Servlet。

GetLoanForm Java Servlet使用Forms服务客户端API向客户端Web浏览器呈现贷款表单。 (请参阅使用Java API渲染交互式PDF表单。)

用户填写贷款表单并单击提交按钮后，数据将提交到HandleData Java Servlet。（请参阅 “贷款表单”。）

HandleData Java Servlet使用Forms服务客户端API处理表单提交并检索表单数据。然后，将数据存储在企业数据库中。 (请参阅处理提交的Forms。)

确认表单将呈现回Web浏览器。诸如用户名字和姓氏的数据在呈现之前将与表单合并。 (请参阅使用可流动布局预填充Forms。)

贷款表单

此交互式贷款表单由示例贷款申请的GetLoanForm Java Servlet提供。

ri_ri_loanform

确认表单

此表单由示例贷款申请的HandleData Java Servlet提供。

ri_ri_confirm

HandleData Java Servlet会使用用户的名字、姓氏和金额预填充此表单。预填充表单后，该表单会被发送到客户端Web浏览器。 (请参阅使用可流动布局预填充Forms)

Java Servlet

示例贷款应用程序是作为Java Servlet存在的Forms服务应用程序的一个示例。 Java Servlet是在J2EE应用程序服务器（如WebSphere）上运行的Java程序，它包含Forms服务客户端API代码。

以下代码显示了名为GetLoanForm的Java Servlet的语法：

     public class GetLoanForm extends HttpServlet implements Servlet {
         public void doGet(HttpServletRequest req, HttpServletResponse resp
         throws ServletException, IOException {

         }
         public void doPost(HttpServletRequest req, HttpServletResponse resp
         throws ServletException, IOException {

             }

通常，您不会将Forms服务客户端API代码放在Java Servlet的doGet或doPost方法中。最好是将此代码放在单独的类中，从doPost方法（或doGet方法）中实例化该类，然后调用适当的方法。但是，为了代码简洁，本节中的代码示例尽量少，代码示例放在doPost方法中。

NOTE

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

步骤摘要

要呈现交互式PDF表单，请执行以下任务：

包括项目文件。
创建Forms客户端API对象。
指定URI值。
将文件附加到表单（可选）。
呈现交互式PDF表单。
将表单数据流写入客户端Web浏览器。

包含项目文件

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

创建Forms客户端API对象

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

指定URI值

您可以指定Forms服务呈现表单所需的URI值。可以使用内容根URI值repository:///引用保存为Forms应用程序一部分的表单设计。例如，考虑位于名为 FormsApplication 的Forms应用程序中的以下名为 Loan.xdp 的表单设计：

ri_ri_formrepository

要访问此表单设计，请将Applications/FormsApplication/1.0/FormsFolder/Loan.xdp指定为表单名称（传递给renderPDFForm方法的第一个参数），并将repository:///指定为内容根URI值。

NOTE

有关使用Workbench创建Forms应用程序的信息，请参阅Workbench帮助。

Forms应用程序中资源的路径为：

Applications/Application-name/Application-version/Folder.../Filename

以下值显示了一些URI值的示例：

Applications/AppraisalReport/1.0/Forms/FullForm.xdp
Applications/AnotherApp/1.1/Assets/picture.jpg
Applications/SomeApp/2.0/Resources/Data/XSDs/MyData.xsd

渲染交互式表单时，您可以定义URI值，例如将表单数据发布到的目标URL。可通过以下方式之一定义目标URL：

在Designer中设计表单设计时单击提交按钮
通过使用Forms服务客户端API

如果在表单设计内定义了目标URL，请勿使用Forms服务客户端API覆盖它。也就是说，使用Forms API设置目标URL会将表单设计中指定的URL重置为使用API指定的URL。如果要将PDF表单提交到表单设计中指定的目标URL，则以编程方式将目标URL设置为空字符串。

如果您的表单包含提交按钮和计算按钮（具有在服务器上运行的相应脚本），则可以通过编程方式定义将表单发送到哪个URL以执行脚本。使用表单设计上的提交按钮指定将表单数据发布到的URL。（请参阅计算表单数据。）

NOTE

您还可以将com.adobe.idp.Document实例传递到Forms服务，而不是指定URL值来引用XDP文件。 com.adobe.idp.Document实例包含表单设计。 (请参阅将文档传递到Forms服务。)

将文件附加到表单

您可以将文件附加到表单。渲染带有文件附件的PDF表单时，用户可以使用文件附件窗格在Acrobat中检索文件附件。您可以将不同的文件类型附加到表单（如文本文件）或二进制文件(如JPG文件)。

NOTE

将文件附件附加到表单是可选的。

渲染交互式PDF表单

要呈现表单，请使用在Designer中创建并另存为XDP或PDF文件的表单设计。此外，您还可以呈现使用Acrobat创建并另存为PDF文件的表单。要呈现交互式PDF表单，请调用FormsServiceClient对象的renderPDFForm方法或renderPDFForm2方法。

renderPDFForm使用URLSpec对象。使用URLSpec对象的setContentRootURI方法将指向XDP文件的内容根传递到Forms服务。窗体设计名称(formQuery)作为单独的参数值传递。将这两个值连接起来以获得对窗体设计的绝对引用。

renderPDFForm2方法接受包含要呈现的XDP或PDF文档的com.adobe.idp.Document实例。

NOTE

如果输入文档是PDFPDF，则无法设置标记文档运行时选项。如果输入文件是XDP文件，则可以设置标记的PDF选项。

使用Java API呈现交互式PDF表单 render-an-interactive-pdf-form-using-the-java-api

使用Forms API (Java)呈现交互式PDF表单：

包含项目文件

在Java项目的类路径中包含客户端JAR文件，例如adobe-forms-client.jar。
创建Forms客户端API对象
- 创建包含连接属性的ServiceClientFactory对象。
- 使用构造函数创建FormsServiceClient对象并传递ServiceClientFactory对象。
指定URI值
- 使用构造函数创建存储URI值的URLSpec对象。
- 调用URLSpec对象的setApplicationWebRoot方法，并传递表示应用程序的Web根的字符串值。
- 调用URLSpec对象的setContentRootURI方法，并传递一个指定内容根URI值的字符串值。确保表单设计位于内容根URI中。否则，Forms服务会引发异常。要引用存储库，请指定repository:///。
- 调用URLSpec对象的setTargetURL方法，并传递一个字符串值，该值指定将表单数据发布到的目标URL值。如果您在表单设计中定义目标URL，则可以传递空字符串。您还可以指定将表单发送到哪个URL来执行计算。

将文件附加到表单

创建一个java.util.HashMap对象以使用其构造函数存储文件附件。
对每个要附加到渲染表单的文件调用java.util.HashMap对象的put方法。将以下值传递到此方法：
- 一个字符串值，它指定文件附件的名称，包括文件扩展名。
包含文件附件的com.adobe.idp.Document对象。

note note
NOTE
对每个要附加到表单的文件重复此步骤。此步骤是可选的，如果您不想发送文件附件，则可以传递`null`。

呈现交互式PDF表单

调用FormsServiceClient对象的renderPDFForm方法并传递以下值：
- 一个字符串值，它指定窗体设计名称，包括文件扩展名。如果您引用的表单设计是Forms应用程序的一部分，请确保指定完整路径，如Applications/FormsApplication/1.0/FormsFolder/Loan.xdp。
- 包含要与表单合并的数据的com.adobe.idp.Document对象。如果不想合并数据，请传递一个空的com.adobe.idp.Document对象。
- 存储运行时选项的PDFFormRenderSpec对象。这是一个可选参数，如果您不想指定运行时选项，则可以指定null。
- 包含Forms服务所需URI值的URLSpec对象。
- 存储文件附件的java.util.HashMap对象。这是一个可选参数，如果您不想将文件附加到表单，则可以指定null。
renderPDFForm方法返回的FormsResult对象包含必须写入客户端Web浏览器的表单数据流。
将表单数据流写入客户端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对象的read方法并将字节数组作为参数传递，创建字节数组并使用表单数据流填充该数组。
- 调用javax.servlet.ServletOutputStream对象的write方法将表单数据流发送到客户端Web浏览器。将字节数组传递给write方法。

使用Web服务API呈现交互式PDF表单 render-an-interactive-pdf-form-using-the-web-service-api

使用Forms API（Web服务）呈现交互式PDF表单：

包含项目文件
- 创建使用Forms服务WSDL的Java代理类。
- 将Java代理类包含在类路径中。
创建Forms客户端API对象

创建FormsService对象并设置身份验证值。
指定URI值
- 使用构造函数创建存储URI值的URLSpec对象。
- 调用URLSpec对象的setApplicationWebRoot方法，并传递表示应用程序的Web根的字符串值。
- 调用URLSpec对象的setContentRootURI方法，并传递一个指定内容根URI值的字符串值。确保表单设计位于内容根URI中。否则，Forms服务会引发异常。要引用存储库，请指定repository:///。
- 调用URLSpec对象的setTargetURL方法，并传递一个字符串值，该值指定将表单数据发布到的目标URL值。如果您在表单设计中定义目标URL，则可以传递空字符串。您还可以指定将表单发送到哪个URL来执行计算。

将文件附加到表单

创建一个java.util.HashMap对象以使用其构造函数存储文件附件。
对每个要附加到渲染表单的文件调用java.util.HashMap对象的put方法。将以下值传递到此方法：
- 一个字符串值，它指定文件附件的名称，包括文件扩展名
包含文件附件的BLOB对象

note note
NOTE
对每个要附加到表单的文件重复此步骤。

呈现交互式PDF表单

调用FormsService对象的renderPDFForm方法并传递以下值：
- 一个字符串值，它指定窗体设计名称，包括文件扩展名。如果您引用的表单设计是Forms应用程序的一部分，请确保指定完整路径，如Applications/FormsApplication/1.0/FormsFolder/Loan.xdp。
- 包含要与表单合并的数据的BLOB对象。如果不想合并数据，请传递null。
- 存储运行时选项的PDFFormRenderSpec对象。这是一个可选参数，如果您不想指定运行时选项，则可以指定null。
- 包含Forms服务所需URI值的URLSpec对象。
- 存储文件附件的java.util.HashMap对象。这是一个可选参数，如果您不想将文件附加到表单，则可以指定null。
- 方法填充的空com.adobe.idp.services.holders.BLOBHolder对象。用于存储渲染的PDF表单。
- 方法填充的空javax.xml.rpc.holders.LongHolder对象。（此参数将存储表单中的页数。）
- 方法填充的空javax.xml.rpc.holders.StringHolder对象。（此参数将存储区域设置值。）
- 将包含此操作结果的空com.adobe.idp.services.holders.FormsResultHolder对象。
renderPDFForm方法使用必须写入客户端Web浏览器的表单数据流填充作为最后一个参数值传递的com.adobe.idp.services.holders.FormsResultHolder对象。
将表单数据流写入客户端Web浏览器
- 通过获取com.adobe.idp.services.holders.FormsResultHolder对象的value数据成员的值创建FormResult对象。
- 通过调用FormsResult对象的getOutputContent方法，创建包含表单数据的BLOB对象。
- 通过调用其getContentType方法获取BLOB对象的内容类型。
- 通过调用其setContentType方法并传递BLOB对象的内容类型来设置javax.servlet.http.HttpServletResponse对象的内容类型。
- 通过调用javax.servlet.http.HttpServletResponse对象的getOutputStream方法，创建用于将表单数据流写入客户端Web浏览器的javax.servlet.ServletOutputStream对象。
- 创建字节数组，并通过调用BLOB对象的getBinaryData方法填充该数组。此任务将FormsResult对象的内容分配给字节数组。
- 调用javax.servlet.http.HttpServletResponse对象的write方法将表单数据流发送到客户端Web浏览器。将字节数组传递给write方法。

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

Forms服务渲染表单时，会返回一个您必须写入客户端Web浏览器的表单数据流。在写入客户端Web浏览器时，该表单对用户可见。

recommendation-more-help

19ffd973-7af2-44d0-84b5-d547b0dffee2