呈現互動式PDF forms rendering-interactive-pdf-forms

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

主題：

建立對象：

開發人員

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

Forms服務會將互動式PDF forms轉譯給使用者端裝置（通常是網頁瀏覽器），以收集使用者的資訊。呈現互動式表單後，使用者可在表單欄位中輸入資料，然後按一下表單上的提交按鈕，將資訊傳回Forms服務。使用者端Web瀏覽器所在的電腦上必須安裝Adobe Reader或Acrobat，互動式PDF表單才能顯示。

NOTE

使用Forms服務轉譯表單前，請先建立表單設計。通常，表單設計會在Designer中建立並儲存為XDP檔案。如需建立表單設計的相關資訊，請參閱Forms Designer。

範例貸款申請

我們匯入了一個貸款申請範例，以示範Forms服務如何使用互動式表單來收集使用者的資訊。此應用程式可讓使用者填寫安全貸款所需的資料表單，然後將資料提交至Forms服務。下圖顯示貸款應用程式的邏輯流程。

ri_ri_finsrv_loanapp_v1

下表說明此圖表中的步驟。

步驟

說明

從HTML頁面叫用GetLoanForm Java Servlet。

GetLoanForm Java Servlet使用Forms服務使用者端API將貸款表單轉譯給使用者端網頁瀏覽器。 (請參閱使用Java API演算互動式PDF表單。)

使用者填寫貸款表單並按一下提交按鈕後，資料就會提交至HandleData Java Servlet。（請參閱 「貸款表單」。）

HandleData Java Servlet使用Forms服務使用者端API來處理表單提交作業並擷取表單資料。然後，資料會儲存在企業資料庫中。 (請參閱處理已提交的Forms。)

確認表單會轉譯回網頁瀏覽器。如使用者的名字和姓氏等資料會在呈現之前與表單合併。 (請參閱使用可流動配置預先填入Forms。)

貸款表單

此互動式貸款表單是由範例貸款申請的GetLoanForm Java Servlet轉譯。

ri_ri_loanform

確認表單

此表單由範例貸款申請的HandleData Java Servlet轉譯。

ri_ri_confirm

HandleData Java Servlet會使用使用者的名字和姓氏以及金額預先填入此表單。預先填入表單後，會傳送給使用者端網頁瀏覽器。 (請參閱使用可流動版面配置預先填入Forms)

Java Servlet

範例貸款應用程式是以Java Servlet存在的Forms服務應用程式範例。 Java Servlet是在J2EE應用程式伺服器（例如WebSphere）上執行的Java程式，並包含Forms服務使用者端API程式碼。

