以程式設計方式組合PDF檔案 programmatically-assembling-pdf-documents

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

適用對象：
Experience Manager 6.5

主題：

建立對象：

開發人員

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

您可以使用Assembler Service API將多個PDF檔案組合成單一PDF檔案。下圖顯示三份PDF檔案合併為單一PDF檔案。

pa_pa_document_assembly

若要將兩個或更多PDF檔案組合成單一PDF檔案，您需要DDX檔案。 DDX檔案說明Assembler服務產生的PDF檔案。也就是說，DDX檔案會指示Assembler服務要執行的動作。

為了進行此討論，假設使用下列DDX檔案。

 <?xml version="1.0" encoding="UTF-8"?>
 <DDX xmlns="https://ns.adobe.com/DDX/1.0/">
     <PDF result="out.pdf">
         <PDF source="map.pdf" />
         <PDF source="directions.pdf" />
     </PDF>
 </DDX>

此DDX檔案將兩個名為 map.pdf 和 directions.pdf 的PDF檔案合併為單一PDF檔案。

NOTE

若要檢視可拆解PDF檔案的DDX檔案，請參閱以程式設計方式拆解PDF檔案。

NOTE

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

NOTE

如需有關DDX檔案的詳細資訊，請參閱組合器服務與DDX參考。

使用Web服務叫用Assembler服務時的注意事項 considerations-when-invoking-assembler-service-using-web-services

當您在組合大型檔案期間新增頁首和頁尾時，可能會發生OutOfMemory錯誤，且檔案將不會被組合。若要減少發生此問題的機率，請將DDXProcessorSetting元素新增至您的DDX檔案，如下列範例所示。

<DDXProcessorSetting name="checkpoint" value="2000" />

您可以將此元素新增為DDX元素的子系或PDF result元素的子系。此設定的預設值為0 （零），這會關閉核取指標，且DDX的行為就像不存在DDXProcessorSetting元素一樣。如果您遇到OutOfMemory錯誤，您可能需要將值設為整數，通常介於500到5000之間。較小的查核點值會導致更頻繁的檢查點。

步驟摘要 summary-of-steps

若要從多個PDF檔案組合單一PDF檔案，請執行下列工作：

包含專案檔案。
建立PDF組合器使用者端。
參考現有的DDX檔案。
參考輸入PDF檔案。
設定執行階段選項。
組合輸入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檔案。

建立PDF組合器使用者端

您必須先建立「組合器」使用者端，才能以程式設計方式執行「組合器」作業。

參考現有的DDX檔案

必須參考DDX檔案才能組裝PDF檔案。例如，以本節介紹的DDX檔案為例。此DDX檔案會指示Assembler服務將兩個PDF檔案合併為單一PDF檔案。

參考輸入PDF檔案

參考您要傳遞至組合器服務的輸入PDF檔案。例如，如果要傳遞兩個名為「地圖」和「方向」的輸入PDF檔案，則必須傳遞對應的PDF檔案。

map.pdf檔案和directions.pdf檔案都必須放置在集合物件中。索引鍵的名稱必須符合DDX檔案中PDF來源屬性的值。如果DDX檔案中的索引鍵和來源屬性相符，則PDF檔案的名稱並不重要。

NOTE

若您叫用invokeDDX作業，會傳回包含集合物件的AssemblerResult物件。將兩個或多個輸入PDF檔案傳遞至組合器服務時，會使用此作業。但是，如果您只傳遞一個輸入PDF給組合器服務，並且只期望有一個傳回檔案，請叫用invokeOneDocument作業。叫用此作業時，會傳回單一檔案。如需有關使用此作業的資訊，請參閱組合加密的PDF檔案。

設定執行階段選項

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

組合輸入PDF檔案

建立服務使用者端、參考DDX檔案、建立儲存輸入PDF檔案的集合物件，以及設定執行階段選項之後，您可以叫用DDX作業。使用本節中指定的DDX檔案時，map.pdf和direction.pdf檔案會合併為一個PDF檔案。

擷取結果

Assembler服務傳回java.util.Map物件，此物件可從AssemblerResult物件取得，且包含作業結果。傳回的java.util.Map物件包含結果檔案和任何例外狀況。

下表摘要列出傳回java.util.Map物件中可以包含的一些索引鍵值和物件型別。

索引鍵值

物件型別

說明

documentName

com.adobe.idp.Document

包含在DDX結果元素中指定的結果檔案

documentName

Exception

包含檔案的任何例外狀況

OutputMapConstants.LOG_NAME

com.adobe.idp.Documen

包含工作記錄檔

另請參閱

包含AEM Forms Java程式庫檔案

設定連線屬性

以程式分解的PDF檔案

使用Java API組合PDF檔案 assemble-pdf-documents-using-the-java-api

使用組合器服務API (Java)組合PDF檔案：

包含專案檔案。

