创建文档输出流 creating-document-output-streams

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

关于输出服务

使用“输出”服务,可以将文档输出为PDF(包括PDF/A文档)、PostScript、打印机控制语言(PCL)以及以下标签格式:

  • 斑马 — ZPL
  • Intermec - IPL
  • Datamax - DPL
  • TecToshiba - TPCL

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

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

NOTE
Output服务不支持包含应用程序对象特定脚本的AcroformPDF文档。 包含应用程序对象特定脚本的AcroformPDF文档不会渲染。

以下部分将演示如何使用URI值将表单设计传递到Output服务:

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

在决定使用哪种技术时,需要考虑的一个事项是,如果您从另一个AEM Forms服务获取表单设计,然后在com.adobe.idp.Document实例中传递它。 将文档传递到输出服务 ​和​ 使用片段创建PDF文档 ​部分都显示了如何从另一个AEM Forms服务获取表单设计。 第一部分从内容服务中检索表单设计(已弃用)。 第二部分从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方法。

您可以使用Output服务完成这些任务:

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

创建PDF文档 creating-pdf-documents

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

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

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

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

步骤摘要 summary-of-steps

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

  1. 包括项目文件。
  2. 创建输出客户端对象。
  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部署在受支持的J2EE应用程序服务器而不是JBoss上,则必须将adobe-utilities.jar和jbossall-client.jar文件替换为特定于已部署AEM Forms的J2EE应用程序服务器的JAR文件。

创建输出客户端对象

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

引用XML数据源

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

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

cp_cp_loanformdata

要将数据合并到此表单设计,必须创建与表单相对应的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选项。 此选项指定Output服务生成的PDF文件的名称和位置。

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

设置渲染运行时选项

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

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

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

生成PDF文档

在引用包含表单数据的有效XML数据源并设置运行时选项后,可以调用Output服务,从而生成PDF文档。

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

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/中。

NOTE
调用OutputClient对象的generatePDFOutputgeneratePrintedOutput方法时,您可以引用Forms应用程序URI。
NOTE
要查看通过引用Forms应用程序中的XDP来创建PDF文档的完整快速入门,请参阅快速入门(EJB模式):使用Java API基于应用程序XDP文件创建PDF文档

检索操作的结果

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

另请参阅

使用Java API创建PDF文档

使用Web服务API创建PDF文档

包括AEM Forms Java库文件

设置连接属性

输出服务API快速启动

使用Java API创建PDF文档 create-a-pdf-document-using-the-java-api

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

  1. 包括项目文件。

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

  2. 创建输出客户端对象。

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

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

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

    • 使用构造函数创建RenderOptionsSpec对象。
    • 通过调用RenderOptionsSpec对象的setCacheEnabled并传递true,缓存表单设计以提高输出服务的性能。
    note note
    NOTE
    如果输入文档是Acrobat表单(在Acrobat中创建的表单)或已签名或认证的XFA文档,则无法使用RenderOptionsSpec对象的setPdfVersion方法设置PDF文档的版本。 输出PDF文档保留原始PDF版本。 同样,如果输入文档是Acrobat表单或已签名或认证的XFA文档,则无法通过调用RenderOptionsSpec对象的setTaggedPDF方法来设置已标记的Adobe PDF选项。
    note note
    NOTE
    如果输入PDF文档经过验证或数字签名,则不能使用RenderOptionsSpec对象的setLinearizedPDF方法设置线性化PDF选项。 (请参阅对PDF文档进行数字签名​。)
  6. 生成PDF文档。

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

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

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

    note note
    NOTE
    通过调用generatePDFOutput方法生成PDF文档时,不能将数据与已签署或已验证的XFAPDF表单合并。 (请参阅对文档进行数字签名和认证​。)
    note note
    NOTE
    OutputResult对象的getRecordLevelMetaDataList方法返回​null.
    note note
    NOTE
    您还可以通过调用OutputClient对象的generatePDFOutput2方法创建PDF文档。 (请参阅将Content Services中的文档(已弃用)传递给输出服务​。)
  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文档 create-a-pdf-document-using-the-web-service-api

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

  1. 包括项目文件。

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

    note note
    NOTE
    localhost替换为承载AEM Forms的服务器的IP地址。
  2. 创建输出客户端对象。

    • 使用默认构造函数创建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身份验证:

      • 将AEM表单用户名分配给字段OutputServiceClient.ClientCredentials.UserName.UserName
      • 将相应的密码值分配给字段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方法并传递要读取的字节数组、起始位置和流长度,使用流数据填充字节数组。
    • 使用字节数组的内容分配其MTOM字段以填充BLOB对象。
  4. 设置PDF运行时选项

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

    • 使用构造函数创建RenderOptionsSpec对象。
    • 缓存表单设计以通过将true值分配给RenderOptionsSpec对象的cacheEnabled数据成员来提高Output服务的性能。
    note note
    NOTE
    如果输入文档是Acrobat表单(在Acrobat中创建的表单)或已签名或认证的XFA文档,则无法使用RenderOptionsSpec对象的setPdfVersion方法设置PDF文档的版本。 输出PDF文档保留原始PDF版本。 同样,如果输入文档是Acrobat表单或已签名或认证的XFA文档,则通过调用RenderOptionsSpec对象的setTaggedPDF方法无法设置已标记Adobe PDF选项。
    note note
    NOTE
    如果输入PDF文档经过认证或数字签名,则不能使用RenderOptionsSpec对象的linearizedPDF成员来设置线性化PDF选项。 (请参阅对PDF文档进行数字签名​。)
  6. 生成PDF文档。

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

    • TransformationFormat枚举值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定窗体设计的名称。
    • 一个字符串值,它指定表单设计所在的内容根。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • 包含要与表单设计合并的数据的XML数据源的BLOB对象。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用所生成的描述文档的元数据填充此对象。 (只有Web服务调用才需要此参数值)。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用结果数据填充此对象。 (只有Web服务调用才需要此参数值)。
    • 包含操作结果的OutputResult对象。 (只有Web服务调用才需要此参数值)。
    note note
    NOTE
    通过调用generatePDFOutput方法生成PDF文档时,不能将数据与已签署或已验证的XFAPDF表单合并。 (请参阅对文档进行数字签名和认证​。)
    note note
    NOTE
    您还可以通过调用OutputClient对象的generatePDFOutput2方法创建PDF文档。 (请参阅将Content Services中的文档(已弃用)传递给输出服务​。)
  7. 检索操作的结果。

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

    另请参阅

