文档AEM 6.5用户指南

使用Bates编号汇编文档

最近更新： 2024年7月15日
  • 适用对象：
  • Experience Manager 6.5
  • 主题：

创建对象：

  • 开发人员

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

您可以使用Bates编号来组合包含唯一页面标识符的PDF文档。 Bates编号 ​是一种将唯一标识应用于一批相关文档的方法。 文档（或文档集）中的每个页面都分配有一个Bates编号，用于唯一标识该页面。 例如，包含物料清单信息并与装配件的生产关联的制造文档可以包含标识符。 Bates编号包含一个按顺序递增的数值，以及可选的前缀和后缀。 前缀+数字+后缀称为​ Bates模式。

下图显示了一个PDF文档，该文档的标题中包含唯一标识符。

au_au_batesnumber

为了进行此讨论，将唯一页面标识符放置在文档标题中。 假定使用以下DDX文档。

 <?xml version="1.0" encoding="UTF-8"?>
 <DDX xmlns="https://ns.adobe.com/DDX/1.0/">
        <PDF result="out.pdf">
        <Header>
         <Center>
             <StyledText>
                 <p font-size="20pt"><BatesNumber/></p>
             </StyledText>
         </Center>
     </Header>
           <PDF source="map.pdf" />
          <PDF source="directions.pdf" />
          </PDF>
 </DDX>

此DDX文档将两个名为​ map.pdf ​和​ directions.pdf ​的PDF文档合并为一个PDF文档。 生成的PDF文档包含由唯一页面标识符组成的标题。 例如，上图中的文档显示了000016。

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

步骤摘要

要组合包含唯一页面标识符（Bates编号）的PDF文档，请执行以下任务：

  1. 包括项目文件。
  2. 创建PDF汇编程序客户端。
  3. 引用现有DDX文档。
  4. 引用输入PDF文档。
  5. 设置初始Bates编号值。
  6. 组合输入PDF文档。
  7. 提取结果。

包含项目文件

在开发项目中包含必要的文件。 如果使用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操作。

引用现有DDX文档

要组合PDF文档，必须引用DDX文档。 例如，考虑本节介绍的DDX文档。 要组合包含唯一页面标识符的PDF文档，DDX文档必须包含BatesNumber元素。

参考输入PDF文档

要组合PDF文档，必须引用输入PDF文档。 例如，必须引用map.pdf和directions.pdf文档，才能将这些PDF文档组合到单个PDF文档中。

设置初始Bates编号值

您可以设置初始Bates编号值以满足您的业务要求。 例如，假定需要将初始值设置为000100。 如果不设置初始值，则会000000到第一页的值。

汇编输入PDF文档

在创建Assembler服务客户端、引用包含BatesNumber元素信息的DDX文档、引用输入PDF文档并设置运行时选项之后，可以调用invokeDDX操作，该操作导致Assembler服务组合包含唯一页面标识符的PDF文档。

提取结果

Assembler服务返回包含作业结果的集合对象。 您可以提取生成的PDF文档以及抛出的任何异常。 在这种情况下，加密的PDF文档位于集合对象内。

NOTE
如果调用invokeDDX操作，将返回集合对象。 将两个或多个输入PDF文档传递到Assembler服务时，将使用此操作。 但是，如果只将一个输入PDF文档传递到Assembler服务，则应该调用invokeOneDocument操作。 有关使用此操作的信息，请参阅汇编加密的PDF文档。

另请参阅

包括AEM Forms Java库文件

设置连接属性

以编程方式组合PDF文档

使用Java API组合具有Bates编号的文档

