根據片段轉譯Forms

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

根據片段轉譯Forms

Forms服務可呈現以您使用Designer建立之片段為基礎的表單。 fragment​是表單的可重複使用部分，並儲存為可插入到多個表單設計中的獨立XDP檔案。 例如，片段可以包含地址塊或法律文字。

使用片段可簡化及加速大量表單的建立與維護作業。 建立新表單時，您會插入對所需片段的參考，片段會出現在表單中。 片段參考包含指向物理XDP檔案的子表單。 如需根據片段建立表單設計的相關資訊，請參閱Forms Designer

片段可以包括包裝在選擇子表單集中的多個子表單。 選擇子表單集基於來自資料連接的資料流控制子表單的顯示。 您可以使用條件陳述式來判斷傳送的表單中，會出現集內的子表單。 例如，集合中的每個子表單可以包括特定地理位置的資訊，並且可以根據用戶的位置確定顯示的子表單。

指令碼片段​包含可重複使用的JavaScript函式或值，這些函式或值與任何特定對象（如日期解析器或Web服務調用）分開儲存。 這些片段包含單一指令碼物件，在階層浮動視窗中顯示為變數的子項。 無法從屬於其他物件屬性的指令碼建立片段，例如驗證、計算或初始化等事件指令碼。

以下是使用片段的優點：

• 內容重複使用:您可以使用片段來重複使用多個表單設計中的內容。當您需要在多個表單中使用某些相同內容時，使用片段比複製或重新建立內容更快更簡單。 使用片段也可確保經常使用的表單設計部分在所有參考表單中具有一致的內容和外觀。
• 全域更新:您只能在一個檔案中使用片段對多個表單進行一次全域變更。您可以變更片段中的內容、指令碼物件、資料系結、版面或樣式，而所有參考片段的XDP表單將反映變更。
• 例如，許多表單中的通用元素可能是地址塊，其中包含國家/地區的下拉式清單物件。 如果需要更新下拉式清單物件的值，您必須開啟許多表單才能進行變更。 如果您將地址塊包含在片段中，則只需開啟一個片段檔案即可進行變更。
• 若要更新PDF表單中的片段，您必須在Designer中重新儲存表單。
• 共用表單建立:您可以使用片段，在多個資源間共用表單的建立作業。具備指令碼或其他Designer進階功能的表單開發人員可開發及共用片段，善用指令碼和動態屬性。 表單設計人員可以使用這些片段來設計表單設計，並確保表單的所有部分在由多人設計的多個表單中具有一致的外觀和功能。

使用片段組裝表單設計

您可以根據多個片段組合表單設計以傳遞至Forms服務。 要組合多個片段，請使用組合器服務。 若要查看使用組合服務建立其他Forms服務（輸出服務）所使用的表單設計的範例，請參閱使用片段建立PDF檔案。 您可以使用Forms服務來執行相同的工作流程，而不使用輸出服務。

使用組合器服務時，您正在傳遞使用片段組合的表單設計。 建立的表單設計不會參考其他片段。 相反地，本主題探討如何將參考其他片段的表單設計傳遞至Forms服務。 但是，表單設計不是由組合器裝配的。 是在Designer中建立的。

步驟的摘要

若要根據片段轉譯表單，請執行下列工作：

1. 包含專案檔案。
2. 建立Forms用戶端API物件。
3. 指定URI值。
4. 轉譯表單。
5. 將表單資料流寫入客戶端Web瀏覽器。

包含項目檔案

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

建立Forms用戶端API物件

您必須先建立Forms服務用戶端，才能以程式設計方式執行Forms服務用戶端API作業。

指定URI值

若要根據片段成功轉譯表單，您必須確定Forms服務可以找到表單設計所參考的表單和片段（XDP檔案）。 例如，假設表單名為PO.xdp，且此表單使用名為FooterUS.xdp和FooterCanada.xdp的兩個片段。 在此情況下，Forms服務必須能夠找到所有三個XDP檔案。

您可以將表單放在一個位置，並將片段放在另一個位置，借此組織表單及其片段，或將所有XDP檔案放在相同位置。 就本節而言，假設所有XDP檔案都位於AEM Forms存放庫。 有關將XDP檔案放入AEM Forms儲存庫的資訊，請參閱寫入資源。

根據片段轉譯表單時，您只能參考表單本身，不能參考片段。 例如，您必須參考PO.xdp，而非FooterUS.xdp或FooterCanada.xdp。 請確定您將片段放置在Forms服務可找到的位置。