步骤摘要

使用MTOM调用AEM Forms

使用SwaRef调用AEM Forms

NOTE
已弃用OutputServiceService对象的generateOutput方法。

创建PDF/A文档 creating-pdf-a-documents

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

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/合规性。)

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

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

cp_cp_pdfamessage

NOTE
AIIM网站有可在https://www.loc.gov/preservation/digital/formats/fdd/fdd000125.shtml访问的PDF/常见问题解答部分。
NOTE
有关Output服务的详细信息,请参阅AEM Forms的服务参考

步骤摘要 summary_of_steps-1

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

  1. 包括项目文件。
  2. 创建输出客户端对象。
  3. 引用XML数据源。
  4. 设置PDF/A运行时选项。
  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部署在受支持的J2EE应用程序服务器而不是JBoss上,则必须将adobe-utilities.jar和jbossall-client.jar文件替换为特定于已部署AEM Forms的J2EE应用程序服务器的JAR文件。

创建输出客户端对象

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

引用XML数据源

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

设置PDF/A运行时选项

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

设置渲染运行时选项

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

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

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

生成PDF/文档

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

检索操作的结果

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

另请参阅

使用Java API创建PDF/文档

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

包括AEM Forms Java库文件

设置连接属性

输出服务API快速启动

使用Java API创建PDF/文档 create-a-pdf-a-document-using-the-java-api

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

  1. 包括项目文件。

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

  2. 创建输出客户端对象。

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

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

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

    • 使用构造函数创建RenderOptionsSpec对象。
    • 通过调用RenderOptionsSpec对象的setPDFAConformance方法并传递指定一致性级别的PDFAConformance枚举值来设置PDFAConformance值。 例如,要指定一致性级别A,请传递PDFAConformance.A
    • 通过调用RenderOptionsSpec对象的setPDFARevisionNumber方法并传递PDFARevisionNumber.Revision_1来设置PDFARevisionNumber值。
    note note
    NOTE
    PDF/A文档的PDF版本是1.4,无论您为RenderOptionsSpec对象的​setPdfVersion方法指定哪个值。
  6. 生成PDF/文档。

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

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

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

    note note
    NOTE
    OutputResult对象的getRecordLevelMetaDataList方法返回null
    note note
    NOTE
    您还可以通过调用OutputClient对象的generatePDFOutput2方法创建PDF/A文档。 (请参阅将Content Services中的文档(已弃用)传递给输出服务。)
  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对象)。
    note note
    NOTE
    虽然Output服务将PDF/A文档写入传递给PDFOutputOptionsSpec对象的setFileURI方法的参数指定的位置,但可以通过调用OutputResult对象的getGeneratedDoc方法以编程方式检索PDF/A文档。

