組合含書籤的PDF檔案 assembling-pdf-documents-with-bookmarks
本檔案中的範例和範例僅適用於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檔案傳遞至組合器服務。 當組合含有書籤的PDF檔案時,您必須指定書籤XML檔案,以說明結果檔案中的書籤。 若要指定書籤XML檔案,請確定 Bookmarks
元素會在DDX檔案中指定。
在此範例DDX檔案中, Bookmarks
元素指定 doc2
做為值。 此值表示傳遞給Assembler服務的輸入對應包含名為的索引鍵 doc2
. 的值 doc2
索引鍵是 com.adobe.idp.Document
代表書籤XML檔案的值。 (請參閱 組合器服務和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。
Action
元素」 組合器服務和DDX參考.指定此區段中所指定的DDX檔案並將XML檔案加入書籤作為輸入,Assembler服務會組合包含下列書籤的PDF檔案。
當使用者按一下 開啟貸款詳細資料 書籤,LoanDetails.pdf隨即開啟。 同樣地,當使用者按一下 啟動記事本 書籤,便箋簿已啟動。
步驟摘要 summary-of-steps
若要組合包含書籤的PDF檔案,請執行下列工作:
- 包含專案檔案。
- 建立PDF組合器使用者端。
- 參考現有的DDX檔案。
- 參照新增書籤的PDF檔案。
- 參考書籤XML檔案。
- 將PDF檔案和書籤XML檔案新增至地圖集合。
- 設定執行階段選項。
- 組合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檔案。 如需有關所有AEM Forms JAR檔案位置的資訊,請參閱 包含AEM Forms Java程式庫檔案.
建立PDF組合器使用者端
您必須先建立組合器服務使用者端,才能以程式設計方式執行組合器作業。
參考現有的DDX檔案
必須參考DDX檔案才能組裝PDF檔案。 此DDX檔案必須包含 Bookmarks
元素,指示Assembler服務組合包含書籤的PDF。 (如需範例,請參閱本節前面顯示的DDX檔案)。
參照新增書籤的PDF檔案
參照新增書籤的PDF檔案。 參考的PDF檔案是否已包含書籤並不重要。 如果 Bookmarks
元素是PDF來源元素的子項,則書籤將會取代PDF來源中已存在的專案。 不過,如果您想要保留現有的書籤,請確定 Bookmarks
是PDF來源元素的同胞(sibling)。 例如,請考量下列範例:
<PDF result="foo">
<PDF source="inDoc"/>
<Bookmarks source="doc2"/>
</PDF>
參考書籤XML檔案
若要組合包含新書籤的PDF,您必須參考書籤XML檔案。 書籤XML檔案會傳遞到Map集合物件中的Assembler服務。 (如需範例,請參閱本區段前面顯示的書籤XML檔案。)
將PDF檔案和書籤XML檔案新增至地圖集合
將新增書籤的PDF檔案與書籤XML檔案新增至地圖集合。 因此,Map集合物件包含兩個元素:PDF檔案與書籤XML檔案。
設定執行階段選項
您可以設定執行階段選項,控制Assembler服務執行工作時的行為。 例如,您可以設定一個選項,在遇到錯誤時指示Assembler服務繼續處理工作。 如需您可以設定的執行階段選項相關資訊,請參閱 AssemblerOptionSpec
中的類別參考 AEM Forms API參考.
組合PDF檔案
若要組合包含新書籤的PDF檔案,請使用「組合器」服務的 invokeDDX
作業。 為什麼您必須使用 invokeDDX
操作而不是其他Assembler服務操作,例如 invokeOneDocument
是因為Assembler服務需要在Map集合物件中傳遞的書籤XML檔案。 此物件是 invokeDDX
作業。
儲存包含書籤的PDF檔案
從傳回的地圖物件中擷取結果,並儲存對應的PDF檔案。 (請參閱中的「擷取結果」) 以程式設計方式組合PDF檔案.)
另請參閱
使用Java API彙編PDF檔案及書籤 assemble-pdf-documents-with-bookmarks-using-the-java-api
使用組合器服務API (Java)組合帶有書籤的PDF檔案:
-
包含專案檔案。
在您的Java專案的類別路徑中包含使用者端JAR檔案,例如adobe-assembler-client.jar。
-
建立PDF組合器使用者端。
- 建立
ServiceClientFactory
包含連線屬性的物件。 (請參閱 設定連線屬性.) - 建立
AssemblerServiceClient
物件,使用它的建構函式並傳遞ServiceClientFactory
物件。
- 建立
-
參考現有的DDX檔案。
- 建立
java.io.FileInputStream
物件,使用它的建構函式並傳遞字串值(指定DDX檔案的位置)來代表DDX檔案。 - 建立
com.adobe.idp.Document
物件,使用它的建構函式並傳遞java.io.FileInputStream
物件。
- 建立
-
參照新增書籤的PDF檔案。
- 建立
java.io.FileInputStream
物件,使用它的建構函式並傳遞PDF檔案的位置。 - 建立
com.adobe.idp.Document
物件,使用它的建構函式並傳遞java.io.FileInputStream
包含PDF檔案的物件。
- 建立
-
參考書籤XML檔案。
- 建立
java.io.FileInputStream
物件,使用它的建構函式,並傳遞代表書籤XML檔案的XML檔案的位置。 - 建立
com.adobe.idp.Document
物件並傳遞java.io.FileInputStream
包含PDF檔案的物件。
- 建立
-
將PDF檔案和書籤XML檔案新增至地圖集合。
-
建立
java.util.Map
用來儲存輸入PDF檔案和書籤XML檔案的物件。 -
PDF透過叫用
java.util.Map
物件的put
方法並傳遞下列引數:- 代表索引鍵名稱的字串值。 此值必須符合DDX檔案中指定的PDF來源元素的值。
- A
com.adobe.idp.Document
包含輸入PDF檔案的物件。
-
透過叫用
java.util.Map
物件的put
方法並傳遞下列引數:- 代表索引鍵名稱的字串值。 此值必須符合DDX檔案中指定的書籤來源元素值。
- A
com.adobe.idp.Document
包含書籤XML檔案的物件。
-
-
設定執行階段選項。
- 建立
AssemblerOptionSpec
使用建構函式來儲存執行階段選項的物件。 - 透過叫用屬於下列專案的方法,設定執行階段選項以符合您的業務需求
AssemblerOptionSpec
物件。 例如,若要指示Assembler服務在發生錯誤時繼續處理工作,請叫用AssemblerOptionSpec
物件的setFailOnError
方法與傳遞false
.
- 建立
-
組合PDF檔案。
叫用
AssemblerServiceClient
物件的invokeDDX
方法並傳遞下列必要值:- A
com.adobe.idp.Document
代表要使用的DDX檔案的物件 - A
java.util.Map
同時包含輸入PDF檔案與書籤XML檔案的物件。 - A
com.adobe.livecycle.assembler.client.AssemblerOptionSpec
指定執行階段選項的物件,包括預設字型和作業記錄層級
此
invokeDDX
方法傳回com.adobe.livecycle.assembler.client.AssemblerResult
包含工作結果和發生之任何例外狀況的物件。 - A
-
儲存包含書籤的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檔案
使用Web服務API彙編PDF檔案及書籤 assemble-pdf-documents-with-bookmarks-using-the-web-service-api
使用Assembler Service 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
物件,使用它的預設建構函式。 -
建立
AssemblerServiceClient.Endpoint.Address
物件,使用System.ServiceModel.EndpointAddress
建構函式。 將指定WSDL的字串值傳遞至AEM Forms服務(例如,http://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
.
- 將AEM表單使用者名稱指派給欄位
-
-
參考現有的DDX檔案。
- 建立
BLOB
物件(使用其建構函式)。 此BLOB
物件可用來儲存DDX檔案。 - 建立
System.IO.FileStream
物件,方法是叫用其建構函式,並傳遞代表DDX檔案檔案位置及開啟檔案的模式的字串值。 - 建立位元組陣列,儲存
System.IO.FileStream
物件。 您可以取得System.IO.FileStream
物件的Length
屬性。 - 透過叫用
System.IO.FileStream
物件的Read
方法,並傳遞位元組陣列、起始位置以及要讀取的資料流長度。 - 填入
BLOB
物件,透過指派其MTOM
包含位元組陣列內容的欄位。
- 建立
-
參照新增書籤的PDF檔案。
- 建立
BLOB
物件(使用其建構函式)。 此BLOB
物件是用來儲存輸入PDF。 - 建立
System.IO.FileStream
物件,方法是叫用其建構函式,並傳遞代表輸入PDF檔案的檔案位置以及開啟檔案的模式的字串值。 - 建立位元組陣列,儲存
System.IO.FileStream
物件。 您可以取得System.IO.FileStream
物件的Length
屬性。 - 透過叫用
System.IO.FileStream
物件的Read
方法,並傳遞位元組陣列、起始位置以及要讀取的資料流長度。 - 填入
BLOB
物件,透過指派其MTOM
包含位元組陣列內容的欄位。
- 建立
-
參考書籤XML檔案。
- 建立
BLOB
物件(使用其建構函式)。 此BLOB
物件可用來儲存書籤XML檔案。 - 建立
System.IO.FileStream
物件,方法是叫用其建構函式,並傳遞代表輸入PDF檔案的檔案位置以及開啟檔案的模式的字串值。 - 建立位元組陣列,儲存
System.IO.FileStream
物件。 您可以取得System.IO.FileStream
物件的Length
屬性。 - 透過叫用
System.IO.FileStream
物件的Read
方法,並傳遞位元組陣列、起始位置以及要讀取的資料流長度。 - 填入
BLOB
物件,透過指派其MTOM
包含位元組陣列內容的欄位。
- 建立
-
將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來源元素的值。 - 指派
BLOB
將PDF檔案儲存到的物件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檔案執行此工作。)
- 建立
-
設定執行階段選項。
- 建立
AssemblerOptionSpec
使用建構函式來儲存執行階段選項的物件。 - 將值指派給屬於下列專案的資料成員,以設定執行階段選項以符合您的業務需求
AssemblerOptionSpec
物件。 例如,若要指示Assembler服務在發生錯誤時繼續處理工作,請指派false
至AssemblerOptionSpec
物件的failOnError
資料成員。
- 建立
-
組合PDF檔案。
叫用
AssemblerServiceClient
物件的invokeDDX
方法並傳遞下列值:- A
BLOB
代表DDX檔案的物件 - 此
MyMapOf_xsd_string_To_xsd_anyType
包含輸入檔案的陣列 - 一個
AssemblerOptionSpec
指定執行階段選項的物件
此
invokeDDX
方法傳回AssemblerResult
包含工作結果及可能發生之任何例外狀況的物件。 - A
-
儲存包含書籤的PDF檔案。
若要取得新建立的PDF檔案,請執行下列動作:
- 存取
AssemblerResult
物件的documents
欄位,即Map
包含結果PDF檔案的物件。 - 逐一檢視
Map
物件,直到您找到符合結果檔名稱的鍵為止。 然後轉換該陣列成員的value
至BLOB
. - 存取代表PDF檔案的二進位資料
BLOB
物件的MTOM
欄位。 這會傳回您可以寫出至PDF檔案的位元組陣列。
- 存取
另請參閱