下列程式碼顯示名為GetLoanForm的Java Servlet語法：

     public class GetLoanForm extends HttpServlet implements Servlet {
         public void doGet(HttpServletRequest req, HttpServletResponse resp
         throws ServletException, IOException {

         }
         public void doPost(HttpServletRequest req, HttpServletResponse resp
         throws ServletException, IOException {

             }

一般而言，您不會將Forms服務使用者端API程式碼放在Java Servlet的doGet或doPost方法中。程式設計實務最好將此程式碼放在個別的類別中，從doPost方法（或doGet方法）內將類別具現化，並呼叫適當的方法。不過，為了程式碼簡潔，本節中的程式碼範例會維持在最小值，而且程式碼範例會放在doPost方法中。

NOTE

如需Forms服務的詳細資訊，請參閱AEM Forms服務參考。

步驟摘要

若要呈現互動式PDF表單，請執行下列工作：

包含專案檔案。
建立Forms使用者端API物件。
指定URI值。
將檔案附加至表單（選擇性）。
呈現互動式PDF表單。
將表單資料流寫入使用者端網頁瀏覽器。

包含專案檔

將必要的檔案納入您的開發專案中。如果您使用Java建立使用者端應用程式，請包含必要的JAR檔案。如果您使用Web服務，請確定您包含Proxy檔案。

建立Forms使用者端API物件

您必須先建立Forms使用者端API物件，才能以程式設計方式執行Forms服務使用者端API作業。如果您使用Java API，請建立FormsServiceClient物件。如果您使用Forms Web服務API，請建立FormsService物件。

指定URI值

您可以指定Forms服務轉譯表單所需的URI值。使用內容根URI值repository:///可參考儲存為Forms應用程式一部分的表單設計。例如，假設下列名為 Loan.xdp 的表單設計位於名為 FormsApplication 的Forms應用程式中：

ri_ri_formrepository

若要存取此表單設計，請將Applications/FormsApplication/1.0/FormsFolder/Loan.xdp指定為表單名稱（傳遞給renderPDFForm方法的第一個引數），並將repository:///指定為內容根URI值。

NOTE

如需有關使用Workbench建立Forms應用程式的資訊，請參閱Workbench說明。

Forms應用程式中的資源路徑為：

Applications/Application-name/Application-version/Folder.../Filename

下列值顯示一些URI值的範例：

Applications/AppraisalReport/1.0/Forms/FullForm.xdp
Applications/AnotherApp/1.1/Assets/picture.jpg
Applications/SomeApp/2.0/Resources/Data/XSDs/MyData.xsd

當您轉譯互動式表單時，可以定義URI值，例如將表單資料發佈到的目標URL。目標URL可以下列其中一種方式定義：

在Designer中設計表單設計時按一下提交按鈕
透過使用Forms服務使用者端API

如果目標URL是在表單設計內定義，請勿使用Forms服務使用者端API加以覆寫。也就是說，使用Forms API設定目標URL會將表單設計中指定的URL重設為使用API指定的URL。如果您想要將PDF表單提交至表單設計中所指定的目標URL，則以程式設計方式將目標URL設為空字串。

如果您的表單包含提交按鈕和計算按鈕（具有在伺服器上執行的對應指令碼），您可以以程式設計方式定義傳送表單以執行指令碼的URL。使用表單設計上的提交按鈕來指定要將表單資料發佈到的URL。（請參閱計算表單資料。）

NOTE

您也可以將com.adobe.idp.Document執行個體傳遞至Forms服務，而不需指定URL值來參照XDP檔案。 com.adobe.idp.Document執行個體包含表單設計。 (請參閱將檔案傳遞至Forms服務。)

附加檔案至表單

您可以將檔案附加至表單。當您轉譯含有檔案附件的PDF表單時，使用者可以使用檔案附件窗格在Acrobat中擷取檔案附件。您可以將不同的檔案型別附加到表單（如文字檔案）或二進位檔案(如JPG檔案)。

NOTE

將檔案附件附加至表單為選用。

演算互動式PDF表單

若要轉譯表單，請使用在Designer中建立並儲存為XDP或PDF檔案的表單設計。您也可以呈現使用Acrobat建立並儲存為PDF檔案的表單。若要呈現互動式PDF表單，請叫用FormsServiceClient物件的renderPDFForm方法或renderPDFForm2方法。

renderPDFForm使用URLSpec物件。 XDP檔案的內容根目錄是使用URLSpec物件的setContentRootURI方法傳遞至Forms服務。表單設計名稱( formQuery)會以個別引數值傳遞。這兩個值會串連在一起，以取得表單設計的絕對參照。

renderPDFForm2方法接受包含要轉譯之XDP或PDF檔案的com.adobe.idp.Document執行個體。

NOTE

如果輸入檔案是PDF檔案，則無法設定標籤的PDF執行階段選項。如果輸入檔案是XDP檔案，則可以設定標籤的PDF選項。

使用Java API演算互動式PDF表單 render-an-interactive-pdf-form-using-the-java-api

使用Forms API (Java)演算互動式PDF表單：

包含專案檔案

在您的Java專案的類別路徑中包含使用者端JAR檔案，例如adobe-forms-client.jar。
建立Forms使用者端API物件
- 建立包含連線屬性的ServiceClientFactory物件。
- 使用它的建構函式並傳遞ServiceClientFactory物件來建立FormsServiceClient物件。
指定URI值
- 使用它的建構函式建立儲存URI值的URLSpec物件。
- 叫用URLSpec物件的setApplicationWebRoot方法，並傳遞代表應用程式網頁根目錄的字串值。
- 叫用URLSpec物件的setContentRootURI方法，並傳遞指定內容根URI值的字串值。確認表單設計位於內容根URI中。否則，Forms服務會擲回例外狀況。若要參考存放庫，請指定repository:///。
- 叫用URLSpec物件的setTargetURL方法，並傳遞字串值，該值指定要將表單資料張貼到的目標URL值。如果您在表單設計中定義目標URL，您可以傳遞空字串。您也可以指定傳送表單以執行計算的URL。

將檔案附加至表單

使用它的建構函式建立java.util.HashMap物件以儲存檔案附件。
對每個要附加到轉譯表單的檔案叫用java.util.HashMap物件的put方法。將下列值傳遞至此方法：
- 字串值，指定檔案附件的名稱，包括副檔名。
包含檔案附件的com.adobe.idp.Document物件。

note note
NOTE
對每個要附加到表單的檔案重複此步驟。此步驟是選擇性的，如果您不想傳送檔案附件，可以傳遞`null`。

演算互動式PDF表單

叫用FormsServiceClient物件的renderPDFForm方法，並傳遞下列值：
- 字串值，指定表單設計名稱，包括副檔名。如果您參照的表單設計屬於Forms應用程式的一部分，請確定您指定完整路徑，例如Applications/FormsApplication/1.0/FormsFolder/Loan.xdp。
- 包含要與表單合併之資料的com.adobe.idp.Document物件。如果您不想合併資料，請傳遞空的com.adobe.idp.Document物件。
- 儲存執行階段選項的PDFFormRenderSpec物件。這是選用引數，如果您不想指定執行階段選項，可以指定null。
- 包含Forms服務所需URI值的URLSpec物件。
- 儲存檔案附件的java.util.HashMap物件。這是選用引數，如果您不想將檔案附加至表單，可以指定null。
renderPDFForm方法傳回FormsResult物件，其中包含必須寫入使用者端網頁瀏覽器的表單資料流。
將表單資料流寫入使用者端網頁瀏覽器
- 呼叫FormsResult物件的getOutputContent方法，以建立com.adobe.idp.Document物件。
- 透過叫用物件的getContentType方法，取得com.adobe.idp.Document物件的內容型別。
- 透過叫用其setContentType方法並傳遞com.adobe.idp.Document物件的內容型別來設定javax.servlet.http.HttpServletResponse物件的內容型別。
- 呼叫javax.servlet.http.HttpServletResponse物件的getOutputStream方法，建立用來將表單資料流寫入使用者端網頁瀏覽器的javax.servlet.ServletOutputStream物件。
- 呼叫com.adobe.idp.Document物件的getInputStream方法，以建立java.io.InputStream物件。
- 呼叫InputStream物件的read方法，並將位元組陣列作為引數傳遞，以建立位元組陣列並以表單資料串流填入。
- 叫用javax.servlet.ServletOutputStream物件的write方法，將表單資料流傳送至使用者端網頁瀏覽器。將位元組陣列傳遞至write方法。

使用網站服務API呈現互動式PDF表單 render-an-interactive-pdf-form-using-the-web-service-api

使用Forms API （Web服務）演算互動式PDF表單：

包含專案檔案
- 建立使用Forms服務WSDL的Java Proxy類別。
- 將Java Proxy類別納入您的類別路徑中。
建立Forms使用者端API物件

建立FormsService物件並設定驗證值。
指定URI值
- 使用它的建構函式建立儲存URI值的URLSpec物件。
- 叫用URLSpec物件的setApplicationWebRoot方法，並傳遞代表應用程式網頁根目錄的字串值。
- 叫用URLSpec物件的setContentRootURI方法，並傳遞指定內容根URI值的字串值。確認表單設計位於內容根URI中。否則，Forms服務會擲回例外狀況。若要參考存放庫，請指定repository:///。
- 叫用URLSpec物件的setTargetURL方法，並傳遞字串值，該值指定要將表單資料張貼到的目標URL值。如果您在表單設計中定義目標URL，您可以傳遞空字串。您也可以指定傳送表單以執行計算的URL。

將檔案附加至表單

使用它的建構函式建立java.util.HashMap物件以儲存檔案附件。
對每個要附加到轉譯表單的檔案叫用java.util.HashMap物件的put方法。將下列值傳遞至此方法：
- 字串值，指定檔案附件的名稱，包括副檔名
包含檔案附件的BLOB物件

note note
NOTE
對每個要附加到表單的檔案重複此步驟。

演算互動式PDF表單

叫用FormsService物件的renderPDFForm方法，並傳遞下列值：
- 字串值，指定表單設計名稱，包括副檔名。如果您參照的表單設計屬於Forms應用程式的一部分，請確定您指定完整路徑，例如Applications/FormsApplication/1.0/FormsFolder/Loan.xdp。
- 包含要與表單合併之資料的BLOB物件。如果您不想合併資料，請傳遞null。
- 儲存執行階段選項的PDFFormRenderSpec物件。這是選用引數，如果您不想指定執行階段選項，可以指定null。
- 包含Forms服務所需URI值的URLSpec物件。
- 儲存檔案附件的java.util.HashMap物件。這是選用引數，如果您不想將檔案附加至表單，可以指定null。
- 方法填入的空白com.adobe.idp.services.holders.BLOBHolder物件。這可用來儲存轉譯的PDF表單。
- 方法填入的空白javax.xml.rpc.holders.LongHolder物件。（此引數會儲存表單中的頁數。）
- 方法填入的空白javax.xml.rpc.holders.StringHolder物件。（此引數將會儲存地區設定值。）
- 包含此作業結果的空白com.adobe.idp.services.holders.FormsResultHolder物件。
renderPDFForm方法會將必須寫入使用者端網頁瀏覽器的表單資料流，填入作為最後一個引數值傳遞的com.adobe.idp.services.holders.FormsResultHolder物件。
將表單資料流寫入使用者端網頁瀏覽器
- 取得com.adobe.idp.services.holders.FormsResultHolder物件之value資料成員的值，以建立FormResult物件。
- 呼叫FormsResult物件的getOutputContent方法，建立包含表單資料的BLOB物件。
- 透過叫用物件的getContentType方法，取得BLOB物件的內容型別。
- 透過叫用其setContentType方法並傳遞BLOB物件的內容型別來設定javax.servlet.http.HttpServletResponse物件的內容型別。
- 呼叫javax.servlet.http.HttpServletResponse物件的getOutputStream方法，建立用來將表單資料流寫入使用者端網頁瀏覽器的javax.servlet.ServletOutputStream物件。
- 建立位元組陣列，並透過叫用BLOB物件的getBinaryData方法來填入該陣列。此工作會將FormsResult物件的內容指派給位元組陣列。
- 叫用javax.servlet.http.HttpServletResponse物件的write方法，將表單資料流傳送至使用者端網頁瀏覽器。將位元組陣列傳遞至write方法。

將表單資料流寫入使用者端網頁瀏覽器

Forms服務轉譯表單時，會傳回您必須寫入使用者端網頁瀏覽器的表單資料流。寫入使用者端網頁瀏覽器時，使用者可看見表單。

recommendation-more-help

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