另请参阅

步骤摘要

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

包括AEM Forms Java库文件

正在设置连接属性

使用Web服务API创建PDF/文档 create-a-pdf-a-document-using-the-web-service-api

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

  1. 包括项目文件。

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

    note note
    NOTE
    localhost替换为承载AEM Forms的服务器的IP地址。
  2. 创建输出客户端对象。

    • 使用默认构造函数创建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身份验证:

      • 将AEM表单用户名分配给字段OutputServiceClient.ClientCredentials.UserName.UserName
      • 将相应的密码值分配给字段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选项,该字符串值指定输出服务生成到PDFOutputOptionsSpec对象的fileURI数据成员的PDF文件的位置。 文件URI选项相对于托管AEM Forms的J2EE应用程序服务器,而不是客户端计算机
  5. 设置渲染运行时选项。

    • 使用构造函数创建RenderOptionsSpec对象。
    • 通过为RenderOptionsSpec对象的PDFAConformance数据成员分配PDFAConformance枚举值来设置PDFAConformance值。 例如,要指定一致性级别A,请将PDFAConformance.A分配给此数据成员。
    • 通过为RenderOptionsSpec对象的PDFARevisionNumber数据成员分配PDFARevisionNumber枚举值来设置PDFARevisionNumber值。 将PDFARevisionNumber.Revision_1分配给此数据成员。
    note note
    NOTE
    无论您指定哪个值,PDF/A文档的PDF版本均为1.4。
  6. 生成PDF/文档。

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

    • TransformationFormat枚举值。 要生成PDF文档,请指定TransformationFormat.PDFA
    • 一个字符串值,它指定窗体设计的名称。
    • 一个字符串值,它指定表单设计所在的内容根。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • 包含要与表单设计合并的数据的XML数据源的BLOB对象。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用所生成的描述文档的元数据填充此对象。 (只有Web服务调用才需要此参数值。)
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用结果数据填充此对象。 (只有Web服务调用才需要此参数值。)
    • 包含操作结果的OutputResult对象。 (只有Web服务调用才需要此参数值。)
    note note
    NOTE
    您还可以通过调用OutputClient对象的generatePDFOutput2方法创建PDF/A文档。 (请参阅将Content Services中的文档(已弃用)传递给输出服务。)
  7. 检索操作的结果。

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

另请参阅

步骤摘要

使用MTOM调用AEM Forms

使用SwaRef调用AEM Forms

将Content Services中的文档(已弃用)传递到Output Service passing-documents-located-in-content-services-deprecated-to-the-output-service

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

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

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

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

步骤摘要 summary_of_steps-2

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

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

包含项目文件

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

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

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

从内容服务检索表单设计(已弃用)

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

渲染非交互式PDF表单

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

NOTE
名为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将文档传递到输出服务 pass-documents-to-the-output-service-using-the-java-api

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

  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对象。
    • 包含要与表单设计合并的数据的XML数据源的com.adobe.idp.Document对象。

    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将文档传递到Output Service

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

包括AEM Forms Java库文件

设置连接属性

使用Web服务API将文档传递到输出服务 pass-documents-to-the-output-service-using-the-web-service-api

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

  1. 包括项目文件。

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

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

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

    note note
    NOTE
    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身份验证:

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

    note note
    NOTE
    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对象(使用内容服务返回的BLOB实例(已弃用))。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • 包含要与表单设计合并的数据的XML数据源的BLOB对象。
    • generatePDFOutput2方法填充的输出BLOB对象。 generatePDFOutput2方法使用所生成的描述文档的元数据填充此对象。 (只有Web服务调用才需要此参数值)。
    • 包含操作结果的输出OutputResult对象。 (只有Web服务调用才需要此参数值)。

    generatePDFOutput2方法返回包含非交互式PDF表单的BLOB对象。

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

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

另请参阅

步骤摘要

使用MTOM调用AEM Forms

将存储库中的文档传递到Output服务 passing-documents-located-in-the-repository-to-the-output-service

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

com.adobe.idp.Document对象传递给输出服务的好处是,其他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对象中的输出服务。

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

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

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

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

步骤摘要 summary_of_steps-3

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

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

包含项目文件

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

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

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

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

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

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