使用Assembler服务API (Java)汇编使用唯一页面标识符（Bates编号）的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文档。

    • 使用HashMap构造函数创建用于存储输入PDF文档的java.util.Map对象。

    • 对于每个输入PDF文档，使用其构造函数并传递输入PDF文档的位置来创建一个java.io.FileInputStream对象。 在这种情况下，请传递不安全PDF单据的位置。

    • 对于每个输入PDF文档，创建一个com.adobe.idp.Document对象并传递包含PDF文档的java.io.FileInputStream对象。

    • 通过调用其put方法并传递以下参数，向java.util.Map对象添加一个条目：

      • 表示键名的字符串值。 此值必须与DDX文档中指定的PDF源元素的值匹配。 例如，本节介绍的DDX文档中指定的PDF源文件的名称为Loan.pdf。
      • 包含不安全PDF文档的com.adobe.idp.Document对象。

  5. 设置初始Bates编号值。

    • 使用构造函数创建存储运行时选项的AssemblerOptionSpec对象。
    • 通过调用AssemblerOptionSpec对象的setFirstBatesNumber并传递指定初始值的数值来设置初始Bates编号。

  6. 组合输入PDF文档。

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

    • 表示DDX文档的com.adobe.idp.Document对象。
    • 包含输入的不安全PDF文件的java.util.Map对象。
    • 指定运行时选项（包括默认字体和作业日志级别）的com.adobe.livecycle.assembler.client.AssemblerOptionSpec对象。

    invokeDDX方法返回包含密码加密PDF文档的com.adobe.livecycle.assembler.client.AssemblerResult对象。

  7. 提取结果。

    要获取新创建的PDF文档，请执行下列操作：

    • 调用AssemblerResult对象的getDocuments方法。 此操作返回java.util.Map对象。
    • 循环访问java.util.Map对象，直到找到com.adobe.idp.Document对象。
    • 调用com.adobe.idp.Document对象的copyToFile方法来提取PDF文档。

另请参阅

快速入门(SOAP模式)：使用Java API汇编具有Bates编号的PDF文档

包括AEM Forms Java库文件

设置连接属性

使用Web服务API组合具有Bates编号的文档

使用Assembler服务API（Web服务）组合使用唯一页面标识符（Bates编号）的PDF文档：

  1. 包括项目文件。

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

    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文档。

    • 对于每个输入PDF文档，使用其构造函数创建一个BLOB对象。 BLOB对象用于存储输入PDF文档。
    • 通过调用其构造函数创建System.IO.FileStream对象。 传递一个字符串值，该值表示输入PDF文档的文件位置以及打开文件的模式。
    • 创建用于存储System.IO.FileStream对象的内容的字节数组。 您可以通过获取System.IO.FileStream对象的Length属性来确定字节数组的大小。
    • 通过调用System.IO.FileStream对象的Read方法，使用流数据填充字节数组。 传递字节数组、起始位置和要读取的流长度。
    • 使用字节数组的内容指定其MTOM属性以填充BLOB对象。
    • 创建MyMapOf_xsd_string_To_xsd_anyType对象。 此收藏集对象用于存储输入PDF文档。
    • 对于每个输入PDF文档，创建一个MyMapOf_xsd_string_To_xsd_anyType_Item对象。 例如，如果使用两个输入PDF文档，则创建两个MyMapOf_xsd_string_To_xsd_anyType_Item对象。
    • 将表示键名的字符串值分配给MyMapOf_xsd_string_To_xsd_anyType_Item对象的key字段。 此值必须与DDX文档中指定的PDF源元素的值匹配。 (为每个输入PDF文档执行此任务。)
    • 将存储PDF文档的BLOB对象分配给MyMapOf_xsd_string_To_xsd_anyType_Item对象的value字段。 (为每个输入PDF文档执行此任务。)
    • 将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文档执行此任务。)

  5. 设置初始Bates编号值。

    • 使用构造函数创建存储运行时选项的AssemblerOptionSpec对象。
    • 通过为属于AssemblerOptionSpec对象的firstBatesNumber数据成员分配数值来设置初始Bates编号。

  6. 组合输入PDF文档。

    调用AssemblerServiceClient对象的invoke方法并传递以下值：

    • 表示DDX文档的BLOB对象。
    • 包含输入PDF文档的MyMapOf_xsd_string_To_xsd_anyType对象。 其键必须与PDF源文件的名称匹配，其值必须是与这些文件对应的BLOB对象。
    • 指定运行时选项的AssemblerOptionSpec对象。

    invoke方法返回包含作业结果和发生的任何异常的AssemblerResult对象。

  7. 提取结果。

    要获取新创建的PDF文档，请执行下列操作：

    • 访问AssemblerResult对象的documents字段，该字段是包含结果PDF文档的Map对象。
    • 循环访问Map对象，直到找到与结果文档名称匹配的键。 然后将该数组成员的value强制转换为BLOB。
    • 通过访问其BLOB对象的MTOM属性，提取表示PDF文档的二进制数据。 这会返回一个字节数组，您可以将该字节写出到PDF文件中。

另请参阅

使用MTOM调用AEM Forms

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