使用書籤組裝PDF文檔

本檔案中的範例和範例僅適用於JEE環境上的AEM Forms。

您可以組合包含書籤的PDF檔案。 例如，假設您的PDF檔案不含書籤，且您想借由提供書籤來修改該檔案。 使用組合器服務，可以傳遞不包含書籤的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文檔傳遞到組合器服務。 使用書籤組裝PDF文檔時，必須指定描述結果文檔中書籤的書籤XML文檔。 要指定書籤XML文檔，請確保在DDX文檔中指定Bookmarks元素。

在此示例DDX文檔中，Bookmarks元素將doc2指定為值。 此值指示傳遞到組合器服務的輸入映射包含名為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文檔中，請注意「操作」元素，該元素定義用戶按一下書籤時執行的操作。 在「動作」元素底下是Launch元素，可啟動應用程式（例如NotePad）並開啟檔案（例如PDF檔案）。 要開啟PDF檔案，必須使用指定要開啟的檔案的「檔案」元素。 例如，在此部分指定的書籤XML檔案中，開啟的檔案名稱為LoanDetails.pdf。

注意

有關支援操作的完整詳細資訊，請參閱組合器服務和DDX引用中的「Action元素」。

給定本節中指定的DDX文檔，並將XML檔案作為輸入加入書籤，組合器服務將組合包含以下書籤的PDF文檔。

aw_aw_bmark

當用戶按一下​開啟貸款詳細資訊​書籤時，將開啟LoanDetails.pdf。 同樣地，當使用者點按​啟動NotePad​書籤時，NotePad即會啟動。

注意

閱讀本節之前，建議您先熟悉使用組合器服務組合PDF文檔。 本節不討論概念，例如建立包含輸入文檔的集合對象，或了解如何從返回的集合對象中提取結果。 （請參閱以程式設計方式組合PDF文檔。）

注意

有關組合器服務的詳細資訊，請參閱AEM Forms的服務參考。

注意

有關DDX文檔的詳細資訊，請參閱組合器服務和DDX引用。

步驟的摘要

要組合包含書籤的PDF文檔，請執行以下任務：

  1. 包含專案檔案。
  2. 建立PDF組合器客戶端。
  3. 參考現有的DDX文檔。
  4. 參考要新增書籤的PDF檔案。
  5. 參考書籤XML文檔。
  6. 將PDF文檔和書籤XML文檔添加到映射集合。
  7. 設定運行時選項。
  8. 組合PDF文檔。
  9. 儲存包含書籤的PDF檔案。

包含項目檔案

在您的開發專案中加入必要的檔案。 如果您是使用Java建立客戶端應用程式，請包括必要的JAR檔案。 如果您使用Web服務，請確定您包含Proxy檔案。

必須將以下JAR檔案添加到項目的類路徑中：

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-assembler-client.jar
  • adobe-utilities.jar(若AEM Forms部署在JBoss上則為必要)
  • jbossall-client.jar(若AEM Forms部署在JBoss上則為必要)

如果AEM Forms部署在JBoss以外的受支援J2EE應用程式伺服器上，您必須將adobe-utilities.jar和jbossall-client.jar檔案取代為AEM Forms所部署之J2EE應用程式伺服器專屬的JAR檔案。 有關所有AEM Forms JAR檔案的位置資訊，請參閱包含AEM Forms Java庫檔案。

建立PDF組合器客戶端

在以寫程式方式執行組合器操作之前，必須建立組合器服務客戶端。

參考現有的DDX文檔

必須參考DDX文檔才能組合PDF文檔。 此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文檔將傳遞到映射集合對象內的組合器服務。 （如需範例，請參閱本節前面所示的書籤XML檔案。）

注意

請參閱組合器服務和DDX參考中的「書籤語言」。

將PDF文檔和書籤XML文檔添加到映射集合

您必須將要新增書籤的PDF檔案和書籤XML檔案新增至地圖集合。 因此，地圖集合物件包含兩個元素：PDF文檔和書籤XML文檔。

設定運行時選項

您可以設定運行時選項，以控制組合器服務在執行作業時的行為。 例如，您可以設定一個選項，指示組合器服務在遇到錯誤時繼續處理作業。 如需可設定的執行階段選項相關資訊，請參閱AEM Forms API參考中的AssemblerOptionSpec類別參考。

組合PDF檔案

要組合包含新書籤的PDF文檔，請使用組合器服務的invokeDDX操作。 必須使用invokeDDX操作而不是其他組合器服務操作（如invokeOneDocument）的原因是組合器服務需要在映射集合對象內傳遞的書籤XML文檔。 此對象是invokeDDX操作的參數。

儲存包含書籤的PDF檔案

您必須從傳回的地圖物件中擷取結果，並儲存對應的PDF檔案。 （請參閱以程式設計方式組合PDF檔案中的「提取結果」。）

另請參閱

包含AEM Forms Java程式庫檔案

設定連接屬性

以程式設計方式組合PDF檔案

使用Java API使用書籤組合PDF檔案

使用組合器服務API(Java)使用書籤組合PDF文檔：

  1. 包含專案檔案。

    在Java項目的類路徑中包含客戶端JAR檔案，如adobe-assembler-client.jar。

  2. 建立PDF組合器客戶端。

    • 建立包含連接屬性的ServiceClientFactory對象。 （請參閱設定連接屬性。）
    • 使用其建構子並傳遞ServiceClientFactory物件，以建立AssemblerServiceClient物件。

  3. 參考現有的DDX文檔。

    • 使用DDX文檔的建構子並傳遞指定DDX檔案位置的字串值，建立代表DDX文檔的java.io.FileInputStream對象。
    • 使用其建構子並傳遞java.io.FileInputStream物件，以建立com.adobe.idp.Document物件。

  4. 參考要新增書籤的PDF檔案。

    • 使用其建構子並傳遞PDF檔案的位置，建立java.io.FileInputStream物件。
    • 使用其建構子建立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文檔添加到映射集合。

    • 建立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對象的方法來設定運行時選項以滿足您的業務要求。 例如，要指示組合器服務在發生錯誤時繼續處理作業，請調用AssemblerOptionSpec對象的setFailOnError方法並傳遞false。

  8. 組合PDF文檔。

    調用AssemblerServiceClient對象的invokeDDX方法並傳遞以下必需值：

    • 表示要使用的DDX文檔的com.adobe.idp.Document對象
    • 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文檔

使用組合器服務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組合器客戶端。

    • 使用其預設建構子建立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對象的資料成員分配值，以設定運行時選項以滿足您的業務要求。 例如，要指示組合器服務在發生錯誤時繼續處理作業，請將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

本頁內容