渲染非交互式PDF表单

要呈现非交互式表单,请传递使用AEM Forms存储库API返回的com.adobe.idp.Document实例。

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

对表单数据流执行操作

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

另请参阅

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

包括AEM Forms Java库文件

设置连接属性

输出服务API快速启动

ResourceRepositoryClient

使用Java API将存储库中的文档传递到输出服务 pass-documents-located-in-the-repository-to-the-output-service-using-the-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对象。
    • 包含要与表单设计合并的数据的XML数据源的com.adobe.idp.Document对象。

    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存储库中的文档传递到Output服务

包括AEM Forms Java库文件

设置连接属性

使用片段创建PDF文档 creating-pdf-documents-using-fragments

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

下图显示了此工作流。

cp_cp_outputassemblegrations

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

NOTE
您还可以将由Assembler服务组装的表单设计传递到Forms服务,而不是输出服务。 Output服务和Forms服务的主要区别在于Forms服务生成交互式PDF文档,而Output服务生成非交互式PDF文档。 此外,Forms服务无法生成ZPL等基于打印机的输出流。
NOTE
有关Output服务的详细信息,请参阅AEM Forms的服务参考

步骤摘要 summary_of_steps-4

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

  1. 包括项目文件。
  2. 创建Output and Assembler客户端对象。
  3. 使用Assembler服务生成表单设计。
  4. 使用Output服务生成PDF文档。
  5. 将PDF文档另存为PDF文件。

包含项目文件

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

创建输出和汇编程序客户端对象

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

使用Assembler服务生成窗体设计

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

使用输出服务生成PDF文档

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

将PDF文档另存为PDF文件

在Output服务生成PDF文档之后,可以将其另存为PDF文件。

另请参阅

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

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

包括AEM Forms Java库文件

设置连接属性

输出服务API快速启动

组装多个XDP片段

创建PDF文档

使用Java API基于片段创建PDF文档 create-a-pdf-document-based-on-fragments-using-the-java-api

使用输出服务API和汇编程序服务API (Java)基于片段创建PDF文档:

  1. 包括项目文件。

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

  2. 创建Output and Assembler客户端对象。

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

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

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

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

    • 调用AssemblerResult对象的getDocuments方法。 此方法返回java.util.Map对象。
    • 反复查找java.util.Map对象,直到找到结果com.adobe.idp.Document对象。
    • 调用com.adobe.idp.Document对象的copyToFile方法以提取装配的XDP文档。
  4. 使用Output服务生成PDF文档。

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

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

    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文档 create-a-pdf-document-based-on-fragments-using-the-web-service-api

使用输出服务API和汇编程序服务API(Web服务),基于片段创建PDF文档:

  1. 包括项目文件。

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

    code language-java
     http://localhost:8080/soap/services/OutputService?WSDL&lc_version=9.0.1.
    

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

    code language-java
     http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1.
    

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

    note note
    NOTE
    localhost替换为承载AEM Forms的服务器的IP地址。
  2. 创建Output and Assembler客户端对象。

    • 使用默认构造函数创建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身份验证:

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

    note note
    NOTE
    AssemblerServiceClient对象重复这些步骤。
  3. 使用Assembler服务生成表单设计。

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

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

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

    • 访问AssemblerResult对象的documents字段,该字段是包含生成PDF文档的Map对象。
    • 循环访问Map对象以检索组合表单设计。 将该数组成员的value强制转换为BLOB。 将此BLOB实例传递到输出服务。
  4. 使用Output服务生成PDF文档。

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

    • TransformationFormat枚举值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定其他资源(如图像)所在的内容根。
    • 表示表单设计的BLOB对象(使用汇编程序服务返回的BLOB实例)。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • 包含要与表单设计合并的数据的XML数据源的BLOB对象。
    • generatePDFOutput2方法填充的输出BLOB对象。 generatePDFOutput2方法使用所生成的描述文档的元数据填充此对象。 (只有Web服务调用才需要此参数值)。
    • 包含操作结果的输出OutputResult对象。 (只有Web服务调用才需要此参数值)。

    generatePDFOutput2方法返回包含非交互式PDF表单的BLOB对象。

  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

打印到文件 printing-to-files

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

  • 斑马 — ZPL
  • Intermec - IPL
  • Datamax - DPL
  • TecToshiba - TPCL

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

NOTE
有关将打印流发送到打印机的信息,请参阅将打印流发送到打印机
NOTE
有关Output服务的详细信息,请参阅AEM Forms的服务参考