在您的Java專案的類別路徑中包含使用者端JAR檔案，例如adobe-assembler-client.jar。
建立PDF組合器使用者端。
- 建立包含連線屬性的ServiceClientFactory物件。
- 使用它的建構函式並傳遞ServiceClientFactory物件來建立AssemblerServiceClient物件。
參考現有的DDX檔案。
- 使用它的建構函式並傳遞指定DDX檔案位置的字串值，建立代表DDX檔案的java.io.FileInputStream物件。
- 使用它的建構函式並傳遞java.io.FileInputStream物件來建立com.adobe.idp.Document物件。
參考輸入PDF檔案。
- 使用HashMap建構函式建立用來儲存輸入PDF檔案的java.util.Map物件。
- 對於每個輸入PDF檔案，使用其建構函式並傳遞輸入PDF檔案的位置來建立java.io.FileInputStream物件。
- 針對每個輸入PDF檔案，建立com.adobe.idp.Document物件並傳遞包含PDF檔案的java.io.FileInputStream物件。
- 針對每個輸入檔案，透過叫用其put方法並傳遞下列引數，將專案新增至java.util.Map物件：
  - 代表索引鍵名稱的字串值。此值必須符合DDX檔案中指定的PDF來源元素的值。
  - 包含來源PDF檔案的com.adobe.idp.Document物件（或指定多個檔案的java.util.List物件）。
設定執行階段選項。
- 使用建構函式建立儲存執行階段選項的AssemblerOptionSpec物件。
- 透過叫用屬於AssemblerOptionSpec物件的方法，設定執行階段選項以符合您的業務需求。例如，若要指示Assembler服務在發生錯誤時繼續處理工作，請叫用AssemblerOptionSpec物件的setFailOnError方法，然後傳遞false。
組合輸入PDF檔案。

叫用AssemblerServiceClient物件的invokeDDX方法，並傳遞下列必要值：
- 代表要使用的DDX檔案的com.adobe.idp.Document物件
- 包含要組合之輸入PDF檔案的java.util.Map物件
- 指定執行階段選項（包括預設字型和作業記錄層級）的com.adobe.livecycle.assembler.client.AssemblerOptionSpec物件
invokeDDX方法傳回com.adobe.livecycle.assembler.client.AssemblerResult物件，其中包含工作的結果和發生的任何例外狀況。

擷取結果。

若要取得新建立的PDF檔案，請執行下列動作：

叫用AssemblerResult物件的getDocuments方法。這會傳回java.util.Map物件。
逐一檢視java.util.Map物件，直到找到結果com.adobe.idp.Document物件為止。 (您可以使用DDX檔案中指定的PDF結果元素來取得檔案。)
叫用com.adobe.idp.Document物件的copyToFile方法來擷取PDF檔案。

note note
NOTE
如果將`LOG_LEVEL`設定為產生記錄檔，您可以使用`AssemblerResult`物件的`getJobLog`方法來擷取記錄檔。

另請參閱

快速入門(SOAP模式)：使用Java API組合PDF檔案

包含AEM Forms Java程式庫檔案

設定連線屬性

使用網站服務API組合PDF檔案 assemble-pdf-documents-using-the-web-service-api

使用組合器服務API （Web服務）組合PDF檔案：

包含專案檔案。

建立使用MTOM的Microsoft .NET專案。確定您使用下列WSDL定義： http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1。

note note
NOTE
將`localhost`取代為主控AEM Forms之伺服器的IP位址。

建立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。
參考現有的DDX檔案。
- 使用物件的建構函式建立BLOB物件。 BLOB物件是用來儲存DDX檔案。
- 建立System.IO.FileStream物件，方法為叫用其建構函式，並傳遞代表DDX檔案檔案位置及開啟檔案的模式的字串值。
- 建立位元組陣列以儲存System.IO.FileStream物件的內容。您可以取得System.IO.FileStream物件的Length屬性來決定位元組陣列的大小。
- 呼叫System.IO.FileStream物件的Read方法，並傳遞要讀取的位元組陣列、起始位置和資料流長度，以資料流資料填入位元組陣列。
- 以位元組陣列的內容指派物件的MTOM屬性，填入BLOB物件。
參考輸入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檔案執行此工作。)
設定執行階段選項。
- 使用建構函式建立儲存執行階段選項的AssemblerOptionSpec物件。
- 將值指派給屬於AssemblerOptionSpec物件的資料成員，設定執行階段選項以符合您的業務需求。例如，若要指示Assembler服務在發生錯誤時繼續處理工作，請將false指派給AssemblerOptionSpec物件的failOnError資料成員。
組合輸入PDF檔案。

叫用AssemblerServiceClient物件的invoke方法，並傳遞下列值：
- 代表DDX檔案的BLOB物件。
- 包含輸入PDF檔案的mapItem陣列。其金鑰必須與PDF來源檔案的名稱相符，其值必須是與這些檔案相對應的BLOB物件。
- 指定執行階段選項的AssemblerOptionSpec物件。
invoke方法傳回AssemblerResult物件，其中包含工作結果以及可能發生的任何例外狀況。

擷取結果。

若要取得新建立的PDF檔案，請執行下列動作：

存取AssemblerResult物件的documents欄位，這是包含結果PDF檔案的Map物件。
反複檢查Map物件，直到找到符合結果檔名稱的金鑰。然後將該陣列成員的value轉換為BLOB。
存取其BLOB物件的MTOM屬性，以擷取代表PDF檔案的二進位資料。這會傳回您可以寫出至PDF檔案的位元組陣列。

note note
NOTE
如果將`LOG_LEVEL`設定為產生記錄檔，您可以透過取得`AssemblerResult`物件的`jobLog`資料成員的值來擷取記錄檔。

另請參閱

使用MTOM叫用AEM Forms

recommendation-more-help

19ffd973-7af2-44d0-84b5-d547b0dffee2