创建文档输出流

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

关于输出服务

“输出”服务允许您将文档输出为PDF(包括PDF/A文档)、PostScript、打印机控制语言(PCL)和以下标签格式:

  • 泽布拉 — 兹普尔
  • Intermec - IPL
  • Datamax - DPL
  • TecToshiba - TPCL

使用“输出”服务,您可以将XML表单数据与表单设计合并,并将文档输出到网络打印机或文件。

有两种方法可将表单设计(XDP文件)传递到输出服务。 您可以将包含表单设计的com.adobe.idp.Document实例传递给Output服务。 或者,您可以传递指定表单设计位置的URI值。 在​使用AEM表单编程​中讨论了这两种方式。

注意

输出服务不支持包含应用程序对象特定脚本的Acroform PDF文档。 不渲染包含应用程序对象特定脚本的Acrobat PDF文档。

以下部分说明如何使用URI值将表单设计传递给输出服务:

以下部分说明如何在com.adobe.idp.Document实例中传递表单设计:

在决定使用哪种技术时,一个考虑事项是,如果您是从另一个AEM Forms服务获取表单设计,然后在com.adobe.idp.Document实例中传递它。 将文档传递到输出服务​和​使用片段​创建PDF文档部分都显示了如何从其他AEM Forms服务获取表单设计。 第一部分从Content Services检索表单设计(已弃用)。 第二部分从Assembler服务检索表单设计。

如果从固定位置(如文件系统)获取表单设计,则可以使用任一技巧。 也就是说,您可以为XDP文件指定URI值或使用com.adobe.idp.Document实例。

要在创建PDF文档时传递指定表单设计位置的URI值,请使用generatePDFOutput方法。 同样,要在创建PDF文档时将com.adobe.idp.Document实例传递给Output服务,请使用generatePDFOutput2方法。

向网络打印机发送输出流时,您也可以使用这两种技术。 要通过传递包含表单设计的com.adobe.idp.Document实例将输出流发送到打印机,请使用sendToPrinter2方法。 要通过传递URI值将输出流发送到打印机,请使用sendToPrinter方法。 将打印流发送到打印机​部分使用sendToPrinter方法。

您可以使用输出服务完成以下任务:

注意

有关输出服务的详细信息,请参阅AEM Forms的服务参考

创建PDF文档

您可以使用“输出”服务创建基于您提供的表单设计和XML表单文档的PDF。 由输出服务创建的PDF文档不是交互式PDF文档;用户无法输入或修改表单数据。

如果要创建用于长期存储的PDF文档,建议您创建PDF/A文档。 (请参阅创建PDF/A文档。)

要创建允许用户输入数据的交互式PDF表单,请使用Forms服务。 (请参阅渲染交互式PDF forms。)

注意

有关输出服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要创建PDF文档,请执行以下步骤:

  1. 包括项目文件。
  2. 创建Output Client对象。
  3. 引用XML数据源。
  4. 设置PDF运行时选项。
  5. 设置渲染运行时选项。
  6. 生成PDF文档。
  7. 检索操作结果。

包括项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-output-client.jar
  • adobe-utilities.jar(在JBoss上部署AEM Forms时为必需)
  • jbossall-client.jar(在JBoss上部署AEM Forms时为必需)

如果AEM Forms部署在非JBoss的受支持J2EE应用程序服务器上,则需要将adobe-utilities.jar和jbossall-client.jar文件替换为特定于部署AEM Forms的J2EE应用程序服务器的JAR文件。

创建Output Client对象

在以编程方式执行输出服务操作之前,必须创建输出服务客户端对象。 如果您使用Java API,请创建OutputClient对象。 如果您使用Output Web服务API,请创建OutputServiceService对象。

引用XML数据源

要将数据与表单设计合并,必须引用包含数据的XML数据源。 您计划用数据填充的每个表单字段都必须存在XML元素。 XML元素名称必须与字段名称匹配。 如果XML元素与表单域不对应,或XML元素名称与域名称不匹配,则忽略该元素。 如果指定了所有XML元素,则不必与XML元素的显示顺序匹配。

请考虑以下贷款申请表示例。

cp_cp_lonformdata

要将数据合并到此表单设计中,必须创建与表单对应的XML数据源。 以下XML表示一个XDP XML数据源,它对应于按揭贷款应用程序表单示例。

 <?xml version="1.0" encoding="UTF-8" ?>
 - <xfa:datasets xmlns:xfa="https://www.xfa.org/schema/xfa-data/1.0/">
 - <xfa:data>
 - <data>
     - <Layer>
         <closeDate>1/26/2007</closeDate>
         <lastName>Johnson</lastName>
         <firstName>Jerry</firstName>
         <mailingAddress>JJohnson@NoMailServer.com</mailingAddress>
         <city>New York</city>
         <zipCode>00501</zipCode>
         <state>NY</state>
         <dateBirth>26/08/1973</dateBirth>
         <middleInitials>D</middleInitials>
         <socialSecurityNumber>(555) 555-5555</socialSecurityNumber>
         <phoneNumber>5555550000</phoneNumber>
     </Layer>
     - <Mortgage>
         <mortgageAmount>295000.00</mortgageAmount>
         <monthlyMortgagePayment>1724.54</monthlyMortgagePayment>
         <purchasePrice>300000</purchasePrice>
         <downPayment>5000</downPayment>
         <term>25</term>
         <interestRate>5.00</interestRate>
     </Mortgage>
 </data>
 </xfa:data>
 </xfa:datasets>

设置PDF运行时选项

在创建PDF文档时设置文件URI选项。 此选项指定输出服务生成的PDF文件的名称和位置。

注意

您可以从Output服务返回的复杂文档类型中以编程方式检索PDF,而不是设置文件URI运行时选项。 但是,通过设置文件URI运行时选项,您无需创建以编程方式检索PDF文档的应用程序逻辑。

设置渲染运行时选项

您可以在创建PDF文档时设置渲染运行时选项。 尽管这些选项不是必需的(与所需的PDF运行时选项不同),但您可以执行任务,如提高输出服务的性能。 例如,您可以缓存输出服务使用的表单设计以提高其性能。

如果使用带标签的Acrobat表单作为输入,则无法使用输出服务Java或Web服务API关闭带标签的设置。 如果尝试以编程方式将此选项设置为false,则结果PDF文档仍被标记。

注意

如果未指定渲染运行时选项,则使用默认值。 有关渲染运行时选项的信息,请参阅RenderOptionsSpec类引用。 (请参阅AEM Forms API参考)。

生成PDF文档

在引用包含表单数据的有效XML数据源并设置运行时选项后,可以调用输出服务,这会导致它生成PDF文档。

在生成PDF文档时,指定输出服务创建PDF文档所需的URI值。 表单设计可以存储在诸如服务器文件系统之类的位置或作为AEM Forms应用程序的一部分。 使用内容根URI值repository:///可以引用作为Forms应用程序一部分存在的表单设计(或其他资源,如图像文件)。 例如,请考虑以下名为​Loan.xdp​的表单设计,它位于名为​Applications/FormsApplication​的Forms应用程序中:

cp_cp_formrepository

要访问上图中显示的Loan.xdp文件,请指定repository:///Applications/FormsApplication/1.0/FormsFolder/作为传递给OutputClient对象的generatePDFOutput方法的第三个参数。 指定表单名称(Loan.xdp)作为传递给OutputClient对象的generatePDFOutput方法的第二个参数。

如果XDP文件包含图像(或其他资源,如片段),则将资源放在与XDP文件相同的应用程序文件夹中。 AEM Forms使用内容根URI作为解析对图像的引用的基本路径。 例如,如果Loan.xdp文件包含一个图像,请确保将该图像放在Applications/FormsApplication/1.0/FormsFolder/中。

注意

在调用OutputClient对象的generatePDFOutputgeneratePrintedOutput方法时,可以引用Forms应用程序URI。

注意

要查看通过引用Forms应用程序中的XDP创建PDF文档的完整快速开始,请参阅快速开始(EJB模式):使用Java API创建基于应用程序XDP文件的PDF文档。

检索操作结果

输出服务执行操作后,它会返回各种数据项,如指定操作是否成功的状态XML数据。

另请参阅

使用Java API创建PDF文档

使用Web服务API创建PDF文档

包括AEM Forms Java库文件

设置连接属性

输出服务API快速开始

使用Java API创建PDF文档

使用输出API(Java)创建PDF文档:

  1. 包括项目文件。

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

  2. 创建Output Client对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用OutputClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
  3. 引用XML数据源。

    • 创建一个java.io.FileInputStream对象,它表示使用PDF文档的构造函数并传递一个指定XML文件位置的字符串值来填充PDF数据源的XML数据源。
    • 使用com.adobe.idp.Document对象的构造函数创建对象。 传递java.io.FileInputStream对象。
  4. 设置PDF运行时选项。

    • 使用PDFOutputOptionsSpec对象的构造函数创建对象。
    • 通过调用PDFOutputOptionsSpec对象的setFileURI方法设置文件URI选项。 传递一个字符串值,它指定输出服务生成的PDF文件的位置。 “文件URI”选项是相对于承载AEM Forms的J2EE应用程序服务器,而不是客户端计算机。
  5. 设置渲染运行时选项。

    • 使用RenderOptionsSpec对象的构造函数创建对象。
    • 通过调用RenderOptionsSpec对象的setCacheEnabled并传递true来缓存表单设计以改进输出服务的性能。
    注意

    如果输入文档是Acrobat表单(在Acrobat中创建的表单)或已签名或经过认证的XFA文档,则不能使用RenderOptionsSpec对象的setPdfVersion方法设置PDF文档的版本。 输出PDF文档保留原始PDF版本。 同样,如果输入文档是Acrobat表单或已签名或已验证的XFA文档,则不能通过调用RenderOptionsSpec对象的setTaggedPDF方法来设置已标记的Adobe PDF选项。

    注意

    如果输入的PDF文档经过认证或数字签名,则不能使用RenderOptionsSpec对象的setLinearizedPDF方法来设置线性化的PDF选项。 (请参阅对PDF文档进行数字签名​。)

  6. 生成PDF文档。

    通过调用OutputClient对象的generatePDFOutput方法并传递以下值,创建PDF文档:

    • TransformationFormat明细列表值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定表单设计的名称。
    • 一个字符串值,它指定表单设计所在的内容根。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • com.adobe.idp.Document对象,它包含要与表单设计合并的数据的XML数据源。

    generatePDFOutput方法返回包含操作结果的OutputResult对象。

    注意

    当通过调用generatePDFOutput方法生成PDF文档时,请注意,您无法将数据与已签名或已验证的XFA PDF表单合并。 (请参阅数字签名和认证文档​。)

    注意

    OutputResult对象的getRecordLevelMetaDataList方法返回​null

    注意

    还可以通过调用OutputClient对象的generatePDFOutput2方法创建PDF文档。 (请参阅将位于Content Services中的文档(已弃用)传递到Output Service 。)

  7. 检索操作结果。

    • 通过调用OutputResult对象的getStatusDoc方法,检索表示generatePDFOutput操作状态的com.adobe.idp.Document对象。 此方法返回指定操作是否成功的状态XML数据。
    • 创建一个java.io.File对象,其中包含操作的结果。 确保文件扩展名为.xml。
    • 调用com.adobe.idp.Document对象的copyToFile方法,将com.adobe.idp.Document对象的内容复制到文件(请确保使用由getStatusDoc方法返回的com.adobe.idp.Document对象)。

    尽管Output服务将PDF文档写入由传递给PDFOutputOptionsSpec对象setFileURI方法的参数指定的位置,但您可以通过调用OutputResult对象的getGeneratedDoc方法以编程方式检索PDF/A文档。

另请参阅

步骤摘要

快速开始(EJB模式):使用Java API创建PDF文档

快速开始(SOAP模式):使用Java API创建PDF文档

包括AEM Forms Java库文件

设置连接属性

使用Web服务API创建PDF文档