步骤摘要 summary_of_steps-5

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

  1. 包括项目文件。
  2. 创建输出客户端对象。
  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部署在受支持的J2EE应用程序服务器而不是JBoss上,则必须将adobe-utilities.jar和jbossall-client.jar文件替换为特定于已部署AEM Forms的J2EE应用程序服务器的JAR文件。 (请参阅包括AEM Forms Java库文件。)

创建输出客户端对象

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

引用XML数据源

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

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

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

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

将打印流打印到文件

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

检索操作的结果

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

另请参阅

使用Java API打印到文件

使用Web服务API打印到文件

包括AEM Forms Java库文件

设置连接属性

输出服务API快速启动

使用Java API打印到文件 print-to-files-using-the-java-api

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

  1. 包括项目文件。

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

  2. 创建输出客户端对象。

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

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

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

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

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

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

    note note
    NOTE
    OutputResult对象的getRecordLevelMetaDataList方法返回null
  6. 检索操作的结果。

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

另请参阅

步骤摘要

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

包括AEM Forms Java库文件

正在设置连接属性

使用Web服务API打印到文件 print-to-files-using-the-web-service-api

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

  1. 包括项目文件。

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

    note note
    NOTE
    localhost替换为承载AEM Forms的服务器的IP地址。
  2. 创建输出客户端对象。

    • 使用默认构造函数创建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身份验证:

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

    • 使用构造函数创建BLOB对象。 BLOB对象用于存储表单数据。
    • 通过调用其构造函数并传递一个字符串值(指定包含表单数据的XML文件的位置)创建System.IO.FileStream对象。
    • 创建用于存储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对象。
    • 包含包含表单数据的XML数据源的BLOB对象。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用所生成的描述文档的元数据填充此对象。 (只有Web服务调用才需要此参数值。)
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用结果数据填充此对象。 (只有Web服务调用才需要此参数值。)
    • 包含操作结果的OutputResult对象。 (只有Web服务调用才需要此参数值。)
  6. 检索操作的结果。

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

另请参阅

步骤摘要

使用MTOM调用AEM Forms

使用SwaRef调用AEM Forms

将打印流发送到打印机 sending-print-streams-to-printers

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

  • 斑马 — ZPL
  • Intermec - IPL
  • Datamax - DPL
  • TecToshiba - TPCL

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

NOTE
为了演示如何将打印流发送到网络打印机,本节使用SharedPrinter打印机协议将PostScript打印流发送到网络打印机。
NOTE
有关Output服务的详细信息,请参阅AEM Forms的服务参考

步骤摘要 summary_of_steps-6

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

  1. 包括项目文件。
  2. 创建输出客户端对象。
  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部署在受支持的J2EE应用程序服务器而不是JBoss上,则必须将adobe-utilities.jar和jbossall-client.jar文件替换为特定于已部署AEM Forms的J2EE应用程序服务器的JAR文件。

创建输出客户端对象

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

引用XML数据源

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

设置打印运行时选项

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

  • 份数:指定要发送到打印机的份数。 默认值为 1。
  • 装订:使用装订器时设置了XCI选项。 此选项可通过装订元素在配置模型中指定,仅用于PS和PCL打印机。
  • OutputJog:当输出页应进行角拐(在输出托盘中物理移位)时,设置了XCI选项。 此选项仅适用于PS和PCL打印机。
  • OutputBin: XCI值,用于使打印驱动程序选择适当的输出纸盒。
NOTE
有关可设置的所有运行时选项的信息,请参阅PrintedOutputOptionsSpec类引用。

检索要打印的文档

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

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

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

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

打印格式
描述
DPL
默认或自定义xdc输出流创建dpl203.xdc。
DPL300DPI
创建DPL 300 DPI输出流。
DPL406DPI
创建DPL 400 DPI输出流。
DPL600DPI
创建DPL 600 DPI输出流。
GenericColorPCL
创建通用颜色PCL (5c)输出流。
GenericPSLevel3
创建通用PostScript Level 3输出流。
IPL
创建自定义IPL输出流。
IPL300DPI
创建IPL 300 DPI输出流。
IPL400DPI
创建IPL 400 DPI输出流。
PCL
创建通用单色PCL (5e)输出流。
PostScript
创建通用PostScript Level 2输出流。
TPCL
创建自定义TPCL输出流。
TPCL305DPI
创建TPCL 305 DPI输出流。
TPCL600DPI
创建TPCL 600 DPI输出流。
ZPL
创建ZPL 203 DPI输出流。
ZPL300DPI
创建ZPL 300 DPI输出流。
NOTE
您还可以使用generatePrintedOutput2方法将打印流发送到打印机。 但是,与“将打印流发送到打印机”部分关联的快速启动使用generatePrintedOutput方法。

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

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