轉譯表單

基於片段的表單可以與非碎片表單相同的方式呈現。 也就是說，您可以將表單轉譯為PDF、HTML或表單參考線（已過時）。 本節中的範例將以片段為基礎的表單轉譯為互動式PDF表單。 (請參閱轉譯互動式PDF forms。)

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

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

另請參閱

使用Java API根據片段呈現表單

使用網站服務API根據片段轉譯表單

包含AEM Forms Java程式庫檔案

設定連接屬性

Forms服務API快速入門

轉譯互動式PDF forms

建立可轉譯Forms的網頁應用程式

使用Java API根據片段轉譯表單

使用Forms API(Java)根據片段轉譯表單：

1. 包含項目檔案

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

2. 建立Forms用戶端API物件

   • 建立包含連接屬性的ServiceClientFactory對象。
   • 使用其建構子並傳遞ServiceClientFactory物件，以建立FormsServiceClient物件。

3. 指定URI值

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

4. 轉譯表單

   調用FormsServiceClient對象的renderPDFForm方法並傳遞以下值：

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

   renderPDFForm方法返回一個FormsResult對象，該對象包含必須寫入客戶端Web瀏覽器的表單資料流。

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

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

另請參閱

根據片段轉譯Forms

快速入門（SOAP模式）:使用Java API根據片段轉譯表單

包含AEM Forms Java程式庫檔案

設定連接屬性

使用網站服務API根據片段轉譯表單

使用Forms API（網站服務）根據片段轉譯表單：

1. 包含項目檔案

   • 建立使用Forms服務WSDL的Java代理類。
   • 將Java代理類包含到類路徑中。

2. 建立Forms用戶端API物件

   建立FormsService物件並設定驗證值。

3. 指定URI值

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

4. 轉譯表單

   調用FormsService對象的renderPDFForm方法並傳遞以下值：

   • 指定表單設計名稱的字串值，包括檔案名副檔名。 如果您參考屬於Forms應用程式一部分的表單設計，請務必指定完整路徑，例如Applications/FormsApplication/1.0/FormsFolder/Loan.xdp。
   • BLOB物件，包含要與表單合併的資料。 如果您不想合併資料，請傳遞null。
   • 儲存運行時選項的PDFFormRenderSpec對象。 請注意，如果輸入文檔是PDF文檔，則無法設定標籤的PDF選項。 如果輸入檔案是XDP檔案，則可以設定標籤的PDF選項。
   • URLSpec物件，包含Forms服務所需的URI值。
   • 儲存檔案附件的java.util.HashMap對象。 這是可選參數，如果不想將檔案附加到表單，可以指定null。
   • 由方法填入的空com.adobe.idp.services.holders.BLOBHolder物件。 此參數用於儲存已呈現的表單。
   • 由方法填入的空javax.xml.rpc.holders.LongHolder物件。 此引數會以表單儲存頁數。
   • 由方法填入的空javax.xml.rpc.holders.StringHolder物件。 此參數將儲存區域設定值。
   • 將包含此操作結果的空com.adobe.idp.services.holders.FormsResultHolder對象。

   renderPDFForm方法會以必須寫入用戶端網頁瀏覽器的表單資料流填入作為最後一個引數值傳遞的com.adobe.idp.services.holders.FormsResultHolder物件。

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

   • 獲取com.adobe.idp.services.holders.FormsResultHolder對象的value資料成員的值，以建立FormResult對象。
   • 調用FormsResult對象的getOutputContent方法，建立包含表單資料的BLOB對象。
   • 調用getContentType方法，獲取BLOB對象的內容類型。
   • 通過調用setContentType方法並傳遞BLOB對象的內容類型來設定javax.servlet.http.HttpServletResponse對象的內容類型。
   • 通過調用javax.servlet.http.HttpServletResponse對象的getOutputStream方法，建立用於將表單資料流寫入客戶端Web瀏覽器的javax.servlet.ServletOutputStream對象。
   • 建立位元組陣列，並調用BLOB對象的getBinaryData方法來填入。 此任務將FormsResult對象的內容分配給位元組陣列。
   • 調用javax.servlet.http.HttpServletResponse對象的write方法，將表單資料流發送到客戶端Web瀏覽器。 將位元組陣列傳遞至write方法。

另請參閱

根據片段轉譯Forms

使用Base64編碼叫用AEM Forms