使用输出API(Web服务)创建PDF文档:

  1. 包括项目文件。

    创建使用MTOM的Microsoft .NET项目。 确保使用以下WSDL定义:http://localhost:8080/soap/services/OutputService?WSDL&lc_version=9.0.1

    注意

    localhost替换为承载AEM Forms的服务器的IP地址。

  2. 创建Output Client对象。

    • 使用OutputServiceClient对象的默认构造函数创建一个对象。

    • 使用System.ServiceModel.EndpointAddress构造函数创建OutputServiceClient.Endpoint.Address对象。 将指定WSDL的字符串值传递给AEM Forms服务(例如http://localhost:8080/soap/services/OutputService?blob=mtom)。 您无需使用lc_version属性。 在创建服务引用时使用此属性。 但是,请指定?blob=mtom以使用MTOM。

    • 通过获取OutputServiceClient.Endpoint.Binding字段的值,创建System.ServiceModel.BasicHttpBinding对象。 将返回值转换为BasicHttpBinding

    • System.ServiceModel.BasicHttpBinding对象的MessageEncoding字段设置为WSMessageEncoding.Mtom。 此值确保使用MTOM。

    • 通过执行以下任务,启用基本HTTP身份验证:

      • 为字段OutputServiceClient.ClientCredentials.UserName.UserName指定AEM表单用户名。
      • 为字段OutputServiceClient.ClientCredentials.UserName.Password分配相应的密码值。
      • 将常量值HttpClientCredentialType.Basic赋给字段BasicHttpBindingSecurity.Transport.ClientCredentialType
      • 将常量值BasicHttpSecurityMode.TransportCredentialOnly赋给字段BasicHttpBindingSecurity.Security.Mode
  3. 引用XML数据源。

    • 使用BLOB对象的构造函数创建对象。 BLOB对象用于存储将与PDF文档合并的XML数据。
    • 通过调用System.IO.FileStream对象的构造函数并传递一个字符串值来创建对象,该字符串值表示包含表单数据的XML文件的文件位置。
    • 创建一个字节数组,用于存储System.IO.FileStream对象的内容。 可以通过获取System.IO.FileStream对象的Length属性来确定字节数组的大小。
    • 通过调用System.IO.FileStream对象的Read方法并传递要读取的字节数组、开始位置和流长度,用流数据填充字节数组。
    • BLOB对象的MTOM字段指定为字节数组的内容,从而填充该对象。
  4. 设置PDF运行时选项

    • 使用PDFOutputOptionsSpec对象的构造函数创建对象。
    • 通过指定一个字符串值来设置“文件URI”选项,该字符串值指定Output服务生成的PDF文件到PDFOutputOptionsSpec对象的fileURI数据成员的位置。 “文件URI”选项是相对于承载AEM Forms的J2EE应用程序服务器,而不是客户端计算机。
  5. 设置渲染运行时选项。

    • 使用RenderOptionsSpec对象的构造函数创建对象。
    • 缓存表单设计,通过将值true指定给RenderOptionsSpec对象的cacheEnabled数据成员来改进输出服务的性能。
    注意

    如果输入文档是Acrobat表单(在Acrobat中创建的表单)或已签名或经过认证的XFA文档,则不能使用RenderOptionsSpec对象的setPdfVersion方法设置PDF文档的版本。 输出PDF文档保留原始PDF版本。 同样,如果输入文档是Acrobat表单或已签名或已验证的XFA文档,则不能通过调用RenderOptionsSpec对象的setTaggedPDF方法来设置已标记的Adobe PDF选项。

    注意

    如果输入的PDF文档经过认证或数字签名,则不能通过使用RenderOptionsSpec对象的linearizedPDF成员来设置线性化的PDF选项。 (请参阅对PDF文档进行数字签名​。)

  6. 生成PDF文档。

    通过调用OutputServiceService对象的generatePDFOutput方法并传递以下值,创建PDF文档:

    • TransformationFormat明细列表值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定表单设计的名称。
    • 一个字符串值,它指定表单设计所在的内容根。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • BLOB对象,它包含要与表单设计合并的数据的XML数据源。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用生成的描述该文档的元数据填充此对象。 (此参数值仅对Web服务调用是必需的)。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用结果数据填充此对象。 (此参数值仅对Web服务调用是必需的)。
    • 包含操作结果的OutputResult对象。 (此参数值仅对Web服务调用是必需的)。
    注意

    当通过调用generatePDFOutput方法生成PDF文档时,请注意,您无法将数据与已签名或已验证的XFA PDF表单合并。 (请参阅数字签名和认证文档​。)

    注意

    还可以通过调用OutputClient对象的generatePDFOutput2方法创建PDF文档。 (请参阅将位于Content Services中的文档(已弃用)传递到Output Service 。)

  7. 检索操作结果。

    • 通过调用System.IO.FileStream对象的构造函数并传递一个字符串值来创建对象,该字符串值表示包含结果数据的XML文件位置。 确保文件扩展名为.xml。
    • 创建一个字节数组,用于存储OutputServiceService对象的generatePDFOutput方法(第八个参数)用结果数据填充的BLOB对象的数据内容。 通过获取BLOB对象的MTOM field的值来填充字节数组。
    • 通过调用其构造函数并传递System.IO.FileStream对象,创建System.IO.BinaryWriter对象。
    • 通过调用System.IO.BinaryWriter对象的Write方法并传递字节数组,将字节数组的内容写入XML文件。

    另请参阅

    步骤摘要

    使用MTOM调用AEM Forms

    使用SwaRef调用AEM Forms

    注意

    OutputServiceService对象的generateOutput方法已弃用。

创建PDF/A文档

您可以使用输出服务创建PDF/A文档。 由于PDF/A是用于长期保留文档内容的存档格式,因此所有字体都是嵌入的,文件是未压缩的。 因此,PDF/A文档通常大于标准PDF文档。 此外,PDF/A文档不包含音频和视频内容。 与其他输出服务任务一样,您提供要与表单设计合并的表单设计和数据,以创建PDF/A文档。

PDF/A-1规范包含两个符合性级别,即a和b。两者的主要区别在于逻辑结构(辅助功能)支持,而符合性级别b不要求逻辑结构(辅助功能)支持。无论符合性级别如何,PDF/A-1都规定所有字体都嵌入到生成的PDF/A文档中。

尽管PDF/A是归档PDF文档的标准,但如果标准PDF文档符合您的公司的需求,则不必将PDF/A用于归档。 PDF/A标准旨在建立可长期存储的PDF文件,并满足文档保留要求。 例如,URL无法嵌入到PDF/A中,因为随着时间的推移,该URL可能会变为无效。

您的组织必须评估自己的需求、您打算保留文档的时间长度、文件大小考虑因素,并确定您自己的归档战略。 您可以使用DocConverter服务以编程方式确定PDF文档是否符合PDF/A规范。 (请参阅以编程方式确定PDF/A兼容性。)

PDF/A文档必须使用在表单设计中指定的字体,并且无法替换字体。 因此,如果位于PDF文档中的字体在主机操作系统(OS)上不可用,则会出现异常。

在Acrobat中打开PDF/A文档时,将显示一条消息,确认文档是PDF/A文档,如下图所示。

cp_cp_pdfamessage

注意

AIIM网站有一个PDF/A常见问题解答部分,您可以从https://www.aiim.org/documents/standards/19005-1_FAQ.pdf访问该部分。

注意

有关输出服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要创建PDF/A文档,请执行以下步骤:

  1. 包括项目文件。
  2. 创建Output Client对象。
  3. 引用XML数据源。
  4. 设置PDF/A运行时选项。
  5. 设置渲染运行时选项。
  6. 生成PDF/A文档。
  7. 检索操作结果。

包括项目文件

在开发项目中包含必要的文件。 如果要使用Java创建自定义应用程序,请包含必要的JAR文件。 如果您使用Web服务,请确保包含代理文件。

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-output-client.jar
  • adobe-utilities.jar(在JBoss上部署AEM Forms时为必需)
  • jbossall-client.jar(在JBoss上部署AEM Forms时为必需)

如果AEM Forms部署在非JBoss的受支持J2EE应用程序服务器上,则需要将adobe-utilities.jar和jbossall-client.jar文件替换为特定于部署AEM Forms的J2EE应用程序服务器的JAR文件。

创建Output Client对象

在以编程方式执行输出服务操作之前,必须创建输出服务客户端对象。 如果您使用Java API,请创建OutputClient对象。 如果您使用Output Web服务API,请创建OutputServiceService对象。

引用XML数据源

要将数据与表单设计合并,必须引用包含数据的XML数据源。 要用数据填充的每个表单域都必须存在XML元素。 XML元素名称必须与字段名称匹配。 如果XML元素与表单域不对应,或XML元素名称与域名称不匹配,则忽略该元素。 如果指定了所有XML元素,则不必与XML元素的显示顺序匹配。

设置PDF/A运行时选项

您可以在创建PDF/A文档时设置“文件URI”选项。 URI相对于承载AEM Forms的J2EE应用程序服务器。 即,如果设置C:\Adobe,则文件将写入服务器上的文件夹,而不是客户端计算机。 URI指定输出服务生成的PDF/A文件的名称和位置。

设置渲染运行时选项

您可以在创建PDF/A文档时设置渲染运行时选项。 您可以设置的两个PDF/A相关选项是PDFAConformancePDFARevisionNumber值。 PDFAConformance值指PDF文档如何遵守指定如何保留长期电子文档的要求。 此选项的有效值为AB。 有关a级和b级符合性的信息,请参阅标题为​ISO 19005-1文档管理​的PDF/A-1 ISO规范。

PDFARevisionNumber值指PDF/A文档的修订版号。 有关PDF/A文档的修订版号的信息,请参阅标题为​ISO 19005-1文档管理​的PDF/A-1 ISO规范。

注意

创建PDF/A 1A文档时,无法将加标签的Adobe PDF选项设置为false。 PDF/A 1A将始终是加标签的PDF文档。 此外,创建PDF/A 1B文档时,不能将加标签的Adobe PDF选项设置为true。 PDF/A 1B将始终是未加标签的PDF文档。

生成PDF/A文档

引用包含表单数据的有效XML数据源并设置运行时选项后,可以调用输出服务,使其生成PDF/A文档。

检索操作结果

在输出服务执行操作后,它返回各种数据项,如指定操作是否成功的XML数据。

另请参阅

使用Java API创建PDF/A文档

使用Web服务API创建PDF/A文档

包括AEM Forms Java库文件

设置连接属性

输出服务API快速开始

使用Java API创建PDF/A文档

使用输出API(Java)创建PDF/A文档:

  1. 包括项目文件。

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

  2. 创建Output Client对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用OutputClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
  3. 引用XML数据源。

    • 创建一个java.io.FileInputStream对象,它表示使用PDF/A文档的构造函数并传递一个指定XML文件位置的字符串值来填充PDF/A数据源。
    • 使用com.adobe.idp.Document对象的构造函数并传递java.io.FileInputStream对象,创建对象。
  4. 设置PDF/A运行时选项。

    • 使用PDFOutputOptionsSpec对象的构造函数创建对象。
    • 通过调用PDFOutputOptionsSpec对象的setFileURI方法设置文件URI选项。 传递一个字符串值,它指定输出服务生成的PDF文件的位置。 “文件URI”选项是相对于承载AEM Forms的J2EE应用程序服务器,而不是客户端计算机。
  5. 设置渲染运行时选项。

    • 使用RenderOptionsSpec对象的构造函数创建对象。
    • 通过调用RenderOptionsSpec对象的setPDFAConformance方法并传递指定符合性级别的PDFAConformance枚举值来设置PDFAConformance值。 例如,要指定符合性级别A,请传递PDFAConformance.A
    • 通过调用RenderOptionsSpec对象的setPDFARevisionNumber方法并传递PDFARevisionNumber.Revision_1来设置PDFARevisionNumber值。
    注意

    无论您为RenderOptionsSpec对象的​setPdfVersion方法指定了哪个值,PDF/A文档的PDF版本都是1.4。

  6. 生成PDF/A文档。

    通过调用OutputClient对象的generatePDFOutput方法并传递以下值,创建PDF/A文档:

    • TransformationFormat明细列表值。 要生成PDF/A文档,请指定TransformationFormat.PDFA
    • 一个字符串值,它指定表单设计的名称。
    • 一个字符串值,它指定表单设计所在的内容根。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • com.adobe.idp.Document对象,它包含要与表单设计合并的数据的XML数据源。

    generatePDFOutput方法返回包含操作结果的OutputResult对象。

    注意

    OutputResult对象的getRecordLevelMetaDataList方法返回null

    注意

    您还可以通过调用OutputClient对象的generatePDFOutput2方法来创建PDF /A文档。 (请参阅将位于Content Services中的文档(已弃用)传递到Output Service。)

  7. 检索操作结果。

    • 通过调用OutputResult对象的getStatusDoc方法,创建一个表示generatePDFOutput方法状态的com.adobe.idp.Document对象。
    • 创建一个java.io.File对象,其中包含操作结果。 确保文件扩展名为.xml。
    • 调用com.adobe.idp.Document对象的copyToFile方法,将com.adobe.idp.Document对象的内容复制到文件(请确保使用由getStatusDoc方法返回的com.adobe.idp.Document对象)。
    注意

    尽管Output服务将PDF/A文档写入由传递到PDFOutputOptionsSpec对象setFileURI方法的参数指定的位置,但您可以通过调用OutputResult对象的getGeneratedDoc方法以编程方式检索PDF/A文档。

另请参阅

步骤摘要

快速开始(SOAP模式):使用Java API创建PDF/A文档

包括AEM Forms Java库文件

设置连接属性

使用Web服务API创建PDF/A文档

使用输出API(Web服务)创建PDF/A文档:

  1. 包括项目文件。

    创建使用MTOM的Microsoft .NET项目。 确保使用以下WSDL定义:http://localhost:8080/soap/services/OutputService?WSDL&lc_version=9.0.1

    注意

    localhost替换为承载AEM Forms的服务器的IP地址。

  2. 创建Output Client对象。

    • 使用OutputServiceClient对象的默认构造函数创建一个对象。

    • 使用System.ServiceModel.EndpointAddress构造函数创建OutputServiceClient.Endpoint.Address对象。 将指定WSDL的字符串值传递给AEM Forms服务(例如http://localhost:8080/soap/services/OutputService?blob=mtom)。 您无需使用lc_version属性。 在创建服务引用时使用此属性。 但是,请指定?blob=mtom以使用MTOM。

    • 通过获取OutputServiceClient.Endpoint.Binding字段的值,创建System.ServiceModel.BasicHttpBinding对象。 将返回值转换为BasicHttpBinding

    • System.ServiceModel.BasicHttpBinding对象的MessageEncoding字段设置为WSMessageEncoding.Mtom。 此值确保使用MTOM。

    • 通过执行以下任务,启用基本HTTP身份验证:

      • 为字段OutputServiceClient.ClientCredentials.UserName.UserName指定AEM表单用户名。
      • 为字段OutputServiceClient.ClientCredentials.UserName.Password分配相应的密码值。
      • 将常量值HttpClientCredentialType.Basic赋给字段BasicHttpBindingSecurity.Transport.ClientCredentialType
      • 将常量值BasicHttpSecurityMode.TransportCredentialOnly赋给字段BasicHttpBindingSecurity.Security.Mode
  3. 引用XML数据源。

    • 使用BLOB对象的构造函数创建对象。 BLOB对象用于存储将与PDF/A文档合并的数据。
    • 通过调用System.IO.FileStream对象的构造函数并传递一个字符串值来创建对象,该字符串值表示要加密的PDF文档的文件位置以及打开文件的模式。
    • 创建一个字节数组,用于存储System.IO.FileStream对象的内容。 可以通过获取System.IO.FileStream对象的Length属性来确定字节数组的大小。
    • 通过调用System.IO.FileStream对象的Read方法并传递要读取的字节数组、开始位置和流长度,用流数据填充字节数组。
    • 通过将MTOM字段指定为字节数组内容,填充BLOB对象。
  4. 设置PDF/A运行时选项。

    • 使用PDFOutputOptionsSpec对象的构造函数创建对象。
    • 通过指定一个字符串值来设置“文件URI”选项,该字符串值指定Output服务生成的PDF文件到PDFOutputOptionsSpec对象的fileURI数据成员的位置。 “文件URI”选项是相对于承载AEM Forms的J2EE应用程序服务器,而不是客户端计算机
  5. 设置渲染运行时选项。

    • 使用RenderOptionsSpec对象的构造函数创建对象。
    • 通过为RenderOptionsSpec对象的PDFAConformance数据成员分配PDFAConformance枚举值来设置PDFAConformance值。 例如,要指定符合性级别A,请为此数据成员分配PDFAConformance.A
    • 通过为RenderOptionsSpec对象的PDFARevisionNumber数据成员分配PDFARevisionNumber枚举值来设置PDFARevisionNumber值。 将PDFARevisionNumber.Revision_1分配给此数据成员。
    注意

    PDF/A文档的PDF版本是1.4,无论您指定哪个值。

  6. 生成PDF/A文档。

    通过调用OutputServiceService对象的generatePDFOutput方法并传递以下值,创建PDF文档:

    • TransformationFormat明细列表值。 要生成PDF文档,请指定TransformationFormat.PDFA
    • 一个字符串值,它指定表单设计的名称。
    • 一个字符串值,它指定表单设计所在的内容根。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • BLOB对象,它包含要与表单设计合并的数据的XML数据源。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用生成的描述该文档的元数据填充此对象。 (仅Web服务调用需要此参数值。)
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用结果数据填充此对象。 (仅Web服务调用需要此参数值。)
    • 包含操作结果的OutputResult对象。 (仅Web服务调用需要此参数值。)
    注意

    您还可以通过调用OutputClient对象的generatePDFOutput2方法来创建PDF /A文档。 (请参阅将位于Content Services中的文档(已弃用)传递到Output Service。)

  7. 检索操作结果。

    • 通过调用System.IO.FileStream对象的构造函数并传递一个字符串值来创建对象,该字符串值表示包含结果数据的XML文件位置。 确保文件扩展名为.xml。
    • 创建一个字节数组,用于存储OutputServiceService对象的generatePDFOutput方法(第八个参数)用结果数据填充的BLOB对象的数据内容。 通过获取BLOB对象的MTOM字段的值来填充字节数组。
    • 通过调用其构造函数并传递System.IO.FileStream对象,创建System.IO.BinaryWriter对象。
    • 通过调用System.IO.BinaryWriter对象的Write方法并传递字节数组,将字节数组的内容写入XML文件。

另请参阅

步骤摘要

使用MTOM调用AEM Forms

使用SwaRef调用AEM Forms

将位于Content Services中的文档(已弃用)传递到输出服务

输出服务渲染非交互式PDF表单,该表单基于表单设计,通常另存为XDP文件并在设计器中创建。 可以将包含表单设计的com.adobe.idp.Document对象传递给Output服务。 然后,输出服务将呈现位于com.adobe.idp.Document对象中的表单设计。

com.adobe.idp.Document对象传递到Output服务的一个优点是,其他AEM Forms服务操作会返回com.adobe.idp.Document实例。 也就是说,您可以从另一个服务操作获取com.adobe.idp.Document实例并渲染它。 例如,假定XDP文件存储在名为/Company Home/Form Designs的Content Services(已弃用)节点中,如下图所示。

您可以通过编程方式从Content Services(已弃用)检索Loan.xdp,并将XDP文件传递到com.adobe.idp.Document对象中的Output服务。

注意

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

步骤的摘要

要将从Content Services获得的文档(已弃用)传递到Output服务,请执行以下任务:

  1. 包括项目文件。
  2. 创建一个输出和一个文档管理客户端API对象。
  3. 从Content Services检索表单设计(已弃用)。
  4. 渲染非交互式PDF表单。
  5. 对数据流执行操作。

包括项目文件

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

创建输出和文档管理客户端API对象

在以编程方式执行输出服务API操作之前,请先创建一个输出客户端API对象。 此外,由于此工作流从Content Services检索XDP文件(已弃用),请创建一个文档管理API对象。

从Content Services检索表单设计(已弃用)

使用Java或Web服务API从Content Services检索XDP文件(已弃用)。 XDP文件在com.adobe.idp.Document实例(或BLOB实例(如果您使用Web服务)中返回。 然后,您可以将com.adobe.idp.Document实例传递给Output服务。

渲染非交互式PDF表单

要呈现非交互式表单,请将从Content Services(已弃用)返回的com.adobe.idp.Document实例传递到输出服务。

注意

名为generatePDFOutput2和g eneratePrintedOutput2的两种新方法接受包含表单设计的com.adobe.idp.Document对象。 在向网络打印机发送打印流时,还可以将包含表单设计的com.adobe.idp.Document传递给Output服务。

对表单数据流执行操作

可以将非交互式表单另存为PDF文件。 可在Adobe Reader或Acrobat中查看表单。

另请参阅

使用Java API将文档传递到输出服务

使用Web服务API将文档传递到输出服务

包括AEM Forms Java库文件

设置连接属性

输出服务API快速开始

使用片段创建PDF文档

使用Java API将文档传递到输出服务

通过使用输出服务和内容服务(已弃用)API(Java)传递从Content Services检索到的文档(已弃用):

  1. 包括项目文件。

    在Java项目的类路径中包含客户端JAR文件,如adobe-output-client.jar和adobe-contentservices-client.jar。

  2. 创建一个输出和一个文档管理客户端API对象。

    • 创建包含连接属性的ServiceClientFactory对象。 (请参阅设置连接属性。)
    • 使用OutputClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
    • 使用DocumentManagementServiceClientImpl对象的构造函数并传递ServiceClientFactory对象,创建对象。
  3. 从Content Services检索表单设计(已弃用)。

    调用DocumentManagementServiceClientImpl对象的retrieveContent方法并传递以下值:

    • 一个字符串值,它指定添加内容的存储。 默认存储为SpacesStore。 此值是必需参数。
    • 一个字符串值,它指定要检索的内容的完全限定路径(例如,/Company Home/Form Designs/Loan.xdp)。 此值是必需参数。
    • 指定版本的字符串值。 此值是可选参数,您可以传递空字符串。 在这种情况下,将检索最新版本。

    retrieveContent方法返回包含XDP文件的CRCResult对象。 通过调用CRCResult对象的getDocument方法检索com.adobe.idp.Document实例。

  4. 渲染非交互式PDF表单。

    调用OutputClient对象的generatePDFOutput2方法并传递以下值:

    • TransformationFormat明细列表值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定图像等其他资源所在的内容根目录。
    • 表示表单设计的com.adobe.idp.Document对象(使用CRCResult对象的getDocument方法返回的实例)。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • com.adobe.idp.Document对象,它包含要与表单设计合并的数据的XML数据源。

    generatePDFOutput2方法返回包含操作结果的OutputResult对象。

  5. 对表单数据流执行操作。

    • 通过调用OutputResult对象的getGeneratedDoc方法,检索表示非交互式表单的com.adobe.idp.Document对象。
    • 创建一个java.io.File对象,其中包含操作的结果。 确保文件扩展名为.pdf。
    • 调用com.adobe.idp.Document对象的copyToFile方法,将com.adobe.idp.Document对象的内容复制到文件(请确保使用由getGeneratedDoc方法返回的com.adobe.idp.Document对象)。

另请参阅

步骤摘要

快速开始(EJB模式):使用Java API将文档传递到输出服务

快速开始(SOAP模式):使用Java API将文档传递到输出服务

包括AEM Forms Java库文件

设置连接属性

使用Web服务API将文档传递到输出服务

通过使用输出服务和内容服务(已弃用)API(Web服务)传递从Content Services检索到的文档(已弃用):

  1. 包括项目文件。

    创建使用MTOM的Microsoft .NET项目。 由于此客户端应用程序调用两个AEM Forms服务,请创建两个服务引用。 对与输出服务关联的服务引用使用以下WSDL定义:http://localhost:8080/soap/services/OutputService?WSDL&lc_version=9.0.1

    对与文档管理服务关联的服务引用使用以下WSDL定义:http://localhost:8080/soap/services/DocumentManagementService?WSDL&lc_version=9.0.1

    由于BLOB数据类型对于两个服务引用都是通用的,因此在使用BLOB数据类型时,请完全限定该数据类型。 在相应的Web服务快速开始中,所有BLOB实例都完全限定。

    注意

    localhost替换为承载AEM Forms的服务器的IP地址。

  2. 创建一个输出和一个文档管理客户端API对象。

    • 使用OutputServiceClient对象的默认构造函数创建一个对象。

    • 使用System.ServiceModel.EndpointAddress构造函数创建OutputServiceClient.Endpoint.Address对象。 将指定WSDL的字符串值传递给Forms服务(例如http://localhost:8080/soap/services/OutputService?blob=mtom)。 您无需使用lc_version属性。 此属性在您创建服务引用时使用。)

    • 通过获取OutputServiceClient.Endpoint.Binding字段的值,创建System.ServiceModel.BasicHttpBinding对象。 将返回值转换为BasicHttpBinding

    • System.ServiceModel.BasicHttpBinding对象的MessageEncoding字段设置为WSMessageEncoding.Mtom。 此值确保使用MTOM。

    • 通过执行以下任务,启用基本HTTP身份验证:

      • 为字段OutputServiceClient.ClientCredentials.UserName.UserName指定AEM表单用户名。
      • 为字段OutputServiceClient.ClientCredentials.UserName.Password分配相应的密码值。
      • 将常量值HttpClientCredentialType.Basic赋给字段BasicHttpBindingSecurity.Transport.ClientCredentialType
    • 将常量值BasicHttpSecurityMode.TransportCredentialOnly赋给字段BasicHttpBindingSecurity.Security.Mode

    注意

    DocumentManagementServiceClient服务客户端重复这些步骤。

  3. 从Content Services检索表单设计(已弃用)。

    通过调用DocumentManagementServiceClient对象的retrieveContent方法并传递以下值来检索内容:

    • 一个字符串值,它指定添加内容的存储。 默认存储为SpacesStore。 此值是必需参数。
    • 一个字符串值,它指定要检索的内容的完全限定路径(例如,/Company Home/Form Designs/Loan.xdp)。 此值是必需参数。
    • 指定版本的字符串值。 此值是可选参数,您可以传递空字符串。 在这种情况下,将检索最新版本。
    • 存储浏览链接值的字符串输出参数。
    • 存储内容的BLOB输出参数。 您可以使用此输出参数来检索内容。
    • 存储内容属性的ServiceReference1.MyMapOf_xsd_string_To_xsd_anyType输出参数。
    • CRCResult输出参数。 您可以使用BLOB输出参数来检索内容,而不是使用此对象。
  4. 渲染非交互式PDF表单。

    调用OutputServiceClient对象的generatePDFOutput2方法并传递以下值:

    • TransformationFormat明细列表值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定图像等其他资源所在的内容根目录。
    • 表示表单设计的BLOB对象(使用Content Services返回的BLOB实例(已弃用))。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • BLOB对象,它包含要与表单设计合并的数据的XML数据源。
    • generatePDFOutput2方法填充的输出BLOB对象。 generatePDFOutput2方法使用生成的描述该文档的元数据填充此对象。 (此参数值仅对Web服务调用是必需的)。
    • 包含操作结果的输出OutputResult对象。 (此参数值仅对Web服务调用是必需的)。

    generatePDFOutput2方法返回一个BLOB对象,该对象包含非交互式PDF表单。

  5. 对表单数据流执行操作。

    • 通过调用其构造函数创建System.IO.FileStream对象。 传递一个字符串值,该值表示交互式PDF文档的文件位置以及打开文件的模式。
    • 创建一个字节数组,用于存储从generatePDFOutput2方法检索到的BLOB对象的内容。 通过获取BLOB对象的MTOM数据成员的值来填充字节数组。
    • 通过调用其构造函数并传递System.IO.FileStream对象,创建System.IO.BinaryWriter对象。
    • 通过调用System.IO.BinaryWriter对象的Write方法并传递字节数组,将字节数组的内容写入PDF文件。

另请参阅

步骤摘要

使用MTOM调用AEM Forms

将位于存储库中的文档传递到输出服务

输出服务渲染非交互式PDF表单,该表单基于表单设计,通常另存为XDP文件并在设计器中创建。 可以将包含表单设计的com.adobe.idp.Document对象传递给Output服务。 然后,输出服务将呈现位于com.adobe.idp.Document对象中的表单设计。

com.adobe.idp.Document对象传递到Output服务的一个优点是,其他AEM Forms服务操作会返回com.adobe.idp.Document实例。 也就是说,您可以从另一个服务操作获取com.adobe.idp.Document实例并渲染它。 例如,假设XDP文件存储在AEM Forms存储库中,如下图所示。

pd_pd_formrepository

FormsFolder​文件夹是AEM Forms存储库中的用户定义位置(此位置是一个示例,默认情况下不存在)。 在此示例中,名为Loan.xdp的表单设计位于此文件夹中。 除了表单设计外,还可以在此位置存储其他表单附属品,如图像。 位于AEM Forms存储库中的资源的路径为:

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

您可以从AEM Forms存储库以编程方式检索Loan.xdp,并将其传递给com.adobe.idp.Document对象中的Output服务。

您可以使用以下两种方法之一基于位于存储库中的XDP文件创建PDF。 可以按引用传递XDP位置,也可以通过编程方式从存储库中检索XDP并将其传递到XDP文件中的Output服务。

快速开始(EJB模式):使用Java API基于应用程序XDP文件创建PDF文档 (显示如何通过引用传递XDP文件的位置)。

快速开始(EJB模式):使用Java API将位于AEM Forms存储库中的文档传递到输出服务 (显示如何从AEM Forms存储库以编程方式检索XDP文件并将其传递到实例中的输出 com.adobe.idp.Document 服务)。(本节讨论如何执行此任务)

注意

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

步骤的摘要

要将从AEM Forms存储库获取的文档传递到输出服务,请执行以下任务:

  1. 包括项目文件。
  2. 创建一个输出和一个文档管理客户端API对象。
  3. 从AEM Forms存储库检索表单设计。
  4. 渲染非交互式PDF表单。
  5. 对数据流执行操作。

包括项目文件

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

创建输出和文档管理客户端API对象

在以编程方式执行输出服务API操作之前,请先创建一个输出客户端API对象。 此外,由于此工作流从Content Services检索XDP文件(已弃用),请创建一个文档管理API对象。

从AEM Forms存储库检索表单设计

使用存储库API从AEM Forms存储库检索XDP文件。 (请参阅阅读资源。)

XDP文件在com.adobe.idp.Document实例(或BLOB实例(如果您使用Web服务)中返回。 然后,您可以将com.adobe.idp.Document实例传递到Output服务。

渲染非交互式PDF表单

要渲染非交互式表单,请传递使用AEM Forms Repository API返回的com.adobe.idp.Document实例。

注意

名为generatePDFOutput2generatePrintedOutput2的两种新方法接受包含表单设计的com.adobe.idp.Document对象。 在向网络打印机发送打印流时,还可以将包含表单设计的com.adobe.idp.Document传递给Output服务。

对表单数据流执行操作

可以将非交互式表单另存为PDF文件。 可在Adobe Reader或Acrobat中查看表单。

另请参阅

使用Java API将位于存储库中的文档传递到输出服务

包括AEM Forms Java库文件

设置连接属性

输出服务API快速开始

ResourceRepositoryClient

使用Java API将位于存储库中的文档传递到输出服务

使用输出服务和存储库API(Java)传递从存储库检索到的文档:

  1. 包括项目文件。

    在Java项目的类路径中包含客户端JAR文件,如adobe-output-client.jar和adobe-repository-client.jar。

  2. 创建一个输出和一个文档管理客户端API对象。

    • 创建包含连接属性的ServiceClientFactory对象。 (请参阅设置连接属性。)
    • 使用OutputClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
    • 使用DocumentManagementServiceClientImpl对象的构造函数并传递ServiceClientFactory对象,创建对象。
  3. 从AEM Forms存储库检索表单设计。

    调用ResourceRepositoryClient对象的readResourceContent方法,并将指定URI位置的字符串值传递给XDP文件。 例如,/Applications/FormsApplication/1.0/FormsFolder/Loan.xdp。 此值是必填项。 此方法返回一个表示XDP文件的com.adobe.idp.Document实例。

  4. 渲染非交互式PDF表单。

    调用OutputClient对象的generatePDFOutput2方法并传递以下值:

    • TransformationFormat明细列表值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定图像等其他资源所在的内容根目录。 例如,repository:///Applications/FormsApplication/1.0/FormsFolder/
    • 表示表单设计的com.adobe.idp.Document对象(使用ResourceRepositoryClient对象的readResourceContent方法返回的实例)。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • com.adobe.idp.Document对象,它包含要与表单设计合并的数据的XML数据源。

    generatePDFOutput2方法返回包含操作结果的OutputResult对象。

  5. 对表单数据流执行操作。

    • 通过调用OutputResult对象的getGeneratedDoc方法,检索表示非交互式表单的com.adobe.idp.Document对象。
    • 创建一个java.io.File对象,其中包含操作的结果。 确保文件扩展名为.pdf。
    • 调用com.adobe.idp.Document对象的copyToFile方法,将com.adobe.idp.Document对象的内容复制到文件(请确保使用由getGeneratedDoc方法返回的com.adobe.idp.Document对象)。

另请参阅

步骤摘要

快速开始(EJB模式):使用Java API将位于AEM Forms存储库中的文档传递到输出服务

包括AEM Forms Java库文件

设置连接属性

使用片段创建PDF文档

您可以使用“输出”和“汇编器”服务创建基于片段的输出流,如PDF文档。 Assembler服务会装配一个基于位于多个XDP文件中的片段的XDP文档。 已装配的XDP文档将传递给“输出”服务,该服务将创建PDF文档。 尽管此工作流显示正在生成的PDF文档,但输出服务可以为此工作流生成其他输出类型,如ZPL。 PDF文档仅用于讨论目的。

下图显示了此工作流。

cp_cp_outputsemblefragments

在阅读​使用片段​创建PDF文档之前,建议您熟悉使用Assembler服务组合多个XDP文档。 (请参阅组合多个XDP片段。)

注意

您还可以将由Assembler服务组合的表单设计传递给Forms服务,而不是Output服务。 输出服务与Forms服务的主要区别在于Forms服务生成交互式PDF文档,而输出服务生成非交互式PDF文档。 此外,Forms服务无法生成基于打印机的输出流,如ZPL。

注意

有关输出服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要创建基于片段的PDF文档,请执行以下步骤:

  1. 包括项目文件。
  2. 创建一个Output和Assembler Client对象。
  3. 使用Assembler服务生成表单设计。
  4. 使用“输出”服务生成PDF文档。
  5. 将PDF文档另存为PDF文件。

包括项目文件

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

创建Output和Assembler客户端对象

在以编程方式执行输出服务API操作之前,请先创建一个输出客户端API对象。 此外,由于此工作流调用Assembler服务来创建表单设计,因此请创建一个Assembler客户端API对象。

使用Assembler服务生成表单设计

使用Assembler服务使用片段生成表单设计。 Assembler服务返回包含表单设计的com.adobe.idp.Document实例。

使用输出服务生成PDF文档

您可以使用Assembler服务创建的表单设计来使用Output服务生成PDF文档。 将Assembler服务返回的com.adobe.idp.Document实例传递给Output服务。

将PDF文档另存为PDF文件

在输出服务生成PDF文档后,您可以将其另存为PDF文件。

另请参阅

使用Java API根据片段创建PDF文档

使用Web服务API基于片段创建PDF文档

包括AEM Forms Java库文件

设置连接属性

输出服务API快速开始

组合多个XDP片段

创建PDF文档

使用Java API基于片段创建PDF文档

使用Output Service API和Assembler Service API(Java)根据片段创建PDF文档:

  1. 包括项目文件。

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

  2. 创建一个Output和Assembler Client对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用OutputClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
    • 使用AssemblerServiceClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
  3. 使用Assembler服务生成表单设计。

    调用AssemblerServiceClient对象的invokeDDX方法并传递以下必需值:

    • 一个com.adobe.idp.Document对象,它表示要使用的DDX文档。
    • 一个java.util.Map对象,其中包含输入的XDP文件。
    • 一个com.adobe.livecycle.assembler.client.AssemblerOptionSpec对象,它指定运行时选项,包括默认字体和作业日志级别。

    invokeDDX方法返回一个com.adobe.livecycle.assembler.client.AssemblerResult对象,该对象包含已装配的XDP文档。 要检索已装配的XDP文档,请执行以下操作:

    • 调用AssemblerResult对象的getDocuments方法。 此方法返回java.util.Map对象。
    • 遍历java.util.Map对象,直到找到生成的com.adobe.idp.Document对象。
    • 调用com.adobe.idp.Document对象的copyToFile方法以提取已装配的XDP文档。
  4. 使用“输出”服务生成PDF文档。

    调用OutputClient对象的generatePDFOutput2方法并传递以下值:

    • TransformationFormat明细列表值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定附加资源(如图像)所在的内容根
    • 表示表单设计的com.adobe.idp.Document对象(使用Assembler服务返回的实例)
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象
    • 包含渲染运行时选项的RenderOptionsSpec对象
    • com.adobe.idp.Document对象,它包含要与表单设计合并的数据的XML数据源

    generatePDFOutput2方法返回一个OutputResult对象,其中包含操作的结果

  5. 将PDF文档另存为PDF文件。

    • 通过调用OutputResult对象的getGeneratedDoc方法,检索表示PDF文档的com.adobe.idp.Document对象。
    • 创建一个java.io.File对象,其中包含操作的结果。 确保文件扩展名为.pdf。
    • 调用com.adobe.idp.Document对象的copyToFile方法,将com.adobe.idp.Document对象的内容复制到文件。 (请确保使用getGeneratedDoc方法返回的com.adobe.idp.Document对象。)

另请参阅

步骤摘要

快速开始(EJB模式):使用Java API创建基于片段的PDF文档

快速开始(SOAP模式):使用Java API创建基于片段的PDF文档

包括AEM Forms Java库文件

设置连接属性

使用Web服务API基于片段创建PDF文档

使用Output Service API和Assembler Service API(Web服务)根据片段创建PDF文档:

  1. 包括项目文件。

    创建使用MTOM的Microsoft .NET项目。 对与输出服务关联的服务引用使用以下WSDL定义:

     http://localhost:8080/soap/services/OutputService?WSDL&lc_version=9.0.1.
    

    对与Assembler服务关联的服务引用使用以下WSDL定义:

     http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1.
    

    由于BLOB数据类型对于两个服务引用都是通用的,因此在使用BLOB数据类型时,请完全限定该数据类型。 在相应的Web服务快速开始中,所有BLOB实例都完全限定。

    注意

    localhost替换为承载AEM Forms的服务器的IP地址。

  2. 创建一个Output和Assembler Client对象。

    • 使用OutputServiceClient对象的默认构造函数创建一个对象。

    • 使用System.ServiceModel.EndpointAddress构造函数创建OutputServiceClient.Endpoint.Address对象。 将指定WSDL的字符串值传递给AEM Forms服务(例如http://localhost:8080/soap/services/OutputService?blob=mtom)。 您无需使用lc_version属性。 在创建服务引用时使用此属性。 但是,请指定?blob=mtom以使用MTOM。

    • 通过获取OutputServiceClient.Endpoint.Binding字段的值,创建System.ServiceModel.BasicHttpBinding对象。 将返回值转换为BasicHttpBinding

    • System.ServiceModel.BasicHttpBinding对象的MessageEncoding字段设置为WSMessageEncoding.Mtom。 此值确保使用MTOM。

    • 通过执行以下任务,启用基本HTTP身份验证:

      • OutputServiceClient.ClientCredentials.UserName.UserName字段指定AEM表单用户名。
      • OutputServiceClient.ClientCredentials.UserName.Password字段指定相应的密码值。
      • 将常量值HttpClientCredentialType.Basic指定到BasicHttpBindingSecurity.Transport.ClientCredentialType字段。
    • BasicHttpSecurityMode.TransportCredentialOnly常量值指定给BasicHttpBindingSecurity.Security.Mode字段。

    注意

    AssemblerServiceClient对象重复这些步骤。

  3. 使用Assembler服务生成表单设计。

    调用AssemblerServiceClient对象的invokeDDX方法并传递以下值:

    • 表示DDX文档的BLOB对象
    • 包含所需文件的MyMapOf_xsd_string_To_xsd_anyType对象
    • 指定运行时选项的AssemblerOptionSpec对象

    invokeDDX方法返回一个AssemblerResult对象,其中包含作业的结果和发生的任何异常。 要获取新创建的XDP文档,请执行以下操作:

    • 访问AssemblerResult对象的documents字段,该字段是一个Map对象,其中包含生成的PDF文档。
    • Map对象中迭代以检索已装配的表单设计。 将该数组成员的value转换为BLOB。 将此BLOB实例传递给Output服务。
  4. 使用“输出”服务生成PDF文档。

    调用OutputServiceClient对象的generatePDFOutput2方法并传递以下值:

    • TransformationFormat明细列表值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定附加资源(如图像)所在的内容根。
    • 表示表单设计的BLOB对象(使用由Assembler服务返回的BLOB实例)。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • BLOB对象,它包含要与表单设计合并的数据的XML数据源。
    • generatePDFOutput2方法填充的输出BLOB对象。 generatePDFOutput2方法使用生成的描述该文档的元数据填充此对象。 (此参数值仅对Web服务调用是必需的)。
    • 包含操作结果的输出OutputResult对象。 (此参数值仅对Web服务调用是必需的)。

    generatePDFOutput2方法返回一个BLOB对象,该对象包含非交互式PDF表单。

  5. 将PDF文档另存为PDF文件。

    • 通过调用其构造函数创建System.IO.FileStream对象。 传递一个字符串值,该值表示交互式PDF文档的文件位置以及打开文件的模式。
    • 创建一个字节数组,用于存储从generatePDFOutput2方法检索到的BLOB对象的内容。 通过获取BLOB对象的MTOM数据成员的值来填充字节数组。
    • 通过调用其构造函数并传递System.IO.FileStream对象,创建System.IO.BinaryWriter对象。
    • 通过调用System.IO.BinaryWriter对象的Write方法并传递字节数组,将字节数组的内容写入PDF文件。

另请参阅

步骤摘要

使用MTOM调用AEM Forms

打印到文件

可以使用“输出”服务将流(如PostScript、打印机控制语言(PCL))或以下标签格式打印到文件:

  • 泽布拉 — 兹普尔
  • Intermec - IPL
  • Datamax - DPL
  • TecToshiba - TPCL

使用“输出”服务,您可以将XML数据与表单设计合并,并将表单打印到文件。 下图显示了创建激光和标签文件的输出服务。

注意

有关向打印机发送打印流的信息,请参阅向打印机发送打印流

注意

有关输出服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要打印到文件,请执行以下步骤:

  1. 包括项目文件。
  2. 创建Output Client对象。
  3. 引用XML数据源。
  4. 设置打印到文件所需的打印运行时选项。
  5. 将打印流打印到文件。
  6. 检索操作结果。

包括项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-output-client.jar
  • adobe-utilities.jar(在JBoss上部署AEM Forms时为必需)
  • jbossall-client.jar(如果在JBoss上部署了AEM Forms,则为必需)

如果AEM Forms部署在非JBoss的受支持J2EE应用程序服务器上,则需要将adobe-utilities.jar和jbossall-client.jar文件替换为特定于部署AEM Forms的J2EE应用程序服务器的JAR文件。 (请参阅包括AEM Forms Java库文件。)

创建Output Client对象

在以编程方式执行输出服务操作之前,必须创建输出服务客户端对象。 如果您使用Java API,请创建OutputClient对象。 如果您使用Output Web服务API,请创建OutputServiceService对象。

引用XML数据源

要打印包含数据的文档,必须引用一个XML数据源,该数据源包含要用数据填充的每个表单域的XML元素。 XML元素名称必须与字段名称匹配。 如果XML元素与表单域不对应,或XML元素名称与域名称不匹配,则忽略该元素。 如果指定了所有XML元素,则不必与XML元素的显示顺序匹配。

设置打印到文件所需的打印运行时选项

要打印到文件,必须通过指定输出服务要打印到的文件的位置和名称来设置“文件URI运行时”选项。 例如,要指示输出服务将名为​MortgageForm.ps​的PostScript文件打印到C:\Adobe,请指定C:\Adobe\MortgageForm.ps。

注意

您可以定义可选的运行时选项。 有关可设置的所有选项的信息,请参阅AEM Forms API Reference中的PrintedOutputOptionsSpec类引用。

将打印流打印到文件

在引用包含表单数据的有效XML数据源并设置打印运行时选项后,可以调用输出服务,这会使其打印文件。

检索操作结果

在输出服务执行操作后,它返回各种数据项,如XML数据,这些数据项指定操作是否成功。

另请参阅

使用Java API打印到文件

使用Web服务API打印到文件

包括AEM Forms Java库文件

设置连接属性

输出服务API快速开始

使用输出API(Java)打印到文件:

  1. 包括项目文件。

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

  2. 创建Output Client对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用OutputClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
  3. 引用XML数据源。

    • 创建一个java.io.FileInputStream对象,它表示使用其构造函数并传递一个指定XML文件位置的字符串值来填充文档的XML数据源。
    • 使用com.adobe.idp.Document对象的构造函数并传递java.io.FileInputStream对象,创建对象。
  4. 设置打印到文件所需的打印运行时选项。

    • 使用PrintedOutputOptionsSpec对象的构造函数创建对象。
    • 通过调用PrintedOutputOptionsSpec对象的setFileURI方法并传递一个表示文件名称和位置的字符串值来指定文件。 例如,如果希望输出服务打印到位于C:\Adobe中的名为MortgageForm.ps的PostScript文件,请指定C:\Adobe\MortgageForm.ps。
    • 通过调用PrintedOutputOptionsSpec对象的setCopies方法并传递表示副本数的整数值,指定要打印的副本数。
  5. 将打印流打印到文件。

    通过调用OutputClient对象的generatePrintedOutput方法并传递以下值,打印到文件:

    • 一个PrintFormat明细列表值,它指定要创建的打印流格式。 例如,要创建PostScript打印流,请传递PrintFormat.PostScript
    • 一个字符串值,它指定表单设计的名称。
    • 一个字符串值,它指定相关附属文件(如图像文件)的位置。
    • 一个字符串值,它指定要使用的XDC文件的位置(如果通过使用PrintedOutputOptionsSpec对象指定了要使用的XDC文件,则可以传递null)。
    • 包含打印到文件所需的运行时选项的PrintedOutputOptionsSpec对象。
    • com.adobe.idp.Document对象,它包含包含表单数据的XML数据源。

    generatePrintedOutput方法返回包含操作结果的OutputResult对象。

    注意

    OutputResult对象的getRecordLevelMetaDataList方法返回null

  6. 检索操作结果。

    • 通过调用OutputResult对象的getStatusDoc方法(generatePrintedOutput方法返回OutputResult对象),创建表示generatePrintedOutput方法状态的com.adobe.idp.Document对象。
    • 创建一个java.io.File对象,其中包含操作结果。 确保文件扩展名为XML。
    • 调用com.adobe.idp.Document对象的copyToFile方法,将com.adobe.idp.Document对象的内容复制到文件(请确保使用由getStatusDoc方法返回的com.adobe.idp.Document对象)。

另请参阅

步骤摘要

快速开始(SOAP模式):使用Java API打印到文件

包括AEM Forms Java库文件

设置连接属性

使用输出API(Web服务)打印到文件:

  1. 包括项目文件。

    创建使用MTOM的Microsoft .NET项目。 确保使用以下WSDL定义:http://localhost:8080/soap/services/OutputService?WSDL&lc_version=9.0.1

    注意

    localhost替换为承载AEM Forms的服务器的IP地址。

  2. 创建Output Client对象。

    • 使用OutputServiceClient对象的默认构造函数创建一个对象。

    • 使用System.ServiceModel.EndpointAddress构造函数创建OutputServiceClient.Endpoint.Address对象。 将指定WSDL的字符串值传递给AEM Forms服务(例如http://localhost:8080/soap/services/OutputService?blob=mtom)。 您无需使用lc_version属性。 在创建服务引用时使用此属性。 但是,请指定?blob=mtom以使用MTOM。

    • 通过获取OutputServiceClient.Endpoint.Binding字段的值,创建System.ServiceModel.BasicHttpBinding对象。 将返回值转换为BasicHttpBinding

    • System.ServiceModel.BasicHttpBinding对象的MessageEncoding字段设置为WSMessageEncoding.Mtom。 此值确保使用MTOM。

    • 通过执行以下任务,启用基本HTTP身份验证:

      • 为字段OutputServiceClient.ClientCredentials.UserName.UserName指定AEM表单用户名。
      • 为字段OutputServiceClient.ClientCredentials.UserName.Password分配相应的密码值。
      • 将常量值HttpClientCredentialType.Basic赋给字段BasicHttpBindingSecurity.Transport.ClientCredentialType
      • 将常量值BasicHttpSecurityMode.TransportCredentialOnly赋给字段BasicHttpBindingSecurity.Security.Mode
  3. 引用XML数据源。

    • 使用BLOB对象的构造函数创建对象。 BLOB对象用于存储表单数据。
    • 通过调用System.IO.FileStream对象的构造函数并传递一个字符串值来创建对象,该字符串值指定包含表单数据的XML文件的位置。
    • 创建一个字节数组,用于存储System.IO.FileStream对象的内容。 可以通过获取System.IO.FileStream对象的Length属性来确定字节数组的大小。
    • 通过调用System.IO.FileStream对象的Read方法并传递要读取的字节数组、开始位置和流长度,用流数据填充字节数组。
    • 通过将binaryData属性赋予字节数组的内容,填充BLOB对象。
  4. 设置打印到文件所需的打印运行时选项。

    • 使用PrintedOutputOptionsSpec对象的构造函数创建对象。
    • 通过为PrintedOutputOptionsSpec对象的fileURI数据成员指定一个字符串值来指定文件,该字符串值表示文件的位置和名称。 例如,如果希望输出服务打印到位于C:\Adobe中的名为​MortgageForm.ps​的PostScript文件,请指定C:\Adobe\MortgageForm.ps。
    • 通过为PrintedOutputOptionsSpec对象的copies数据成员分配一个整数值来指定要打印的副本数。
  5. 将打印流打印到文件。

    通过调用OutputServiceService对象的generatePrintedOutput方法并传递以下值,打印到文件:

    • 一个PrintFormat明细列表值,它指定要创建的打印流格式。 例如,要创建PostScript打印流,请传递PrintFormat.PostScript
    • 一个字符串值,它指定表单设计的名称。
    • 一个字符串值,它指定相关附属文件(如图像文件)的位置。
    • 一个字符串值,它指定要使用的XDC文件的位置(如果通过使用PrintedOutputOptionsSpec对象指定了要使用的XDC文件,则可以传递null)。
    • 包含打印到文件所需的打印运行时选项的PrintedOutputOptionsSpec对象。
    • BLOB对象,它包含包含表单数据的XML数据源。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用生成的描述该文档的元数据填充此对象。 (仅Web服务调用需要此参数值。)
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用结果数据填充此对象。 (仅Web服务调用需要此参数值。)
    • 包含操作结果的OutputResult对象。 (仅Web服务调用需要此参数值。)
  6. 检索操作结果。

    • 通过调用System.IO.FileStream对象的构造函数并传递一个字符串值来创建对象,该字符串值表示包含结果数据的XML文件位置。 确保文件扩展名为XML。
    • 创建一个字节数组,用于存储OutputServiceService对象的generatePDFOutput方法(第八个参数)用结果数据填充的BLOB对象的数据内容。 通过获取BLOB对象的MTOM数据成员的值来填充字节数组。
    • 通过调用其构造函数并传递System.IO.FileStream对象,创建System.IO.BinaryWriter对象。
    • 通过调用System.IO.BinaryWriter对象的Write方法并传递字节数组,将字节数组的内容写入XML文件。

另请参阅

步骤摘要

使用MTOM调用AEM Forms

使用SwaRef调用AEM Forms

将打印流发送到打印机

可以使用“输出”服务将打印流(如PostScript、打印机控制语言(PCL)或以下标签格式)发送到网络打印机:

  • 泽布拉 — 兹普尔
  • Intermec - IPL
  • Datamax - DPL
  • TecToshiba - TPCL

使用“输出”服务,您可以将XML数据与表单设计合并,并将表单输出为打印流。 例如,您可以创建PostScript打印流并将其发送到网络打印机。 下图显示了将打印流发送到网络打印机的输出服务。

注意

为了说明如何将打印流发送到网络打印机,本节将使用SharedPrinter打印机协议将PostScript打印流发送到网络打印机。

注意

有关输出服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要将打印流发送到网络打印机,请执行以下步骤:

  1. 包括项目文件。
  2. 创建Output Client对象。
  3. 引用XML数据源。
  4. 设置打印运行时选项
  5. 检索要打印的文档。
  6. 将文档发送到网络打印机。

包括项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-output-client.jar
  • adobe-utilities.jar(在JBoss上部署AEM Forms时为必需)
  • jbossall-client.jar(在JBoss上部署AEM Forms时为必需)

如果AEM Forms部署在非JBoss的受支持J2EE应用程序服务器上,则需要将adobe-utilities.jar和jbossall-client.jar文件替换为特定于部署AEM Forms的J2EE应用程序服务器的JAR文件。

创建Output Client对象

在以编程方式执行输出服务操作之前,请先创建一个输出服务客户端对象。 如果您使用Java API,请创建OutputClient对象。 如果您使用Output Web服务API,请创建OutputServiceClient对象。

引用XML数据源

要打印包含数据的文档,必须引用一个XML数据源,该数据源包含要用数据填充的每个表单域的XML元素。 XML元素名称必须与字段名称匹配。 如果XML元素与表单域不对应,或XML元素名称与域名称不匹配,则忽略该元素。 如果指定了所有XML元素,则不必与XML元素的显示顺序匹配。

设置打印运行时选项

可以在将打印流发送到打印机时设置运行时选项,包括以下选项:

  • 副本:指定要发送到打印机的份数。默认值为 1。
  • 订书:使用订书机时设置XCI选项。此选项可在配置模型中由stapler元素指定,并且仅用于PS和PCL打印机。
  • OutputJog:当输出页应合页(在输出托盘中实际移动)时设置XCI选项。此选项仅适用于PS和PCL打印机。
  • OutputBin:用于使打印驱动程序能够选择相应输出箱的XCI值。
注意

有关可设置的所有运行时选项的信息,请参阅PrintedOutputOptionsSpec类引用。

检索要打印的文档

检索要发送到打印机的打印流。 例如,可以检索PostScript文件并将其发送到打印机。

如果您的打印机支持PDF,您可以选择发送PDF文件。 但是,向打印机发送PDF文档的问题是,每个打印机制造商都有不同的PDF解释器实现。 也就是说,一些印刷厂家使用Adobe PDF解释,但这取决于打印机。 其他打印机有自己的PDF解释器。 因此,打印结果可能会有所不同。

将PDF文档发送到打印机的另一个限制是它只能打印;除了通过打印机上的设置,它无法访问双工、纸盒选择和装订。

要检索要打印的文档,请使用generatePrintedOutput方法。 下表指定了在使用generatePrintedOutput方法时为给定打印流设置的内容类型。

打印格式

描述

DPL

默认情况下创建dpl203.xdc或自定义xdc输出流。

DPL 300 DPI

创建DPL 300 DPI输出流。

DPL 406 DPI

创建DPL 400 DPI输出流。

DPL 600 DPI

创建DPL 600 DPI输出流。

GenericColorPCL

创建通用颜色PCL(5c)输出流。

GenericPSLevel3

创建通用PostScript Level 3输出流。

IPL

创建自定义IPL输出流。

IPL 300 DPI

创建IPL 300 DPI输出流。

IPL 400 DPI

创建IPL 400 DPI输出流。

PCL

创建通用单色PCL(5e)输出流。

PostScript

创建通用PostScript Level 2输出流。

TPCL

创建自定TPCL输出流。

TPCL 305 DPI

创建TPCL 305 DPI输出流。

TPCL 600 DPI

创建TPCL 600 DPI输出流。

ZPL

创建ZPL 203 DPI输出流。

ZPL 300 DPI

创建ZPL 300 DPI输出流。

注意

还可以使用generatePrintedOutput2方法将打印流发送到打印机。 但是,与“将打印流发送到打印机”部分关联的快速开始使用generatePrintedOutput方法。

将打印流发送到网络打印机

检索要打印的文档后,可以调用输出服务,这会使其向网络打印机发送打印流。 要使输出服务成功找到打印机,必须指定打印服务器和打印机名称。 此外,还必须指定打印协议。

注意

如果PDFG安装在表单服务器上,且服务器运行在Windows Server 2008上,则无法使用SharedPrinter属性。 在这种情况下,请使用其他打印机协议。

注意

如果您使用网络打印机,并且访问机制是SharedPrinter,则需要指定打印机的完整网络路径。使用Java API将打印流发送到网络打印机

使用输出API(Java)将打印流发送到网络打印机:

  1. 包括项目文件。

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

  2. 创建Output Client对象

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用OutputClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
  3. 引用XML数据源

    • 创建一个java.io.FileInputStream对象,它表示使用其构造函数并传递一个指定XML文件位置的字符串值来填充文档的XML数据源。
    • 使用com.adobe.idp.Document对象的构造函数并传递java.io.FileInputStream对象,创建对象。
  4. 设置打印运行时选项

    创建表示打印运行时选项的PrintedOutputOptionsSpec对象。 例如,可以通过调用PrintedOutputOptionsSpec对象的setCopies方法来指定要打印的副本数。

    注意

    如果生成ZPL打印流,则不能使用PrintedOutputOptionsSpec对象的setPagination方法设置分页值。 同样,您也无法为ZPL打印流设置以下选项:OutputJog、PageOffset和Stapper。 setPagination方法对于PostScript生成无效。 它仅对PCL生成有效。

  5. 检索要打印的文档

    • 通过调用OutputClient对象的generatePrintedOutput方法并传递以下值来检索要打印的文档:

      • 指定打印流的PrintFormat明细列表值。 例如,要创建PostScript打印流,请传递PrintFormat.PostScript
      • 一个字符串值,它指定表单设计的名称。
      • 一个字符串值,它指定相关附属文件(如图像文件)的位置。
      • 一个字符串值,它指定要使用的XDC文件的位置。
      • PrintedOutputOptionsSpec对象,其中包含打印到文件所需的运行时选项。
      • 表示包含要与表单设计合并的表单数据的XML数据源的com.adobe.idp.Document对象。

      此方法返回一个OutputResult对象,其中包含操作的结果。

    • 通过调用OutputResult对象's getGeneratedDoc方法创建要发送到打印机的com.adobe.idp.Document对象。 此方法返回com.adobe.idp.Document对象。

  6. 将打印流发送到网络打印机

    通过调用OutputClient对象的sendToPrinter方法并传递以下值,将打印流发送到网络打印机:

    • 一个com.adobe.idp.Document对象,它表示要发送到打印机的打印流。
    • 一个PrinterProtocol明细列表值,它指定要使用的打印机协议。 例如,要指定SharedPrinter协议,请传递PrinterProtocol.SharedPrinter
    • 一个字符串值,它指定打印服务器的名称。 例如,假定打印服务器的名称为PrintServer1,传递\\\PrintSever1
    • 一个字符串值,它指定打印机的名称。 例如,假定打印机的名称为Printer1,请传递\\\PrintSever1\Printer1
    注意

    sendToPrinter方法已添加到版本8.2.1中的AEM Forms API。

使用Web服务API将打印流发送到打印机

使用输出API(Web服务)将打印流发送到网络打印机:

  1. 包括项目文件。

    创建使用MTOM的Microsoft .NET项目。 确保使用以下WSDL定义:http://localhost:8080/soap/services/OutputService?WSDL&lc_version=9.0.1

    注意

    localhost替换为承载AEM Forms的服务器的IP地址。

  2. 创建Output Client对象。

    • 使用OutputServiceClient对象的默认构造函数创建一个对象。

    • 使用System.ServiceModel.EndpointAddress构造函数创建OutputServiceClient.Endpoint.Address对象。 将指定WSDL的字符串值传递给AEM Forms服务(例如http://localhost:8080/soap/services/OutputService?blob=mtom)。 您无需使用lc_version属性。 在创建服务引用时使用此属性。 但是,请指定?blob=mtom以使用MTOM。

    • 通过获取OutputServiceClient.Endpoint.Binding字段的值,创建System.ServiceModel.BasicHttpBinding对象。 将返回值转换为BasicHttpBinding

    • System.ServiceModel.BasicHttpBinding对象的MessageEncoding字段设置为WSMessageEncoding.Mtom。 此值确保使用MTOM。

    • 通过执行以下任务,启用基本HTTP身份验证:

      • 为字段OutputServiceClient.ClientCredentials.UserName.UserName指定AEM表单用户名。
      • 为字段OutputServiceClient.ClientCredentials.UserName.Password分配相应的密码值。
      • 将常量值HttpClientCredentialType.Basic赋给字段BasicHttpBindingSecurity.Transport.ClientCredentialType
      • 将常量值BasicHttpSecurityMode.TransportCredentialOnly赋给字段BasicHttpBindingSecurity.Security.Mode
  3. 引用XML数据源。

    • 使用BLOB对象的构造函数创建对象。 BLOB对象用于存储表单数据。
    • 通过调用其构造函数创建System.IO.FileStream对象。 传递一个字符串值,它指定包含表单数据的XML文件的位置。
    • 创建一个字节数组,用于存储System.IO.FileStream对象的内容。 通过获取System.IO.FileStream对象的Length属性确定字节数组长度。
    • 通过调用System.IO.FileStream对象的Read方法并传递要读取的字节数组、开始位置和流长度,用流数据填充字节数组。
    • BLOB对象的MTOM字段指定为字节数组的内容,从而填充该对象。
  4. 设置打印运行时选项。

    使用PrintedOutputOptionsSpec对象的构造函数创建对象。 例如,可以通过为PrintedOutputOptionsSpec对象的copies数据成员分配一个整数值来指定要打印的副本数。

    注意

    如果要生成ZPL打印流,则不能使用PrintedOutputOptionsSpec对象的pagination数据成员设置分页值。 同样,您也无法为ZPL打印流设置以下选项:OutputJog、PageOffset和Stapper。 pagination数据成员对PostScript生成无效。 它仅对PCL生成有效。

  5. 检索要打印的文档。

    • 通过调用OutputServiceService对象的generatePrintedOutput方法并传递以下值来检索要打印的文档:

      • 指定打印流的PrintFormat明细列表值。 例如,要创建PostScript打印流,请传递PrintFormat.PostScript
      • 一个字符串值,它指定表单设计的名称。
      • 一个字符串值,它指定相关附属文件(如图像文件)的位置。
      • 一个字符串值,它指定要使用的XDC文件的位置。
      • PrintedOutputOptionsSpec对象,其中包含向网络打印机发送打印流时使用的打印运行时选项。
      • BLOB对象,它包含包含表单数据的XML数据源。
      • generatePrintedOutput方法填充的BLOB对象。 generatePrintedOutput方法使用生成的描述该文档的元数据填充此对象。 (仅Web服务调用需要此参数值。)
      • generatePrintedOutput方法填充的BLOB对象。 generatePrintedOutput方法使用结果数据填充此对象。 (仅Web服务调用需要此参数值。)
      • 包含操作结果的OutputResult对象。 (仅Web服务调用需要此参数值。)
    • 通过获取OutputResult对象's generatedDoc方法的值,创建要发送到打印机的BLOB对象。 此方法返回一个BLOB对象,该对象包含由generatePrintedOutput方法返回的PostScript数据。

  6. 将打印流发送到网络打印机。

    通过调用OutputClient对象的sendToPrinter方法并传递以下值,将打印流发送到网络打印机:

    • 一个BLOB对象,它表示要发送到打印机的打印流。
    • 一个PrinterProtocol明细列表值,它指定要使用的打印机协议。 例如,要指定SharedPrinter协议,请传递PrinterProtocol.SharedPrinter
    • 一个bool值,它指定是否使用上一个参数值。 传递值true。 (仅Web服务调用需要此参数值。)
    • 一个字符串值,它指定打印服务器的名称。 例如,假定打印服务器的名称为PrintServer1,请传递\\\PrintSever1
    • 一个字符串值,它指定打印机的名称。 例如,假定打印机的名称为Printer1,请传递\\\PrintSever1\Printer1
    注意

    sendToPrinter方法已添加到版本8.2.1中的AEM Forms API。

创建多个输出文件

输出服务可以为XML数据源中的每条记录或包含所有记录的单个文件(此功能是默认功能)创建单独的文档。 例如,假定有十条记录位于XML数据源中,并且您指示输出服务使用输出服务API为每个记录创建单独的PDF文档(或其他类型的输出)。 因此,输出服务会生成十个PDF文档。 (您可以向打印机发送多个打印流,而不是创建文档。)

下图还显示了处理包含多个记录的XML数据文件的Output服务。 但是,假设您指示输出服务创建包含所有数据记录的单个PDF文档。 在这种情况下,输出服务将生成一个包含所有记录的文档。

下图显示了Output服务处理包含多个记录的XML数据文件。 假设您指示输出服务为每个数据记录创建单独的PDF文档。 在这种情况下,输出服务会为每个数据记录生成单独的PDF文档。

cm_outputbatchmany

以下XML数据显示了一个包含三个数据记录的数据文件示例。

 <?xml version="1.0" encoding="UTF-8"?>
 <batch>
 <LoanRecord>
     <mortgageAmount>500000</mortgageAmount>
     <lastName>Blue</lastName>
     <firstName>Tony</firstName>
     <SSN>555666777</SSN>
     <PositionTitle>Product Manager</PositionTitle>
     <Address>555 No Where Dr</Address>
     <City>New York</City>
     <StateProv>New York</StateProv>
     <ZipCode>51256</ZipCode>
     <Email>TBlue@NoMailServer.com</Email>
     <PhoneNum>555-7418</PhoneNum>
     <FaxNum>555-9981</FaxNum>
     <Description>Buy a home</Description>
 </LoanRecord>
 <LoanRecord>
     <mortgageAmount>300000</mortgageAmount>
     <lastName>White</lastName>
     <firstName>Sam</firstName>
     <SSN>555666222</SSN>
     <PositionTitle>Program Manager</PositionTitle>
     <Address>557 No Where Dr</Address>
     <City>New York</City>
     <StateProv>New York</StateProv>
     <ZipCode>51256</ZipCode>
     <Email>SWhite@NoMailServer.com</Email>
     <PhoneNum>555-7445</PhoneNum>
     <FaxNum>555-9986</FaxNum>
     <Description>Buy a home</Description>
 </LoanRecord>
 <LoanRecord>
     <mortgageAmount>700000</mortgageAmount>
     <lastName>Green</lastName>
     <firstName>Steve</firstName>
     <SSN>55566688</SSN>
     <PositionTitle>Project Manager</PositionTitle>
     <Address>445 No Where Dr</Address>
     <City>New York</City>
     <StateProv>New York</StateProv>
     <ZipCode>51256</ZipCode>
     <Email>SGreeb@NoMailServer.com</Email>
     <PhoneNum>555-2211</PhoneNum>
     <FaxNum>555-2221</FaxNum>
     <Description>Buy a home</Description>
 </LoanRecord>
 </batch>

请注意,开始和结束每个数据记录的XML元素为LoanRecord。 此XML元素由生成多个文件的应用程序逻辑引用。

注意

有关输出服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要基于XML数据源创建多个PDF文件,请执行以下步骤:

  1. 包括项目文件。
  2. 创建Output Client对象。
  3. 引用XML数据源。
  4. 设置PDF运行时选项。
  5. 设置渲染运行时选项。
  6. 生成多个PDF文件。
  7. 检索操作结果。

包括项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-output-client.jar
  • adobe-utilities.jar(在JBoss上部署AEM Forms时为必需)
  • jbossall-client.jar(如果在JBoss上部署了AEM Forms,则为必需)

如果AEM Forms部署在非JBoss的受支持J2EE应用程序服务器上,则需要将adobe-utilities.jar和jbossall-client.jar文件替换为特定于部署AEM Forms的J2EE应用程序服务器的JAR文件。

创建Output Client对象

在以编程方式执行输出服务操作之前,必须创建输出服务客户端对象。 如果您使用Java API,请创建OutputClient对象。 如果您使用Output Web服务API,请创建OutputServiceService对象。

引用XML数据源

引用包含多个记录的XML数据源。 必须使用XML元素来分隔数据记录。 例如,在本节前面显示的示例XML数据源中,用于分隔数据记录的XML元素名为LoanRecord

要用数据填充的每个表单域都必须存在XML元素。 XML元素名称必须与字段名称匹配。 如果XML元素与表单域不对应,或XML元素名称与域名称不匹配,则忽略该元素。 如果指定了所有XML元素,则不必与XML元素的显示顺序匹配。

设置PDF运行时选项

必须为输出服务设置以下运行时选项,才能基于XML数据源成功创建多个文件:

  • 许多文件:指定输出服务是创建单个文档还是多个文档。可以指定true或false。 要为XML数据源中的每个数据记录创建单独的文档,请指定true。
  • 文件URI:指定输出服务生成的文件的位置。例如,假设您指定了C:\Adobe\forms\Loan.pdf。 在这种情况下,输出服务将创建一个名为Loan.pdf的文件,并将该文件放在C:\Adobe\forms folder文件夹中。 当存在多个文件时,文件名为Loan0001.pdf、Loan0002.pdf、Loan0003.pdf等。 如果指定文件位置,则文件将放在服务器上,而不放在客户端计算机上。
  • 记录名称:指定用于分隔数据记录的数据源中的XML元素名称。例如,在本节前面显示的示例XML数据源中,用于分隔数据记录的XML元素称为LoanRecord。 (除了设置“记录名称”运行时选项,您还可以通过为记录级别分配一个数值来设置记录级别,该值指示包含数据记录的元素级别。 但是,您只能设置“记录名称”或“记录级别”。 不能同时设置这两个值。)

设置渲染运行时选项

您可以在创建多个文件时设置渲染运行时选项。 尽管这些选项不是必需的(与输出运行时选项不同,它们是必需的),但您可以执行任务,如提高输出服务的性能。 例如,您可以缓存输出服务使用的表单设计以提高性能。

当输出服务处理批处理记录时,它以增量方式读取包含多个记录的数据。 即,输出服务将数据读入内存,并在处理记录批时释放数据。 设置两个运行时选项之一时,输出服务以增量方式加载数据。 如果设置“记录名称”运行时选项,则“输出”服务以增量方式读取数据。 同样,如果将“记录级别”运行时选项设置为2或更大,则“输出”服务以增量方式读取数据。

您可以通过使用PDFOutputOptionsSpecPrintedOutputOptionSpec对象的setLazyLoading方法控制Output服务是否执行增量加载。 可以将值false传递到此方法,以关闭增量加载。

生成多个PDF文件

在引用包含多个数据记录和设置运行时选项的有效XML数据源后,可以调用输出服务,这会导致它生成多个文件。 在生成多个记录时,OutputResult对象的getGeneratedDoc方法返回null

检索操作结果

输出服务执行操作后,它返回指定操作是否成功的XML数据。 输出服务返回以下XML。 在这种情况下,输出服务生成了42个文档。

 <?xml version="1.0" encoding="UTF-8"?>
 <printResult>
 <status>0</status>
 <requestId>4ad85f9e2</requestId>
 <context/>
 <messages>
 <message>Printed all 42 records successfully.</message>
 </messages>
 <printSpec>
 <input>
 <validated>true</validated>
 <dataFile recordIdField="" recordLevel="0" recordName="LoanRecord"/>
 <sniffRules lookAhead="300"/>
 <formDesign>Loan.xdp</formDesign>
 <contentRoot>C:\Adobe</contentRoot>
 <metadata-spec record="false"/>
 </input>
 <output>
 <format>PDF</format>
 <fileURI>C:\Adobe\forms\Loan.pdf</fileURI>
 <optionString>cacheenabled=true&padebug=false&linearpdf=false&pdfarevisionnumber=1&pdfaconformance=A&taggedpdf=false&TransactionTimeOut=180</optionString>
 <waitForResponse>true</waitForResponse>
 <outputStream>multiple</outputStream>
 </output>
 </printSpec>
 </printResult>

另请参阅

包括AEM Forms Java库文件

设置连接属性

输出服务API快速开始

使用Java API创建多个PDF文件

使用输出API(Java)创建多个PDF文件:

  1. 包括项目文件”

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

  2. 创建Output Client对象

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用OutputClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
  3. 引用XML数据源

    • 使用java.io.FileInputStream对象的构造函数并传递一个指定XML文件位置的字符串值,创建一个对象,该对象表示包含多个记录的XML数据源。
    • 使用com.adobe.idp.Document对象的构造函数并传递java.io.FileInputStream对象,创建对象。
  4. 设置PDF运行时选项

    • 使用PDFOutputOptionsSpec对象的构造函数创建对象。
    • 通过调用PDFOutputOptionsSpec对象的setGenerateManyFiles方法设置“Many Files”(多个文件)选项。 例如,传递值true以指示Output服务为XML数据源中的每条记录创建单独的PDF文件。 (如果传递false,输出服务将生成包含所有记录的单个PDF文档)。
    • 通过调用PDFOutputOptionsSpec对象的setFileUri方法并传递一个字符串值来设置File URI选项,该字符串值指定Output服务生成的文件的位置。 “文件URI”选项是相对于承载AEM Forms的J2EE应用程序服务器,而不是客户端计算机。
    • 通过调用OutputOptionsSpec对象的setRecordName方法并传递一个字符串值来设置“记录名称”选项,该字符串值指定用于分隔数据记录的数据源中的XML元素名称。 (例如,请考虑本节前面显示的XML数据源。 用于分隔数据记录的XML元素的名称为LoanRecord)。
  5. 设置渲染运行时选项

    • 使用RenderOptionsSpec对象的构造函数创建对象。
    • 通过调用RenderOptionsSpec对象的setCacheEnabled并传递Booleantrue来缓存表单设计以改进输出服务的性能。
  6. 生成多个PDF文件

    通过调用OutputClient对象的generatePDFOutput方法并传递以下值,生成多个PDF文件:

    • TransformationFormat枚举值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定表单设计的名称。
    • 一个字符串值,它指定表单设计所在的内容根。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • com.adobe.idp.Document对象,它包含要与表单设计合并的数据的XML数据源。

    generatePDFOutput方法返回包含操作结果的OutputResult对象。

  7. 检索操作结果

    • 创建一个java.io.File对象,它表示将包含generatePDFOutput方法结果的XML文件。 确保文件扩展名为.xml。
    • 调用com.adobe.idp.Document对象的copyToFile方法,将com.adobe.idp.Document对象的内容复制到文件(请确保使用由applyUsageRights方法返回的com.adobe.idp.Document对象)。

另请参阅

步骤摘要

快速开始(EJB模式):使用Java API创建多个PDF文件

包括AEM Forms Java库文件

设置连接属性

使用Web服务API创建多个PDF文件

使用输出API(Web服务)创建多个PDF文件:

  1. 包括项目文件。

    创建使用MTOM的Microsoft .NET项目。 确保使用以下WSDL定义:http://localhost:8080/soap/services/OutputService?WSDL&lc_version=9.0.1

    注意

    localhost替换为承载AEM Forms的服务器的IP地址。

  2. 创建Output Client对象。

    • 使用OutputServiceClient对象的默认构造函数创建一个对象。

    • 使用System.ServiceModel.EndpointAddress构造函数创建OutputServiceClient.Endpoint.Address对象。 将指定WSDL的字符串值传递给AEM Forms服务(例如http://localhost:8080/soap/services/OutputService?blob=mtom)。 您无需使用lc_version属性。 在创建服务引用时使用此属性。 但是,请指定?blob=mtom以使用MTOM。

    • 通过获取OutputServiceClient.Endpoint.Binding字段的值,创建System.ServiceModel.BasicHttpBinding对象。 将返回值转换为BasicHttpBinding

    • System.ServiceModel.BasicHttpBinding对象的MessageEncoding字段设置为WSMessageEncoding.Mtom。 此值确保使用MTOM。

    • 通过执行以下任务,启用基本HTTP身份验证:

      • 为字段OutputServiceClient.ClientCredentials.UserName.UserName指定AEM表单用户名。
      • 为字段OutputServiceClient.ClientCredentials.UserName.Password分配相应的密码值。
      • 将常量值HttpClientCredentialType.Basic赋给字段BasicHttpBindingSecurity.Transport.ClientCredentialType
      • 将常量值BasicHttpSecurityMode.TransportCredentialOnly赋给字段BasicHttpBindingSecurity.Security.Mode
  3. 引用XML数据源。

    • 使用BLOB对象的构造函数创建对象。 BLOB对象用于存储包含多个记录的表单数据。
    • 通过调用其构造函数创建System.IO.FileStream对象。 传递一个字符串值,该值表示包含多个记录的XML文件的文件位置。
    • 创建一个字节数组,用于存储System.IO.FileStream对象的内容。 可以通过获取System.IO.FileStream对象的Length属性来确定字节数组的大小。
    • 通过调用System.IO.FileStream对象的Read方法并传递要读取的字节数组、开始位置和流长度,用流数据填充字节数组。
    • BLOB对象的MTOM字段指定为字节数组的内容,从而填充该对象。
  4. 设置PDF运行时选项。

    • 使用PDFOutputOptionsSpec对象的构造函数创建对象。
    • 通过为OutputOptionsSpec对象的generateManyFiles数据成员分配一个布尔值来设置“Many Files”选项。 例如,将值true赋给此数据成员,以指示Output服务为XML数据源中的每条记录创建单独的PDF文件。 (如果将false分配给此数据成员,则输出服务将生成包含所有记录的单个PDF)。
    • 通过指定一个字符串值来设置文件URI选项,该字符串值指定Output服务生成的文件到OutputOptionsSpec对象的fileURI数据成员的位置。 “文件URI”选项是相对于承载AEM Forms的J2EE应用程序服务器,而不是客户端计算机。
    • 通过指定一个字符串值来设置记录名称选项,该字符串值指定将数据记录分隔到OutputOptionsSpec对象的recordName数据成员的数据源中的XML元素名称。
    • 通过指定一个整数值来设置复制选项,该整数值指定输出服务为OutputOptionsSpec对象的copies数据成员生成的复制数。
  5. 设置渲染运行时选项。

    • 使用RenderOptionsSpec对象的构造函数创建对象。
    • 缓存表单设计,通过将值true指定给RenderOptionsSpec对象的cacheEnabled数据成员来改进输出服务的性能。
  6. 生成多个PDF文件。

    通过调用OutputServiceService对象的generatePDFOutput方法并传递以下值,创建多个PDF文件:

    • TransformationFormat枚举值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定表单设计的名称。
    • 一个字符串值,它指定表单设计所在的内容根。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • BLOB对象,它包含要与表单设计合并的数据的XML数据源。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用生成的描述该文档的元数据填充此对象。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用结果数据填充此对象。
    • 包含操作结果的OutputResult对象。
  7. 检索操作结果

    • 通过调用System.IO.FileStream对象的构造函数并传递一个字符串值来创建对象,该字符串值表示包含结果数据的XML文件位置。 确保文件扩展名为.xml。
    • 创建一个字节数组,用于存储OutputServiceService对象的generatePDFOutput方法(第八个参数)用结果数据填充的BLOB对象的数据内容。 通过获取BLOB对象的binaryData数据成员的值来填充字节数组。
    • 通过调用其构造函数并传递System.IO.FileStream对象,创建System.IO.BinaryWriter对象。
    • 通过调用System.IO.BinaryWriter对象的Write方法并传递字节数组,将字节数组的内容写入XML文件。

另请参阅

步骤摘要

使用MTOM调用AEM Forms

使用SwaRef调用AEM Forms

创建搜索规则

您可以创建搜索规则,使“输出”服务检查输入数据并使用基于数据内容的不同表单设计生成输出。 例如,如果文本​mortgage​位于输入数据中,则输出服务可以使用名为Mortgage.xdp的表单设计。 同样,如果文本​automical​位于输入数据中,则输出服务可以使用另存为AutobileLoan.xdp的表单设计。 尽管输出服务可以生成不同的输出类型,但本节假定输出服务生成PDF文件。 下图显示了通过处理XML数据文件并使用多种表单设计之一生成PDF文件的输出服务。

此外,输出服务能够生成文档包,其中在数据集中提供多个记录,并且每个记录与表单设计匹配,并且生成由多个表单设计组成的单个文档。

cs_outputbatchmanyformdesigns2

注意

有关输出服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要指示输出服务在生成文档时使用搜索规则,请执行以下步骤:

  1. 包括项目文件。
  2. 创建Output Client对象。
  3. 引用XML数据源。
  4. 定义搜索规则。
  5. 设置PDF运行时选项。
  6. 设置渲染运行时选项。
  7. 生成PDF文档。
  8. 检索操作结果。

包括项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-output-client.jar
  • adobe-utilities.jar(在JBoss上部署AEM Forms时为必需)
  • jbossall-client.jar(在JBoss上部署AEM Forms时为必需)

如果AEM Forms部署在非JBoss的受支持J2EE应用程序服务器上,则您需要将adobe-utilities.jar和jbossall-client.jar替换为特定于部署AEM Forms的J2EE应用程序服务器的JAR文件。

创建Output Client对象

在以编程方式执行输出服务操作之前,必须创建输出服务客户端对象。

引用XML数据源

要用数据填充的每个表单域都必须存在XML元素。 XML元素名称必须与字段名称匹配。 如果XML元素与表单域不对应,或XML元素名称与域名称不匹配,则忽略该元素。 只要指定了所有XML元素,就不必与XML元素的显示顺序匹配。

定义搜索规则

要定义搜索规则,您需要定义输出服务在输入数据中搜索的一个或多个文本模式。 对于您定义的每个文本图案,可指定在文本图案位于时使用的相应表单设计。 如果找到文本模式,则输出服务将使用相应的表单设计生成输出。 文本模式的示例为​mortgage

注意

如果找不到文本图案,则使用默认表单。 确保您使用的所有表单设计都位于内容根目录中。

设置PDF运行时选项

设置以下PDF运行时选项,以使“输出”服务成功创建基于多个表单设计的PDF文档:

  • 文件URI:指定输出服务生成的PDF文件的名称和位置。
  • 规则:指定您定义的规则。
  • LookAHead:指定从输入数据文件开始扫描所定义文本模式的字节数。默认为500字节。

设置渲染运行时选项

您可以在创建PDF文件时设置渲染运行时选项。 尽管这些选项不是必需的(与PDF运行时选项不同),但您可以执行任务,如提高输出服务的性能。 例如,您可以缓存输出服务使用的表单设计以提高性能。

生成PDF文档

在引用有效的XML数据源并设置运行时选项后,可以调用输出服务,以生成PDF文档。 如果输出服务在输入数据中定位指定的文本模式,则它使用相应的表单设计。 如果未使用文本模式,则输出服务将使用默认的表单设计。

检索操作结果

输出服务执行操作后,它返回指定操作是否成功的XML数据。

另请参阅

包括AEM Forms Java库文件

设置连接属性

输出服务API快速开始

使用Java API创建搜索规则

使用输出API(Java)创建搜索规则:

  1. 包括项目文件。

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

  2. 创建Output Client对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用OutputClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
  3. 引用XML数据源。

    • 创建一个java.io.FileInputStream对象,它表示使用PDF文档的构造函数并传递一个指定XML文件位置的字符串值来填充PDF数据源的XML数据源。
    • 使用com.adobe.idp.Document对象的构造函数并传递java.io.FileInputStream对象,创建对象。
  4. 定义搜索规则。

    • 使用Rule对象的构造函数创建对象。
    • 通过调用Rule对象的setPattern方法并传递指定文本模式的字符串值来定义文本模式。
    • 通过调用Rule对象的setForm方法定义相应的表单设计。 传递一个字符串值,它指定表单设计的名称。
    注意

    对于要定义的每个文本模式,重复前三个子步骤。

    • 使用java.util.ArrayList构造函数创建java.util.List对象。
    • 对于您创建的每个Rule对象,调用java.util.List对象的add方法并传递Rule对象。
  5. 设置PDF运行时选项。

    • 使用PDFOutputOptionsSpec对象的构造函数创建对象。
    • 指定Output服务通过调用PDFOutputOptionsSpec对象的setFileURI方法生成的PDF文件的名称和位置。 传递一个指定PDF文件位置的字符串值。 “文件URI”选项是相对于承载AEM Forms的J2EE应用程序服务器,而不是客户端计算机。
    • 设置通过调用PDFOutputOptionsSpec对象的setRules方法定义的规则。 传递包含Rule对象的java.util.List对象。
    • 通过调用PDFOutputOptionsSpec对象的setLookAhead方法,设置要扫描的字节数以查找定义的文本模式。 传递一个表示字节数的整数值。
  6. 设置渲染运行时选项。

    • 使用RenderOptionsSpec对象的构造函数创建对象。
    • 通过调用RenderOptionsSpec对象的setCacheEnabled并传递true来缓存表单设计,以提高输出服务的性能。
  7. 生成PDF文档。

    通过调用OutputClient对象的generatePDFOutput方法并传递以下值,生成基于多个表单设计的PDF文档:

    • TransformationFormat明细列表值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定默认表单设计的名称。 即,在找不到文本图案时使用的表单设计。
    • 一个字符串值,它指定表单设计所在的内容根目录。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • com.adobe.idp.Document对象,它包含由Output服务搜索的表单数据以查找定义的文本模式。

    generatePDFOutput方法返回包含操作结果的OutputResult对象。

  8. 检索操作结果。

    • 通过调用OutputResult对象的getStatusDoc方法,创建一个表示generatePDFOutput方法状态的com.adobe.idp.Document对象。
    • 创建一个java.io.File对象,其中包含操作结果。 确保文件扩展名为.xml。
    • 调用com.adobe.idp.Document对象的copyToFile方法,将com.adobe.idp.Document对象的内容复制到文件(请确保使用由getStatusDoc方法返回的com.adobe.idp.Document对象)。

另请参阅

步骤摘要

快速开始(EJB模式):使用Java API创建搜索规则

快速开始(SOAP模式):使用Java API创建搜索规则

包括AEM Forms Java库文件

设置连接属性

使用Web服务API创建搜索规则

使用输出API(Web服务)创建搜索规则:

  1. 包括项目文件。

    创建使用MTOM的Microsoft .NET项目。 确保使用以下WSDL定义:http://localhost:8080/soap/services/OutputService?WSDL&lc_version=9.0.1

    注意

    localhost替换为承载AEM Forms的服务器的IP地址。

  2. 创建Output Client对象。

    • 使用OutputServiceClient对象的默认构造函数创建一个对象。

    • 使用System.ServiceModel.EndpointAddress构造函数创建OutputServiceClient.Endpoint.Address对象。 将指定WSDL的字符串值传递给AEM Forms服务(例如http://localhost:8080/soap/services/OutputService?blob=mtom)。 您无需使用lc_version属性。 在创建服务引用时使用此属性。 但是,请指定?blob=mtom以使用MTOM。

    • 通过获取OutputServiceClient.Endpoint.Binding字段的值,创建System.ServiceModel.BasicHttpBinding对象。 将返回值转换为BasicHttpBinding

    • System.ServiceModel.BasicHttpBinding对象的MessageEncoding字段设置为WSMessageEncoding.Mtom。 此值确保使用MTOM。

    • 通过执行以下任务,启用基本HTTP身份验证:

      • 为字段OutputServiceClient.ClientCredentials.UserName.UserName指定AEM表单用户名。
      • 为字段OutputServiceClient.ClientCredentials.UserName.Password分配相应的密码值。
      • 将常量值HttpClientCredentialType.Basic赋给字段BasicHttpBindingSecurity.Transport.ClientCredentialType
      • 将常量值BasicHttpSecurityMode.TransportCredentialOnly赋给字段BasicHttpBindingSecurity.Security.Mode
  3. 引用XML数据源。

    • 使用BLOB对象的构造函数创建对象。 BLOB对象用于存储将与PDF文档合并的数据。
    • 通过调用System.IO.FileStream对象的构造函数并传递一个字符串值来创建对象,该字符串值表示要加密的PDF文档的文件位置以及打开文件的模式。
    • 创建一个字节数组,用于存储System.IO.FileStream对象的内容。 可以通过获取System.IO.FileStream对象的Length属性来确定字节数组的大小。
    • 通过调用System.IO.FileStream对象的Read方法并传递要读取的字节数组、开始位置和流长度,用流数据填充字节数组。
    • BLOB对象的MTOM字段指定为字节数组的内容,从而填充该对象。
  4. 定义搜索规则。

    • 使用Rule对象的构造函数创建对象。
    • 通过为Rule对象的pattern数据成员指定指定文本模式的字符串值来定义文本模式。
    • 通过为Rule对象的form数据成员指定指定表单设计的字符串值来定义相应的表单设计。
    注意

    对于要定义的每个文本模式,重复前三个子步骤。

    • 创建存储规则的MyArrayOf_xsd_anyType对象。
    • 将每个Rule对象分配给MyArrayOf_xsd_anyType数组的元素。 为每个Rule对象调用MyArrayOf_xsd_anyType对象的Add方法。
  5. 设置PDF运行时选项

    • 使用PDFOutputOptionsSpec对象的构造函数创建对象。
    • 通过指定一个字符串值来设置文件URI选项,该字符串值指定Output服务生成的PDF文件到PDFOutputOptionsSpec对象的fileURI数据成员的位置。 “文件URI”选项是相对于承载AEM Forms的J2EE应用程序服务器,而不是客户端计算机。
    • 通过指定一个整数值来设置复制选项,该整数值指定输出服务为PDFOutputOptionsSpec对象的copies数据成员生成的复制数。
    • 设置通过将存储规则的MyArrayOf_xsd_anyType对象分配给PDFOutputOptionsSpec对象的rules数据成员来定义的规则。
    • 通过为PDFOutputOptionsSpec对象的lookAhead数据方法指定一个整数值,该整数值表示要扫描的字节数,从而设置要扫描的字节数以查找定义的文本模式。
  6. 设置渲染运行时选项

    • 使用RenderOptionsSpec对象的构造函数创建对象。
    • 缓存表单设计,以便通过将值true指定给RenderOptionsSpec对象的cacheEnabled数据成员来改进输出服务的性能。
    注意

    如果输入文档是Acrobat表单,则不能使用RenderOptionsSpec对象的pdfVersion成员设置PDF文档的版本。 输出PDF文档保留Acrobat表单的PDF版本。 同样,如果输入文档是Acrobat表单,则不能使用RenderOptionsSpec对象的taggedPDF方法设置加标签的PDF选项。

    注意

    如果输入的PDF文档经过认证或数字签名,则不能通过使用RenderOptionsSpec对象的linearizedPDF成员来设置线性化的PDF选项。 有关信息,请参阅对PDF文档进行数字签名

  7. 生成PDF文档

    通过调用OutputServiceService对象的generatePDFOutput方法并传递以下值,创建PDF文档:

    • TransformationFormat明细列表值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定表单设计的名称。
    • 一个字符串值,它指定表单设计所在的内容根。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • BLOB对象,它包含要与表单设计合并的数据的XML数据源。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用生成的描述该文档的元数据填充此对象。 (此参数值仅对Web服务调用是必需的)。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用结果数据填充此对象。 (此参数值仅对Web服务调用是必需的)。
    • 包含操作结果的OutputResult对象。 (此参数值仅对Web服务调用是必需的)。
    注意

    当通过调用generatePDFOutput方法生成PDF文档时,请注意,您无法将数据与已签名、已验证或包含使用权限的XFA PDF表单合并。 有关使用权限的信息,请参阅将使用权限应用于PDF文档

  8. 检索操作结果

    • 通过调用System.IO.FileStream对象的构造函数并传递一个字符串值来创建对象,该字符串值表示包含结果数据的XML文件位置。 确保文件扩展名为XML。
    • 创建一个字节数组,用于存储OutputServiceService对象的generatePDFOutput方法(第八个参数)用结果数据填充的BLOB对象的数据内容。 通过获取BLOB对象的MTOM数据成员的值来填充字节数组。
    • 通过调用其构造函数并传递System.IO.FileStream对象,创建System.IO.BinaryWriter对象。
    • 通过调用System.IO.BinaryWriter对象的Write方法并传递字节数组,将字节数组的内容写入XML文件。

另请参阅

步骤摘要

使用MTOM调用AEM Forms

使用SwaRef调用AEM Forms

拼合PDF文档

您可以使用“输出”服务将交互式PDF文档转换为非交互式PDF。 交互式PDF文档允许用户输入或修改PDF文档字段中的数据。 将交互式PDF文档转换为非交互式PDF文档的过程称为​拼合。 拼合PDF文档时,用户无法修改文档字段中的数据。 拼合PDF文档的一个原因是为了确保无法修改数据。

您可以拼合以下类型的PDF文档:

  • 交互式XFA PDF文档
  • Acrobat Forms

尝试拼合非交互式PDF文档的PDF会导致异常。

注意

有关输出服务的详细信息,请参阅AEM Forms的服务参考

步骤的摘要

要将交互式PDF文档拼合为非交互式PDF文档,请执行以下步骤:

  1. 包括项目文件。
  2. 创建Output Client对象。
  3. 检索交互式PDF文档。
  4. 转换PDF文档。
  5. 将非交互式PDF文档另存为PDF文件。

包括项目文件

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

必须将以下JAR文件添加到项目的类路径中:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-output-client.jar
  • adobe-utilities.jar(在JBoss上部署AEM Forms时为必需)
  • jbossall-client.jar(如果在JBoss上部署了AEM Forms,则为必需)

如果AEM Forms部署在非JBoss的受支持J2EE应用程序服务器上,则需要将adobe-utilities.jar和jbossall-client.jar文件替换为特定于部署AEM Forms的J2EE应用程序服务器的JAR文件。 有关所有AEM Forms JAR文件位置的信息,请参阅包括AEM Forms Java库文件

创建Output Client对象

在以编程方式执行输出服务操作之前,必须创建输出服务客户端对象。 如果您使用Java API,请创建OutputClient对象。 如果您使用Output Web服务API,请创建OutputServiceService对象。

检索交互式PDF文档

检索要转换为非交互式PDF文档的交互式PDF文档。 尝试转换非交互式PDF文档会导致异常。

转换PDF文档

检索交互式PDF文档后,可以将其转换为非交互式PDF文档。 输出服务返回非交互式PDF文档。

将非交互式PDF文档另存为PDF文件

可以将非交互式PDF文档另存为PDF文件。

另请参阅

使用Java API拼合PDF文档

使用Web服务API拼合PDF文档

包括AEM Forms Java库文件

设置连接属性

输出服务API快速开始

使用Java API拼合PDF文档

使用输出API(Java)将交互式PDF文档拼合到非交互式PDF文档:

  1. 包括项目文件。

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

  2. 创建Output Client对象。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用OutputClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
  3. 检索交互式PDF文档。

    • 创建一个java.io.FileInputStream对象,它使用其构造函数并传递一个字符串值来表示要转换的交互式PDF文档,该字符串值指定交互式PDF文件的位置。
    • 使用com.adobe.idp.Document对象的构造函数并传递java.io.FileInputStream对象,创建对象。
  4. 转换PDF文档。

    调用OutputServiceService对象的transformPDF方法并传递以下值,将交互式PDF文档转换为非交互式PDF文档:

    • 包含交互式PDF文档的com.adobe.idp.Document对象。
    • TransformationFormat枚举值。 要生成非交互式PDF文档,请指定TransformationFormat.PDF
    • 一个PDFARevisionNumber枚举值,它指定修订号。 由于此参数适用于PDF/A文档,因此可以指定null
    • 一个字符串值,它表示修改编号和年份,以冒号分隔。 由于此参数适用于PDF/A文档,因此可以指定null
    • 一个PDFAConformance枚举值,它表示PDF/A符合性级别。 由于此参数适用于PDF/A文档,因此可以指定null

    transformPDF方法返回一个com.adobe.idp.Document对象,该对象包含非交互式PDF文档。

  5. 将非交互式PDF文档另存为PDF文件。

    • 创建一个java.io.File对象,并确保文件扩展名为.pdf。
    • 调用Document对象的copyToFile方法,将Document对象的内容复制到文件(请确保使用由transformPDF方法返回的Document对象)。

另请参阅

步骤摘要

快速开始(EJB模式):使用Java API转换PDF文档

快速开始(SOAP模式):使用Java API转换PDF文档

包括AEM Forms Java库文件

设置连接属性

使用Web服务API拼合PDF文档

使用输出API(Web服务)将交互式PDF文档拼合到非交互式PDF文档:

  1. 包括项目文件。

    创建使用MTOM的Microsoft .NET项目。 确保使用以下WSDL定义:http://localhost:8080/soap/services/OutputService?WSDL&lc_version=9.0.1

    注意

    localhost替换为承载AEM Forms的服务器的IP地址。

  2. 创建Output Client对象。

    • 使用OutputServiceClient对象的默认构造函数创建一个对象。

    • 使用System.ServiceModel.EndpointAddress构造函数创建OutputServiceClient.Endpoint.Address对象。 将指定WSDL的字符串值传递给AEM Forms服务(例如http://localhost:8080/soap/services/OutputService?blob=mtom)。 您无需使用lc_version属性。 在创建服务引用时使用此属性。 但是,请指定?blob=mtom以使用MTOM。

    • 通过获取OutputServiceClient.Endpoint.Binding字段的值,创建System.ServiceModel.BasicHttpBinding对象。 将返回值转换为BasicHttpBinding

    • System.ServiceModel.BasicHttpBinding对象的MessageEncoding字段设置为WSMessageEncoding.Mtom。 此值确保使用MTOM。

    • 通过执行以下任务,启用基本HTTP身份验证:

      • 为字段OutputServiceClient.ClientCredentials.UserName.UserName指定AEM表单用户名。
      • 为字段OutputServiceClient.ClientCredentials.UserName.Password分配相应的密码值。
      • 将常量值HttpClientCredentialType.Basic赋给字段BasicHttpBindingSecurity.Transport.ClientCredentialType
      • 将常量值BasicHttpSecurityMode.TransportCredentialOnly赋给字段BasicHttpBindingSecurity.Security.Mode
  3. 检索交互式PDF文档。

    • 使用BLOB对象的构造函数创建对象。 BLOB对象用于存储交互式PDF文档。
    • 通过调用System.IO.FileStream对象的构造函数并传递一个字符串值,该字符串值表示交互式PDF文档的文件位置。
    • 创建一个字节数组,用于存储System.IO.FileStream对象的内容。 可以通过获取System.IO.FileStream对象的Length属性来确定字节数组的大小。
    • 通过调用System.IO.FileStream对象的Read方法并传递要读取的字节数组、开始位置和流长度,用流数据填充字节数组。
    • 通过将MTOM属性赋予字节数组的内容,填充BLOB对象。
  4. 转换PDF文档。

    调用OutputClient对象的transformPDF方法并传递以下值,将交互式PDF文档转换为非交互式PDF文档:

    • 包含交互式PDF文档的BLOB对象。
    • TransformationFormat明细列表值。 要生成非交互式PDF文档,请指定TransformationFormat.PDF
    • 一个PDFARevisionNumber枚举值,它指定修订号。
    • 一个布尔值,它指定是否使用PDFARevisionNumber枚举值。 由于此参数适用于PDF/A文档,因此可以指定false
    • 一个字符串值,它表示修改编号和年份,以冒号分隔。 由于此参数适用于PDF/A文档,因此可以指定null
    • 一个PDFAConformance枚举值,它表示PDF/A符合性级别。
    • 指定是否使用PDFAConformance枚举值的布尔值。 由于此参数适用于PDF/A文档,因此可以指定false

    transformPDF方法返回一个BLOB对象,该对象包含非交互式PDF文档。

  5. 将非交互式PDF文档另存为PDF文件。

    • 通过调用System.IO.FileStream对象的构造函数并传递一个字符串值来创建一个对象,该字符串值表示非交互式PDF文档的文件位置。
    • 创建一个字节数组,用于存储transformPDF方法返回的BLOB对象的数据内容。 通过获取BLOB对象的MTOM数据成员的值来填充字节数组。
    • 通过调用其构造函数并传递System.IO.FileStream对象,创建System.IO.BinaryWriter对象。
    • 通过调用System.IO.BinaryWriter对象的Write方法并传递字节数组,将字节数组的内容写入PDF文件。

另请参阅

步骤摘要

使用MTOM调用AEM Forms

使用SwaRef调用AEM Forms

在此页面上