使用书签汇编PDF文档

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

您可以组合包含书签的PDF文档。 例如,假定您的PDF文档不包含书签,并且您希望通过提供书签来修改它。 使用Assembler服务,您可以将不包含书签的PDF文档传递给它并返回包含书签的PDF文档。

书签包含以下属性:

  • 在屏幕上显示为文本的标题。
  • 一个操作,指定当用户单击书签时发生的情况。 书签的典型操作是移动到当前文档中的其他位置或打开另一个PDF文档,但可以指定其他操作。

在此讨论中,假定使用以下DDX文档。

 <?xml version="1.0" encoding="UTF-8"?>
 <DDX xmlns="https://ns.adobe.com/DDX/1.0/">
       <PDF result="FinalDoc.pdf">
          <PDF source="Loan.pdf">
             <Bookmarks source="doc2" />
          </PDF>
       </PDF>
 </DDX>

在此DDX文档中,请注意为source属性赋值Loan.pdf。 此DDX文档指定将单个PDF文档传递给Assembler服务。 在将PDF文档与书签组合时,必须指定一个书签XML文档,在结果文档中描述书签。 要指定书签XML文档,请确保在DDX文档中指定Bookmarks元素。

在此示例DDX文档中,Bookmarks元素指定doc2作为值。 此值指示传递给Assembler服务的输入映射包含名为doc2的键。 doc2键的值是表示书签XML文档的com.adobe.idp.Document值。 (请参阅Assembler Service和DDX Reference中的“书签语言”。)

本主题使用以下XML书签语言组合包含书签的PDF文档。

 <?xml version="1.0" encoding="UTF-8"?>
 <Bookmarks xmlns="https://ns.adobe.com/pdf/bookmarks" version="1.0">
       <Bookmark>
          <Action>
             <Launch NewWindow="true">
                <File Name="C:\Adobe\LoanDetails.pdf" />
             </Launch>
          </Action>
         <Title>Open the Loan document</Title>
       </Bookmark>
 <Bookmark>
          <Action>
             <Launch>
                <Win Name="C:\WINDOWS\notepad.exe" />
             </Launch>
          </Action>
     <Title>Launch NotePad</Title>
       </Bookmark>
 </Bookmarks>

在此书签XML文档中,请注意定义用户单击书签时执行的操作的“操作”元素。 在“操作”元素下面是“启动”元素,用于启动应用程序(如NotePad)并打开文件(如PDF文件)。 要打开PDF文件,必须使用指定要打开的文件的“文件”元素。 例如,在本节中指定的书签XML文件中,打开的文件的名称为LoanDetails.pdf。

注意

有关支持的操作的完整详细信息,请参阅Assembler Service和DDX Reference中的“ Action element”。

给定本节中指定的DDX文档,并将XML文件加为书签作为输入,Assembler服务将汇编一个包含以下书签的PDF文档。

aw_aw_bmark

当用户单击​打开Loan Details​书签时,将打开LoanDetails.pdf。 同样,当用户单击​启动NotePad​书签时,将启动NotePad。

注意

在阅读本节之前,建议您熟悉使用Assembler服务汇编PDF文档。 本节不讨论概念,如创建包含输入文档的集合对象或了解如何从返回的集合对象中提取结果。 (请参阅以编程方式组合PDF文档。)

注意

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

注意

有关DDX文档的详细信息,请参阅Assembler Service和DDX Reference

步骤的摘要

要组合包含书签的PDF文档,请执行以下任务:

  1. 包括项目文件。
  2. 创建PDF Assembler客户端。
  3. 引用现有DDX文档。
  4. 引用添加书签的PDF文档。
  5. 引用书签XML文档。
  6. 将PDF文档和书签XML文档添加到Map集合。
  7. 设置运行时选项。
  8. 组合PDF文档。
  9. 保存包含书签的PDF文档。

包括项目文件

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

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

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-assembler-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库文件