NOTE
如果PDFG安装在Forms Server上并且服务器在Windows Server 2008上运行,则无法使用SharedPrinter属性。 在这种情况下,请使用不同的打印机协议。
NOTE
如果您使用的是网络打印机,并且访问机制为SharedPrinter,则需要指定打印机的完整网络路径。使用Java API将打印流发送到网络打印机

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

  1. 包括项目文件。

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

  2. 创建输出客户端对象

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

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

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

    note note
    NOTE
    如果要生成ZPL打印流,则无法使用PrintedOutputOptionsSpec对象的setPagination方法设置分页值。 同样,不能为ZPL打印流设置下列选项: OutputJog、PageOffset和Staple。 setPagination方法对于PostScript生成无效。 它仅对PCL生成有效。
  5. 检索要打印的文档

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

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

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

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

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

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

    • 表示要发送到打印机的打印流的com.adobe.idp.Document对象。
    • 指定要使用的打印机协议的PrinterProtocol枚举值。 例如,若要指定SharedPrinter协议,请传递PrinterProtocol.SharedPrinter
    • 一个字符串值,它指定打印服务器的名称。 例如,假定打印服务器的名称为PrintSever1,请传递\\\PrintSever1
    • 指定打印机名称的字符串值。 例如,假定打印机的名称为Printer1,请传递\\\PrintSever1\Printer1
    note note
    NOTE
    sendToPrinter方法已添加到8.2.1版的AEM Forms API中。

使用Web服务API将打印流发送到打印机 send-a-print-stream-to-a-printer-using-the-web-service-api

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

  1. 包括项目文件。

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

    note note
    NOTE
    localhost替换为承载AEM Forms的服务器的IP地址。
  2. 创建输出客户端对象。

    • 使用默认构造函数创建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身份验证:

      • 将AEM表单用户名分配给字段OutputServiceClient.ClientCredentials.UserName.UserName
      • 将相应的密码值分配给字段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方法并传递要读取的字节数组、起始位置和流长度,使用流数据填充字节数组。
    • 使用字节数组的内容分配其MTOM字段以填充BLOB对象。
  4. 设置打印运行时选项。

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

    note note
    NOTE
    如果要生成ZPL打印流,则无法使用PrintedOutputOptionsSpec对象的pagination数据成员设置分页值。 同样,不能为ZPL打印流设置以下选项:OutputJog、PageOffset和Staple。 pagination数据成员对于PostScript生成无效。 它仅对PCL生成有效。
  5. 检索要打印的文档。

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

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

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

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

    • 表示要发送到打印机的打印流的BLOB对象。
    • 指定要使用的打印机协议的PrinterProtocol枚举值。 例如,若要指定SharedPrinter协议,请传递PrinterProtocol.SharedPrinter
    • 一个bool值,它指定是否使用上一个参数值。 传递值true。 (只有Web服务调用才需要此参数值。)
    • 一个字符串值,它指定打印服务器的名称。 例如,假定打印服务器的名称为PrintSever1,请传递\\\PrintSever1
    • 指定打印机名称的字符串值。 例如,假定打印机的名称为Printer1,请传递\\\PrintSever1\Printer1
    note note
    NOTE
    sendToPrinter方法已添加到8.2.1版的AEM Forms API中。

创建多个输出文件 creating-multiple-output-files

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

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

下图显示了处理包含多个记录的XML数据文件的Output服务。 假设您指示Output服务为每个数据记录创建一个单独的PDF文档。 在这种情况下,Output服务将为每个数据记录生成单独的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元素由生成多个文件的应用程序逻辑引用。

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

步骤摘要 summary_of_steps-7

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

  1. 包括项目文件。
  2. 创建输出客户端对象。
  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部署在受支持的J2EE应用程序服务器而不是JBoss上,则必须将adobe-utilities.jar和jbossall-client.jar文件替换为特定于已部署AEM Forms的J2EE应用程序服务器的JAR文件。

创建输出客户端对象

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

引用XML数据源

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

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

设置PDF运行时选项

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

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

设置渲染运行时选项

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

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

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

生成多个PDF文件

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

检索操作的结果

