轉譯互動式PDF forms

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

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

注意

使用Forms服務演算表單之前,請先建立表單設計。 通常,表單設計會在設計工具中建立,並儲存為XDP檔案。 如需建立表單設計的相關資訊,請參閱 Forms Designer.

貸款申請示例

推出了範例貸款應用程式,以示範Forms服務如何使用互動式表單來收集使用者的資訊。 此應用程式可讓使用者填寫表單,其中含有確保貸款安全所需的資料,然後將資料提交至Forms服務。 下圖顯示貸款應用程式的邏輯流程。

ri_ri_finsrv_loanapp_v1

下表說明此圖中的步驟。

步驟

說明

1

GetLoanForm 從HTML頁面叫用Java Servlet。

2

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

3

使用者填寫貸款表單並按一下提交按鈕後,資料會提交至 HandleData Java Servlet。 (請參閱 "貸款表".)

4

HandleData Java Servlet使用Forms服務用戶端API來處理表單提交和擷取表單資料。 然後,將資料儲存在企業資料庫中。 (請參閱 處理已提交的Forms.)

5

確認表格會呈現回網頁瀏覽器。 使用者的名字和姓氏等資料在轉譯前會與表單合併。 (請參閱 使用可流式配置預填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的 doGetdoPost 方法。 將此程式碼放置在個別類別中,從中實例化類別,是最佳的程式設計實務 doPost 方法(或 doGet 方法),並呼叫適當的方法。 不過,為了簡化程式碼,本節中的程式碼範例會維持在最小,而程式碼範例會放置在 doPost 方法。

注意

如需Forms服務的詳細資訊,請參閱 AEM Forms服務參考.

步驟摘要

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

  1. 包含專案檔案。
  2. 建立Forms用戶端API物件。
  3. 指定URI值。
  4. 將檔案附加到表單(可選)。
  5. 轉譯互動式PDF表單。
  6. 將表單資料流寫入客戶端Web瀏覽器。

包含項目檔案

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

建立Forms用戶端API物件

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

指定URI值

您可以指定Forms服務呈現表單所需的URI值。 儲存為Forms應用程式一部分的表單設計,可使用內容根URI值來參照 repository:///. 例如,請考量下清單單設計,命名為 Loan.xdp 位於Forms應用程式中,名為 FormsApplication:

ri_ri_formrepository

若要存取此表單設計,請指定 Applications/FormsApplication/1.0/FormsFolder/Loan.xdp 作為表單名稱(傳遞至 renderPDFForm 方法)和 repository:/// 作為內容根URI值。

注意

如需使用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。 (請參閱 計算表單資料.)

注意

您也可以傳遞 com.adobe.idp.Document 例項至Forms服務。 此 com.adobe.idp.Document 例項包含表單設計。 (請參閱 將檔案傳遞至Forms服務.)

將檔案附加到表單

您可以將檔案附加到表單。 當您呈現包含檔案附件的PDF表單時,使用者可以使用檔案附件窗格在Acrobat中擷取檔案附件。 您可以將不同的檔案類型附加到表單(如文本檔案)或二進位檔案(如JPG檔案)。

注意

將檔案附件附加到表單是可選的。

轉譯互動式PDF表單

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

renderPDFForm 使用 URLSpec 物件。 XDP檔案的內容根目錄會使用 URLSpec 物件 setContentRootURI 方法。 表單設計名稱( formQuery)會以個別參數值的形式傳遞。 這兩個值會串連,以取得表單設計的絕對參照。

renderPDFForm2 方法接受 com.adobe.idp.Document 包含要呈現的XDP或PDF檔案的例項。

注意

如果輸入文檔是PDF文檔,則無法設定標籤的PDF運行時選項。 如果輸入檔案是XDP檔案,則可以設定標籤的PDF選項。

使用Java API轉譯互動式PDF表單

使用Forms API(Java)轉譯互動式PDF表單:

  1. 包含項目檔案

    在Java專案的類別路徑中加入用戶端JAR檔案,例如adobe-forms-client.jar。

  2. 建立Forms用戶端API物件

    • 建立 ServiceClientFactory 包含連接屬性的對象。
    • 建立 FormsServiceClient 對象,使用其建構子並傳遞 ServiceClientFactory 物件。
  3. 指定URI值

    • 建立 URLSpec 使用其建構子儲存URI值的物件。
    • 叫用 URLSpec 物件 setApplicationWebRoot 方法,並傳遞代表應用程式網頁根的字串值。
    • 叫用 URLSpec 物件 setContentRootURI 方法,並傳遞指定內容根URI值的字串值。 確保表單設計位於內容根URI中。 否則,Forms服務會擲回例外狀況。 要引用儲存庫,請指定 repository:///.
    • 叫用 URLSpec 物件 setTargetURL 方法,並傳遞字串值,指定表單資料張貼到的目標URL值。 如果您在表單設計中定義目標URL,則可以傳遞空字串。 您也可以指定表單要傳送到哪個URL,以執行計算。
  4. 將檔案附加到表單

    • 建立 java.util.HashMap 對象,使用其建構子儲存檔案附件。

    • 叫用 java.util.HashMap 物件 put 方法,以附加至呈現的表單。 將下列值傳遞至此方法:

      • 指定檔案附件名稱的字串值,包括檔案名副檔名。
    • A com.adobe.idp.Document 包含檔案附件的對象。

    注意

    對要附加到表單的每個檔案重複此步驟。 此步驟為選填,您可以通過 null 如果您不想傳送檔案附件。

  5. 轉譯互動式PDF表單

    叫用 FormsServiceClient 物件 renderPDFForm 方法,並傳遞下列值:

    • 指定表單設計名稱的字串值,包括檔案名副檔名。 如果您參考屬於Forms應用程式一部分的表單設計,請務必指定完整路徑,例如 Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • A com.adobe.idp.Document 包含要與表單合併資料的物件。 如果您不想合併資料,請傳遞空白 com.adobe.idp.Document 物件。
    • A PDFFormRenderSpec 儲存運行時選項的對象。 這是選用參數,您可以指定 null 如果您不想指定執行時選項。
    • A URLSpec 包含Forms服務所需URI值的物件。
    • A java.util.HashMap 儲存檔案附件的物件。 這是選用參數,您可以指定 null 如果您不想將檔案附加到表單。

    renderPDFForm 方法傳回 FormsResult 包含必須寫入客戶端web瀏覽器的表單資料流的對象。

  6. 將表單資料流寫入客戶端Web瀏覽器

    • 建立 com.adobe.idp.Document 對象,方法是調用 FormsResult 物件s getOutputContent 方法。
    • 取得 com.adobe.idp.Document 對象 getContentType 方法。
    • 設定 javax.servlet.http.HttpServletResponse 對象的內容類型,方法是調用 setContentType 方法,並傳遞 com.adobe.idp.Document 物件。
    • 建立 javax.servlet.ServletOutputStream 用於通過調用 javax.servlet.http.HttpServletResponse 物件 getOutputStream 方法。
    • 建立 java.io.InputStream 對象,方法是調用 com.adobe.idp.Document 物件 getInputStream 方法。
    • 建立位元組陣列,並叫用 InputStream 物件 read 方法,並將位元組陣列傳遞為引數。
    • 叫用 javax.servlet.ServletOutputStream 物件 write 將表單資料流傳送至用戶端網頁瀏覽器的方法。 將位元組陣列傳遞至 write 方法。

使用網站服務API轉譯互動式PDF表單

使用Forms API(網站服務)轉譯互動式PDF表單:

  1. 包含項目檔案

    • 建立使用Forms服務WSDL的Java代理類。
    • 將Java代理類包含到類路徑中。
  2. 建立Forms用戶端API物件

    建立 FormsService 對象和設定驗證值。

  3. 指定URI值

    • 建立 URLSpec 使用其建構子儲存URI值的物件。
    • 叫用 URLSpec 物件 setApplicationWebRoot 方法,並傳遞代表應用程式網頁根的字串值。
    • 叫用 URLSpec 物件 setContentRootURI 方法,並傳遞指定內容根URI值的字串值。 確保表單設計位於內容根URI中。 否則,Forms服務會擲回例外狀況。 要引用儲存庫,請指定 repository:///.
    • 叫用 URLSpec 物件 setTargetURL 方法,並傳遞字串值,指定表單資料張貼到的目標URL值。 如果您在表單設計中定義目標URL,則可以傳遞空字串。 您也可以指定表單要傳送到哪個URL,以執行計算。
  4. 將檔案附加到表單

    • 建立 java.util.HashMap 對象,使用其建構子儲存檔案附件。

    • 叫用 java.util.HashMap 物件 put 方法,以附加至呈現的表單。 將下列值傳遞至此方法:

      • 指定檔案附件名稱的字串值,包括檔案名副檔名
    • A BLOB 包含檔案附件的對象

    注意

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

  5. 轉譯互動式PDF表單

    叫用 FormsService 物件 renderPDFForm 方法,並傳遞下列值:

    • 指定表單設計名稱的字串值,包括檔案名副檔名。 如果您參考屬於Forms應用程式一部分的表單設計,請務必指定完整路徑,例如 Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • A BLOB 包含要與表單合併資料的物件。 如果您不想合併資料,請傳遞 null.
    • A PDFFormRenderSpec 儲存運行時選項的對象。 這是選用參數,您可以指定 null 如果您不想指定執行時選項。
    • A URLSpec 包含Forms服務所需URI值的物件。
    • A 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 作為最後一個引數值傳遞的物件,具有必須寫入用戶端網頁瀏覽器的表單資料流。

  6. 將表單資料流寫入客戶端Web瀏覽器

    • 建立 FormResult 物件,方法是取得 com.adobe.idp.services.holders.FormsResultHolder 物件 value 資料成員。
    • 建立 BLOB 包含表單資料的物件,方法是叫用 FormsResult 物件 getOutputContent 方法。
    • 取得 BLOB 對象 getContentType 方法。
    • 設定 javax.servlet.http.HttpServletResponse 對象的內容類型,方法是調用 setContentType 方法,並傳遞 BLOB 物件。
    • 建立 javax.servlet.ServletOutputStream 用於通過調用 javax.servlet.http.HttpServletResponse 物件 getOutputStream 方法。
    • 建立位元組陣列,並叫用 BLOB 物件 getBinaryData 方法。 此任務分配 FormsResult 位元組陣列的物件。
    • 叫用 javax.servlet.http.HttpServletResponse 物件 write 將表單資料流傳送至用戶端網頁瀏覽器的方法。 將位元組陣列傳遞至 write 方法。

將表單資料流寫入客戶端Web瀏覽器

Forms服務轉譯表單時,會傳回您必須寫入用戶端網頁瀏覽器的表單資料流。 寫入客戶端Web瀏覽器時,用戶可以看到該表單。

本頁內容