创建PDF Assembler客户端

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

引用现有DDX文档

必须引用DDX文档才能组合PDF文档。 此DDX文档必须包含Bookmarks元素,该元素指示Assembler服务组合包含书签的PDF。 (有关示例,请参阅本节前面显示的DDX文档。)

引用添加书签的PDF文档

引用添加书签的PDF文档。 引用的PDF文档是否已包含书签并不重要。 如果Bookmarks元素是PDF源元素的子元素,则“书签”将替换PDF源中已存在的元素。 但是,如果要保留现有书签,请确保Bookmarks是PDF源元素的同级。 例如,请考虑以下示例:

 <PDF result="foo">
      <PDF source="inDoc"/>
      <Bookmarks source="doc2"/>
 </PDF>

引用书签XML文档

要组合包含新书签的PDF,必须引用书签XML文档。 书签XML文档将传递到Map集合对象中的Assembler服务。 (有关示例,请参阅本节前面显示的书签XML文档。)

注意

请参阅Assembler Service和DDX Reference中的“Bookmarks Language”。

将PDF文档和书签XML文档添加到Map集合

您必须同时将添加书签的PDF文档和书签XML文档添加到Map集合。 因此,Map集合对象包含两个元素:PDF文档和书签XML文档。

设置运行时选项

您可以设置运行时选项,以在Assembler服务执行作业时控制其行为。 例如,您可以设置一个选项,指示Assembler服务在遇到错误时继续处理作业。 有关可以设置的运行时选项的信息,请参阅AEM Forms API Reference中的AssemblerOptionSpec类引用。

组合PDF文档

要汇编包含新书签的PDF文档,请使用Assembler服务的invokeDDX操作。 您必须使用invokeDDX操作而不是其他Assembler服务操作(如invokeOneDocument)的原因是Assembler服务需要在Map集合对象中传递的书签XML文档。 此对象是invokeDDX操作的参数。

保存包含书签的PDF文档

您必须从返回的映射对象中提取结果并保存相应的PDF文档。 (请参阅编程汇编PDF文档中的“提取结果”。)

另请参阅

包括AEM Forms Java库文件

设置连接属性

以编程方式组合PDF文档

使用Java API将PDF文档与书签组合

使用Assembler Service API(Java)将PDF文档与书签组合:

  1. 包括项目文件。

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

  2. 创建PDF Assembler客户端。

    • 创建包含连接属性的ServiceClientFactory对象。 (请参阅设置连接属性。)
    • 使用AssemblerServiceClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
  3. 引用现有DDX文档。

    • 使用DDX文档的构造函数并传递一个指定DDX文件位置的字符串值,创建一个表示DDX文件的java.io.FileInputStream对象。
    • 使用com.adobe.idp.Document对象的构造函数并传递java.io.FileInputStream对象,创建对象。
  4. 引用添加书签的PDF文档。

    • 使用java.io.FileInputStream对象的构造函数并传递PDF文档的位置,创建对象。
    • 使用其构造函数创建com.adobe.idp.Document对象,并传递包含PDF文档的java.io.FileInputStream对象。
  5. 引用书签XML文档。

    • 使用java.io.FileInputStream对象的构造函数并传递表示书签XML文档的XML文件的位置,创建对象。
    • 创建com.adobe.idp.Document对象,并传递包含PDF文档的java.io.FileInputStream对象。
  6. 将PDF文档和书签XML文档添加到Map集合。

    • 创建一个java.util.Map对象,用于存储输入PDF文档和书签XML文档。

    • 通过调用java.util.Map对象的put方法并传递以下参数来添加输入PDF文档:

      • 表示键名的字符串值。 此值必须与在DDX文档中指定的PDF源元素的值匹配。
      • 包含输入PDF文档的com.adobe.idp.Document对象。
    • 通过调用java.util.Map对象的put方法并传递以下参数来添加书签XML文档:

      • 表示键名的字符串值。 此值必须与在DDX文档中指定的“书签”源元素的值匹配。
      • 包含书签XML文档的com.adobe.idp.Document对象。
  7. 设置运行时选项。

    • 使用AssemblerOptionSpec的构造函数创建存储运行时选项的对象。
    • 通过调用属于AssemblerOptionSpec对象的方法,设置运行时选项以满足您的业务要求。 例如,要指示Assembler服务在发生错误时继续处理作业,请调用AssemblerOptionSpec对象的setFailOnError方法并传递false
  8. 组合PDF文档。

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

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

    invokeDDX方法返回一个com.adobe.livecycle.assembler.client.AssemblerResult对象,其中包含作业的结果和发生的任何异常。

  9. 保存包含书签的PDF文档。

    要获取新创建的PDF文档,请执行以下操作:

    • 调用AssemblerResult对象的getDocuments方法。 这返回一个java.util.Map对象。
    • 遍历java.util.Map对象,直到找到生成的com.adobe.idp.Document对象。 (可以使用在DDX文档中指定的PDF结果元素获取文档。)
    • 调用com.adobe.idp.Document对象的copyToFile方法以提取PDF文档。

