文档AEM 6.5用户指南

组装多个XDP片段 assembling-multiple-xdp-fragments

Last update: Wed Mar 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

创建对象：

  • Developer

您可以将多个XDP片段组合到单个XDP文档中。 例如，考虑XDP片段，其中每个XDP文件都包含一个或多个用于创建健康表单的子表单。 下图显示了大纲视图(表示在 组装多个XDP片段 快速入门)：

am_am_forma

下图显示了患者部分(表示在 组装多个XDP片段 快速入门)：

am_am_formb

下图显示了“患者健康”部分(表示用于 组装多个XDP片段 快速入门)：

am_am_formc

此片段包含两个名为的子表单 subPatientPhysical 和 subPatientHealth. 这两个子表单在传递给Assembler服务的DDX文档中引用。 使用Assembler服务，您可以将所有这些XDP片段组合到单个XDP文档中，如下图所示。

am_am_formd

以下DDX文档将多个XDP片段组合到一个XDP文档中。

 <?xml version="1.0" encoding="UTF-8"?>
 <DDX xmlns="https://ns.adobe.com/DDX/1.0/">
         <XDP result="tuc018result.xdp">
            <XDP source="tuc018_template_flowed.xdp">
             <XDPContent insertionPoint="ddx_fragment" source="tuc018_contact.xdp" fragment="subPatientContact" required="false"/>
               <XDPContent insertionPoint="ddx_fragment" source="tuc018_patient.xdp" fragment="subPatientPhysical" required="false"/>
               <XDPContent insertionPoint="ddx_fragment" source="tuc018_patient.xdp" fragment="subPatientHealth" required="false"/>
            </XDP>
         </XDP>
 </DDX>

DDX文档包含一个XDP result 指定结果名称的标记。 在这种情况下，值是 tuc018result.xdp. 在Assembler服务返回结果后，在用于检索XDP文档的应用程序逻辑中引用此值。 例如，考虑用于检索已装配XDP文档的以下Java应用程序逻辑（请注意该值为粗体）：

 //Iterate through the map object to retrieve the result XDP document
 for (Iterator i = allDocs.entrySet().iterator(); i.hasNext();) {
     // Retrieve the Map object’s value
     Map.Entry e = (Map.Entry)i.next();
     //Get the key name as specified in the
     //DDX document
     String keyName = (String)e.getKey();
     if (keyName.equalsIgnoreCase("tuc018result.xdp"))
                 {
         Object o = e.getValue();
         outDoc = (Document)o;
         //Save the result PDF file
         File myOutFile = new File("C:\\AssemblerResultXDP.xdp");
         outDoc.copyToFile(myOutFile);
     }
 }

此 XDP source 标记指定表示完整XDP文档的XDP文件，该文件可用作添加XDP片段的容器，或作为按顺序追加在一起的多个文档之一。 在这种情况下，XDP文档仅用作容器（如中所示的第一个图） 组装多个XDP片段)。 也就是说，其他XDP文件被放置在XDP容器中。

对于每个子表单，您可以添加 XDPContent 元素（此元素是可选的）。 在上例中，请注意有三个子表单： subPatientContact， subPatientPhysical、和 subPatientHealth. 两者都是 subPatientPhysical 子表单和 subPatientHealth 子表单位于同一XDP文件tuc018_patient.xdp中。 片段元素指定子表单的名称，如Designer中所定义。

NOTE
有关汇编程序服务的详细信息，请参见 AEM Forms的服务参考.
NOTE
有关DDX文档的详细信息，请参见 汇编程序服务和DDX参考.

步骤摘要 summary-of-steps

要组合多个XDP片段，请执行以下任务：

  1. 包括项目文件。
  2. 创建PDF汇编程序客户端。
  3. 引用现有DDX文档。
  4. 参考XDP文档。
  5. 设置运行时选项。
  6. 组合多个XDP文档。
  7. 检索装配的XDP文档。

包含项目文件

在开发项目中包含必要的文件。 如果使用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，则此为必填字段)

创建PDF汇编程序客户端

在以编程方式执行汇编程序操作之前，请先创建汇编程序服务客户端。

引用现有DDX文档

要组合多个XDP文档，必须引用DDX文档。 此DDX文档必须包含 XDP result， XDP source、和 XDPContent 元素。

参考XDP文档

要组合多个XDP文档，请引用用于组合结果XDP文档的所有XDP文件。 确保XDP文档中包含的、由引用的 source 属性在 fragment 属性。 子表单在Designer中定义。 例如，请考虑以下XML。

 <XDPContent insertionPoint="ddx_fragment" source="tuc018_contact.xdp" fragment="subPatientContact" required="false"/>

指定的子表单 subPatientContact 必须在名为的XDP文件中 tuc018_contact.xdp.

设置运行时选项

您可以设置运行时选项，以控制Assembler服务执行作业时的行为。 例如，您可以设置一个选项，在遇到错误时指示Assembler服务继续处理作业。

组合多个XDP文档

要组合多个XDP文件，请调用 invokeDDX 操作。 Assembler服务返回集合对象中的已装配XDP文档。

检索装配的XDP文档

在收集对象中返回已装配的XDP文档。 循环访问收集对象并将XDP文档另存为XDP文件。 您还可以将XDP文档传递到另一个AEM Forms服务，例如输出。

另请参阅

使用Java API组合多个XDP片段

使用Web服务API组合多个XDP片段

包括AEM Forms Java库文件

设置连接属性

以编程方式组合PDF文档

使用片段创建PDF文档

使用Java API组合多个XDP片段 assemble-multiple-xdp-fragments-using-the-java-api