Output服务执行操作后,会返回用于指定操作是否成功的XML数据。 Output服务返回以下XML。 在这种情况下,Output服务产生了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文件 create-multiple-pdf-files-using-the-java-api

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

  1. 包括项目文件”

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

  2. 创建输出客户端对象

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

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

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

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

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

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

    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文件 create-multiple-pdf-files-using-the-web-service-api

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

  1. 包括项目文件。

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

    note note
    NOTE
    localhost替换为承载AEM Forms的服务器的IP地址。
  2. 创建输出客户端对象。

    • 使用默认构造函数创建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身份验证:

      • 将AEM表单用户名分配给字段OutputServiceClient.ClientCredentials.UserName.UserName
      • 将相应的密码值分配给字段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方法并传递要读取的字节数组、起始位置和流长度,使用流数据填充字节数组。
    • 使用字节数组的内容分配其MTOM字段以填充BLOB对象。
  4. 设置PDF运行时选项。

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

    • 使用构造函数创建RenderOptionsSpec对象。
    • 缓存表单设计以通过将true值分配给RenderOptionsSpec对象的cacheEnabled数据成员来提高Output服务的性能。
  6. 生成多个PDF文件。

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

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

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

另请参阅

步骤摘要

使用MTOM调用AEM Forms

使用SwaRef调用AEM Forms

创建搜索规则 creating-search-rules

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

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

cs_outputbatchmanyformdesigns2

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

步骤摘要 summary_of_steps-8

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

  1. 包括项目文件。
  2. 创建输出客户端对象。
  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部署在受支持的J2EE应用程序服务器(不是JBoss)上,则必须将adobe-utilities.jar和jbossall-client.jar替换为特定于部署AEM Forms的J2EE应用程序服务器的JAR文件。

创建输出客户端对象

必须先创建输出服务客户端对象,然后才能以编程方式执行输出服务操作。

引用XML数据源

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

定义搜索规则

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

NOTE
如果找不到文本模式,则使用默认表单。 确保使用的所有表单设计都位于内容根中。

设置PDF运行时选项

设置以下PDF运行时选项,以便Output服务基于多个表单设计成功创建PDF文档:

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

设置渲染运行时选项

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

生成PDF文档

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

检索操作的结果

Output服务执行操作后,会返回用于指定操作是否成功的XML数据。

另请参阅

包括AEM Forms Java库文件

设置连接属性

输出服务API快速启动

使用Java API创建搜索规则 create-search-rules-using-the-java-api

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

  1. 包括项目文件。

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

  2. 创建输出客户端对象。

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

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

    • 使用构造函数创建Rule对象。
    • 通过调用Rule对象的setPattern方法并传递指定文本模式的字符串值来定义文本模式。
    • 通过调用Rule对象的setForm方法定义相应的表单设计。 传递一个指定窗体设计名称的字符串值。
    note note
    NOTE
    对于要定义的每个文本模式,重复前三个子步骤。
    • 使用java.util.ArrayList构造函数创建java.util.List对象。
    • 对于您创建的每个Rule对象,调用java.util.List对象的add方法并传递Rule对象。
  5. 设置PDF运行时选项。

    • 使用构造函数创建PDFOutputOptionsSpec对象。
    • 指定输出服务通过调用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对象。

    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创建搜索规则 create-search-rules-using-the-web-service-api

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

  1. 包括项目文件。

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

    note note
    NOTE
    localhost替换为承载AEM Forms的服务器的IP地址。
  2. 创建输出客户端对象。

    • 使用默认构造函数创建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身份验证:

      • 将AEM表单用户名分配给字段OutputServiceClient.ClientCredentials.UserName.UserName
      • 将相应的密码值分配给字段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方法并传递要读取的字节数组、起始位置和流长度,使用流数据填充字节数组。
    • 使用字节数组的内容分配其MTOM字段以填充BLOB对象。
  4. 定义搜索规则。

    • 使用构造函数创建Rule对象。
    • 通过为Rule对象的pattern数据成员指定指定文本模式的字符串值来定义文本模式。
    • 通过为Rule对象的form数据成员指定指定窗体设计的字符串值来定义相应的窗体设计。
    note note
    NOTE
    对于要定义的每个文本模式,重复前三个子步骤。
    • 创建用于存储规则的MyArrayOf_xsd_anyType对象。
    • 将每个Rule对象分配给MyArrayOf_xsd_anyType数组的某个元素。 为每个Rule对象调用MyArrayOf_xsd_anyType对象的Add方法。
  5. 设置PDF运行时选项

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

    • 使用构造函数创建RenderOptionsSpec对象。
    • 缓存表单设计以通过将true值分配给RenderOptionsSpec对象的cacheEnabled数据成员来提高Output服务的性能。
    note note
    NOTE
    如果输入文档是Acrobat表单,则无法使用RenderOptionsSpec对象的pdfVersion成员来设置PDF文档的版本。 输出PDF文档保留Acrobat表单的PDF版本。 同样,如果输入PDF是Acrobat表单,则无法使用RenderOptionsSpec对象的taggedPDF方法设置标记文档选项。
    note note
    NOTE
    如果输入PDF文档经过认证或数字签名,则不能使用RenderOptionsSpec对象的linearizedPDF成员来设置线性化PDF选项。 有关信息,请参阅对PDF文档进行数字签名
  7. 生成PDF文档

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

    • TransformationFormat枚举值。 要生成PDF文档,请指定TransformationFormat.PDF
    • 一个字符串值,它指定窗体设计的名称。
    • 一个字符串值,它指定表单设计所在的内容根。
    • 包含PDF运行时选项的PDFOutputOptionsSpec对象。
    • 包含渲染运行时选项的RenderOptionsSpec对象。
    • 包含要与表单设计合并的数据的XML数据源的BLOB对象。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用所生成的描述文档的元数据填充此对象。 (只有Web服务调用才需要此参数值)。
    • generatePDFOutput方法填充的BLOB对象。 generatePDFOutput方法使用结果数据填充此对象。 (只有Web服务调用才需要此参数值)。
    • 包含操作结果的OutputResult对象。 (只有Web服务调用才需要此参数值)。
    note note
    NOTE
    通过调用generatePDFOutput方法生成PDF文档时,不能将数据与已签名、已验证或包含使用权限的XFAPDF表单合并。 有关使用权限的信息,请参阅将使用权限应用于PDF文档
  8. 检索操作的结果

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