另请参阅

快速开始(SOAP模式):使用Java API将PDF文档与书签组合

包括AEM Forms Java库文件

设置连接属性

使用Web服务API将PDF文档与书签组合

使用Assembler Service API(Web服务)将PDF文档与书签组合:

  1. 包括项目文件。

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

    注意

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

  2. 创建PDF Assembler客户端。

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

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

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

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

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

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

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

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

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

    • 创建MyMapOf_xsd_string_To_xsd_anyType对象。 此集合对象用于存储输入的PDF文档和书签XML文档。
    • 对于每个输入PDF文档和书签XML文档,创建一个MyMapOf_xsd_string_To_xsd_anyType_Item对象。
    • MyMapOf_xsd_string_To_xsd_anyType_Item对象的key字段指定表示键名的字符串值。 此值必须与在DDX文档中指定的PDF源元素的值匹配。
    • 将存储PDF文档的BLOB对象指定到MyMapOf_xsd_string_To_xsd_anyType_Item对象的value字段。
    • MyMapOf_xsd_string_To_xsd_anyType_Item对象添加到MyMapOf_xsd_string_To_xsd_anyType对象。 调用MyMapOf_xsd_string_To_xsd_anyType对象的Add方法并传递MyMapOf_xsd_string_To_xsd_anyType对象。 (对每个输入PDF文档和书签XML文档执行此任务。)
  7. 设置运行时选项。

    • 使用AssemblerOptionSpec的构造函数创建存储运行时选项的对象。
    • 通过为属于AssemblerOptionSpec对象的数据成员分配一个值,设置运行时选项以满足您的业务需求。 例如,要指示Assembler服务在发生错误时继续处理作业,请将false分配给AssemblerOptionSpec对象的failOnError数据成员。
  8. 组合PDF文档。

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

    • 表示DDX文档的BLOB对象
    • 包含输入文档的MyMapOf_xsd_string_To_xsd_anyType数组
    • 指定运行时选项的AssemblerOptionSpec对象

    invokeDDX方法返回一个AssemblerResult对象,其中包含作业的结果以及可能发生的任何异常。

  9. 保存包含书签的PDF文档。

    要获取新创建的PDF文档,请执行以下操作:

    • 访问AssemblerResult对象的documents字段,该字段是包含结果PDF文档的Map对象。
    • 遍历Map对象,直到找到与生成文档的名称匹配的键。 然后将该数组成员的value转换为BLOB
    • 通过访问PDF文档的BLOB对象的MTOM字段,提取表示PDF数据的二进制数据。 这将返回可写入PDF文件的字节数组。

另请参阅

使用MTOM调用AEM Forms

On this page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now