文档AEM 6.5用户指南

使用书签组合PDF文档 assembling-pdf-documents-with-bookmarks

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

创建对象：

  • undefined

本文档中的示例和示例仅适用于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文档中，请注意源属性被分配了值Loan.pdf。 此DDX文档指定将单个PDF文档传递到Assembler服务。 在组合带有书签的PDF文档时，必须指定描述结果文档中书签的书签XML文档。 若要指定书签XML文档，请确保在DDX文档中指定了Bookmarks元素。

在此示例DDX文档中，Bookmarks元素指定doc2作为值。 此值表示传递到Assembler服务的输入映射包含名为doc2的键。 doc2键的值是表示书签XML文档的com.adobe.idp.Document值。 （请参阅汇编程序服务和DDX引用中的“书签语言”。）

本主题使用以下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文档中，请注意定义用户单击书签时执行的操作的操作元素。 在Action元素下是Launch元素，该元素可启动应用程序（如NotePad）并打开文件(如PDF文件)。 要打开PDF文件，必须使用指定要打开的文件的File元素。 例如，在此部分指定的书签XML文件中，打开的文件名为LoanDetails.pdf。

NOTE
有关支持的操作的完整详细信息，请参阅汇编程序服务和DDX引用中的“Action元素”。

给定本节中指定的DDX文档并将XML文件标记为书签，Assembler服务将组合包含以下书签的PDF文档。

aw_aw_bmark

当用户单击​ 打开贷款详细信息 ​书签时，将打开LoanDetails.pdf。 同样，当用户单击​ Launch NotePad ​书签时，NotePad将启动。

NOTE
在阅读本节之前，建议您熟悉使用Assembler服务组合PDF文档。 本节不讨论相关概念，例如创建包含输入文档的收藏集对象，或者了解如何从返回的收藏集对象中提取结果。 (请参阅以编程方式组合PDF文档。)
NOTE
有关Assembler服务的详细信息，请参阅AEM Forms的服务参考。
NOTE
有关DDX文档的更多信息，请参阅汇编程序服务和DDX引用。

步骤摘要 summary-of-steps

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

  1. 包括项目文件。
  2. 创建PDF汇编程序客户端。
  3. 引用现有DDX文档。
  4. 引用添加书签的PDF文档。
  5. 引用书签XML文档。
  6. 将PDF文档和书签XML文档添加到地图收藏集。
  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文件替换为JAR文件，这些文件特定于部署AEM Forms的J2EE应用程序服务器。 有关所有AEM Forms JAR文件位置的信息，请参阅包括AEM Forms Java库文件。

创建PDF汇编程序客户端

您必须先创建一个Assembler服务客户端，然后才能以编程方式执行Assembler操作。

引用现有DDX文档

要组合PDF文档，必须引用DDX文档。 此DDX文档必须包含Bookmarks元素，该元素指示汇编程序服务汇编包含书签的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文档。）

NOTE
请参阅汇编程序服务和DDX引用中的“书签语言”。

将PDF文档和书签XML文档添加到地图收藏集

将添加书签的PDF文档以及书签XML文档添加到映射集合中。 因此，映射集合对象包含两个元素：PDF文档和书签XML文档。

设置运行时选项

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

汇编PDF文档

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

保存包含书签的PDF文档

从返回的映射对象中提取结果并保存相应的PDF文档。 (请参阅以编程方式组合PDF文档中的“提取结果”。)

另请参阅

包括AEM Forms Java库文件

设置连接属性

以编程方式组合PDF文档

使用Java API组合带有书签的PDF文档 assemble-pdf-documents-with-bookmarks-using-the-java-api

使用Assembler服务API (Java)组合带有书签的PDF文档：

  1. 包括项目文件。

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

  2. 创建PDF汇编程序客户端。

    • 创建包含连接属性的ServiceClientFactory对象。 （请参阅设置连接属性。）
    • 使用构造函数创建AssemblerServiceClient对象并传递ServiceClientFactory对象。

  3. 引用现有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文档。

    • 通过使用其构造函数并传递表示书签XML文档的XML文件的位置来创建java.io.FileInputStream对象。
    • 创建一个com.adobe.idp.Document对象并传递包含PDF文档的java.io.FileInputStream对象。

  6. 将PDF文档和书签XML文档添加到地图收藏集。

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

    • 通过调用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方法并传递以下必需值：

    • 表示要使用的DDX文档的com.adobe.idp.Document对象
    • 包含输入PDF文档和书签XML文档的java.util.Map对象。
    • 指定运行时选项（包括默认字体和作业日志级别）的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文档 assemble-pdf-documents-with-bookmarks-using-the-web-service-api

使用Assembler服务API（Web服务）组合带有书签的PDF文档：

  1. 包括项目文件。

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

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

  2. 创建PDF汇编程序客户端。

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

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

  4. 引用添加书签的PDF文档。

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

  5. 引用书签XML文档。

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

  6. 将PDF文档和书签XML文档添加到地图收藏集。

    • 创建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。
    • 通过访问其BLOB对象的MTOM字段提取表示PDF文档的二进制数据。 这会返回一个字节数组，您可以将该字节写出到PDF文件中。

另请参阅

使用MTOM调用AEM Forms

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