使用Assembler服务API (Java)汇编多个XDP片段：

  1. 包括项目文件。

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

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

    • 创建 ServiceClientFactory 包含连接属性的对象。
    • 创建 AssemblerServiceClient 对象，使用它的构造函数传递 ServiceClientFactory 对象。

  3. 引用现有DDX文档。

    • 创建 java.io.FileInputStream 通过使用其构造函数并传递指定DDX文件位置的字符串值来表示DDX文档的对象。
    • 创建 com.adobe.idp.Document 对象，使用它的构造函数传递 java.io.FileInputStream 对象。

  4. 参考XDP文档。

    • 创建 java.util.Map 通过使用 HashMap 构造函数。

    • 创建 com.adobe.idp.Document 对象并传递 java.io.FileInputStream 包含输入XDP文件的对象（对每个XDP文件重复此任务）。

    • 将条目添加到 java.util.Map 对象(通过调用其 put 方法并传递以下参数：

      • 表示键名的字符串值。 此值必须匹配 source DDX文档中指定的元素值（对每个XDP文件重复此任务）。
      • A com.adobe.idp.Document 包含与对应的XDP文档的对象 source 元素（对每个XDP文件重复此任务）。

  5. 设置运行时选项。

    • 创建 AssemblerOptionSpec 使用构造函数存储运行时选项的对象。
    • 通过调用属于 AssemblerOptionSpec 对象。 例如，要指示Assembler服务在发生错误时继续处理作业，请调用 AssemblerOptionSpec 对象的 setFailOnError 方法和路径 false.

  6. 组合多个XDP文档。

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

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

    此 invokeDDX 方法返回 com.adobe.livecycle.assembler.client.AssemblerResult 包含已装配XDP文档的对象。

  7. 检索装配的XDP文档。

    要获取装配的XDP文档，请执行以下步骤：

    • 调用 AssemblerResult 对象的 getDocuments 方法。 此方法会返回 java.util.Map 对象。
    • 循环访问 java.util.Map 对象，直到找到结果为止 com.adobe.idp.Document 对象。
    • 调用 com.adobe.idp.Document 对象的 copyToFile 提取装配XDP文档的方法。

另请参阅

组装多个XDP片段
快速入门（SOAP模式）：使用Java API汇编多个XDP片段
包括AEM Forms Java库文件
设置连接属性

使用Web服务API组合多个XDP片段 assemble-multiple-xdp-fragments-using-the-web-service-api

使用Assembler服务API（Web服务）组合多个XDP片段：

  1. 包括项目文件。

    创建使用MTOM的Microsoft .NET项目。 在设置服务引用时，请确保使用以下WSDL定义：

    code language-java 
     https://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1.
    note note
    NOTE
    替换 localhost ，其中包含托管AEM Forms的服务器的IP地址。

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

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

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

    • 创建 System.ServiceModel.BasicHttpBinding 对象，方法是获取 AssemblerServiceClient.Endpoint.Binding 字段。 将返回值强制转换为 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 方法。 传递字节数组、起始位置和流长度以读取。
    • 填充 BLOB 对象，通过指定其 MTOM 属性与字节数组的内容。

  4. 参考XDP文档。

    • 对于每个输入XDP文件，创建 BLOB 对象。 此 BLOB 对象用于存储输入文件。
    • 创建 System.IO.FileStream 对象，方法是调用其构造函数并传递一个字符串值，该字符串值表示输入文件的文件位置以及打开文件的模式。
    • 创建一个字节数组，用于存储 System.IO.FileStream 对象。 您可以通过获取 System.IO.FileStream 对象的 Length 属性。
    • 通过调用 System.IO.FileStream 对象的 Read 方法。 传递字节数组、起始位置和流长度以读取。
    • 填充 BLOB 对象，通过指定其 MTOM 包含字节数组内容的字段。
    • 创建 MyMapOf_xsd_string_To_xsd_anyType 对象。 此集合对象用于存储创建组合的XDP文档所需的输入文件。
    • 对于每个输入文件，创建 MyMapOf_xsd_string_To_xsd_anyType_Item 对象。
    • 将代表键名的字符串值分配给 MyMapOf_xsd_string_To_xsd_anyType_Item 对象的 key 字段。 此值必须匹配DDX文档中指定元素的值。 （为每个输入XDP文件执行此任务。）
    • 分配 BLOB 将输入文件存储到的对象 MyMapOf_xsd_string_To_xsd_anyType_Item 对象的 value 字段。 （为每个输入XDP文件执行此任务。）
    • 添加 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 对象。 （为每个输入XDP文档执行此任务。）

  5. 设置运行时选项。

    • 创建 AssemblerOptionSpec 使用构造函数存储运行时选项的对象。
    • 通过为属于以下对象的数据成员分配值，设置运行时选项以满足您的业务要求 AssemblerOptionSpec 对象。 例如，要指示Assembler服务在发生错误时继续处理作业，请分配 false 到 AssemblerOptionSpec 对象的 failOnError 数据成员。

  6. 组合多个XDP文档。

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

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

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

  7. 检索装配的XDP文档。

    要获取新创建的XDP文档，请执行以下步骤：

    • 访问 AssemblerResult 对象的 documents 字段，即 Map 包含结果PDF文档的对象。
    • 循环访问 Map 对象以获取每个结果文档。 然后，强制转换该数组成员的 value 到 BLOB.
    • 通过访问代表PDF文档的二进制数据 BLOB 对象的 MTOM 属性。 这会返回一个字节数组，您可以将其写出到XDP文件。

另请参阅

组装多个XDP片段
使用MTOM调用AEM Forms

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