另请参阅

步骤摘要

使用MTOM调用AEM Forms

使用SwaRef调用AEM Forms

拼合PDF文档 flattening-pdf-documents

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

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

  • 交互式XFAPDF文档
  • Acrobat Forms

尝试拼合非交互式PDFPDF会导致异常。

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

步骤摘要 summary_of_steps-9

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

  1. 包括项目文件。
  2. 创建输出客户端对象。
  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部署在受支持的J2EE应用程序服务器而不是JBoss上,则必须将adobe-utilities.jar和jbossall-client.jar文件替换为特定于已部署AEM Forms的J2EE应用程序服务器的JAR文件。 有关所有AEM Forms JAR文件位置的信息,请参阅包括AEM Forms Java库文件

创建输出客户端对象

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

检索交互式PDF文档

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

转换PDF文档

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

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

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

另请参阅

使用Java API拼合PDF文档

使用Web服务API拼合PDF文档

包括AEM Forms Java库文件

设置连接属性

输出服务API快速启动

使用Java API拼合PDF文档 flatten-a-pdf-document-using-the-java-api

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

  1. 包括项目文件。

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

  2. 创建输出客户端对象。

    • 创建包含连接属性的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/文档,因此您可以指定null
    • 表示修订编号和年份的字符串值,用冒号分隔。 由于此参数适用于PDF/文档,因此您可以指定null
    • 表示PDF/A合规性级别的PDFAConformance枚举值。 由于此参数适用于PDF/文档,因此您可以指定null

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

  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文档 flatten-a-pdf-document-using-the-web-service-api

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

  1. 包括项目文件。

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

    note note
    NOTE
    localhost替换为承载AEM Forms的服务器的IP地址。
  2. 创建输出客户端对象。

    • 使用默认构造函数创建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身份验证:

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

    • 使用构造函数创建BLOB对象。 BLOB对象用于存储交互式PDF文档。
    • 通过调用其构造函数并传递表示交互式PDF文档的文件位置的字符串值来创建System.IO.FileStream对象。
    • 创建用于存储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/文档,因此您可以指定false
    • 表示修订编号和年份的字符串值,用冒号分隔。 由于此参数适用于PDF/文档,因此您可以指定null
    • 表示PDF/A合规性级别的PDFAConformance枚举值。
    • 指定是否使用PDFAConformance枚举值的布尔值。 由于此参数适用于PDF/文档,因此您可以指定false

    transformPDF方法返回包含非交互式PDF文档的BLOB对象。

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

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

另请参阅

步骤摘要

使用MTOM调用AEM Forms

使用SwaRef调用AEM Forms

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