Show Menu
主題×

事務處理報表可開單API

AEM Forms提供數個API來提交表單、處理檔案和演算檔案。 有些API會以交易方式入賬,而有些則可免費使用。 本檔案提供在交易報表中以交易方式入賬的所有API的清單。 以下是使用計費API的一些常見方案:
  • 提交最適化表單、HTML5表單和表單集
  • 呈現互動式通訊的平面或網頁版本
  • 將文檔從一種格式轉換為另一種格式
  • 平面化動態PDF檔案
  • 生成記錄文檔
  • 將互動式PDF檔案與其他PDF檔案合併
  • 使用AEM工作流程的指派工作步驟和檔案服務步驟
  • 在自適應表單中使用自適應表單
帳單API不會計入頁數、檔案或表單的長度,或轉譯檔案的最終格式。 事務報表將事務分為兩類:已轉譯的檔案和已提交的表單。
  • 提交的表單:當從使用AEM Forms建立的任何類型表單提交資料,且資料會提交至任何資料儲存存放庫或資料庫時,即視為表單提交。 例如,提交最適化表單、HTML5表單、PDF表單和表單集都會視為提交的表單。 表單集中的每個表單都被視為提交。 例如,如果表單集有5個表單,提交表單集時,事務報告服務會將其計為5個提交。
  • 轉譯的檔案:通過組合模板和資料、數字地簽名或認證文檔、使用文檔服務的可計費文檔服務API或將文檔從一種格式轉換為另一種格式來生成文檔,被視為所呈現的文檔。
交易報表UI會顯示三個類別:已提交的表單、已轉譯的檔案和已處理的檔案。 所呈現的文檔和所處理的文檔均作為所呈現的文檔入賬。

可計費的檔案服務API

產生PDF服務

API
說明 事務處理報告類別 其他資訊
createPDF 從支援的檔案類型建立Adobe PDF。 已處理的文件
createPDF2 從支援的檔案類型建立Adobe PDF。 已處理的文件
exportPDF 將Adobe PDF轉換為支援的檔案類型。 已處理的文件
exportPDF2 將Adobe PDF轉換為支援的檔案類型。 已處理的文件
exportPDF3 將Adobe PDF轉換為支援的檔案類型。 已處理的文件
htmlFileToPdf
從HTML頁面建立PDF。
已處理的文件
htmlToPdf 從指向HTML頁面的URL建立PDF。 已處理的文件
htmlToPdf2 從指向HTML頁面的URL建立PDF。 已處理的文件
最佳化PDF 最佳化PDF,借由移除不必要的中繼資料來減少檔案大小,而不會影響品質。 已處理的文件

Distiller Service

API
說明 事務處理報告類別 其他資訊
createPDF 從支援的檔案類型建立Adobe PDF。 已處理的文件
createPDF2 從支援的檔案類型建立Adobe PDF。 已處理的文件

記錄服務檔案(DoR服務)

API
說明 事務處理報告類別 其他資訊
渲染 調用指定的渲染方法以使用提供的參數生成記錄文檔。 已處理的文件

輸出服務

API
說明 事務處理報告類別 其他資訊
generatePDFOutput 合併資料和範本以建立PDF檔案。 已處理的文件
generatePDFOutput 合併資料和範本以建立PDF檔案。 已處理的文件
generatePDFOutputBatch 合併資料和範本以建立一組PDF檔案。 已處理的文件 generatePDFOutputBatch API將表單範本與記錄結合,並產生PDF。 當您處理一批記錄時,交易報告服務會將每個記錄計為個別的PDF轉譯。 您可以使用 getGenerateManyFiles旗標 ,將多個轉譯合併為單一PDF檔案。 不論旗標狀態為何,服務都會將每個記錄計為個別的PDF轉譯。
generatePrintedOutput 將XDP和PDF檔案轉換為PostScript(PS)、印表機命令語言(PCL)和ZPL檔案格式。 已處理的文件
generatePrintedOutput 將XDP和PDF檔案轉換為PostScript(PS)、印表機命令語言(PCL)和ZPL檔案格式。 已處理的文件
generatePrintedOutputBatch 將一組XDP和PDF檔案轉換為一組PostScript(PS)、印表機命令語言(PCL)和ZPL檔案格式。 已處理的文件 generatePDFOutputBatch API將表單範本與記錄結合,並產生PDF。 當您處理一批記錄時,交易報告服務會將每個記錄計為個別的PDF轉譯。 您可以使用 getGenerateManyFiles旗標 ,將多個轉譯合併為單一PDF檔案。 不論旗標狀態為何,服務都會將每個記錄計為個別的PDF轉譯。

表單服務

API
說明 事務處理報告類別 其他資訊
renderPDFForm 從XDP範本轉譯PDF表單。 XP範本是在Forms Designer中建立的。 已處理的文件
exportData 從PDF表單或XDP範本擷取資料 已處理的文件

轉換PDF服務

API
說明 事務處理報告類別 其他資訊
toImage 將PDF檔案轉換為影像檔案清單。 支援的影像格式包括JPEG、JPEG2K、PNG和TIFF。 已處理的文件
toPS 使用選項規範中指定的選項將平面PDF檔案轉換為PostScript格式。 已處理的文件

Barcoded Forms服務

API
說明 事務處理報告類別 其他資訊
解碼 解碼Document物件中的所有條碼,並傳回包含從條碼擷取之資料的org.w3c.dom.Document物件。 已處理的文件

Assembler Service

API
說明 事務處理報告類別 其他資訊
調用 執行指定的DDX文檔並返回包 含結果文檔的AssemblerResult 對象。 已處理的文件 下列業務不會作為交易入賬:
  • 建立套件或作品集
  • 拼接多個XDP
調用 執行指定的DDX文檔並返回包 含結果文檔的AssemblerResult 對象。 已處理的文件 Assembler服務支援PDF產生器、表單和輸出服務支援的所有輸入檔案格式,支援所有這些格式做為輸出檔案格式。
toPDFA 使用指定的選項,將指定的檔案轉換為PDF/A。 已處理的文件
  • 匯編器服務的調用API可以根據輸入在內部調用另一服務的計費API。 因此,調用API可以作為無、單個或多個事務處理來處理。 計算的交易數量取決於輸入和呼叫的內部API。
  • 使用匯編器服務生成的單個PDF文檔可以作為無、單個或多個事務處理來處理。 計算的交易數量取決於提供的DDX代碼。

PDF公用程式服務

API
說明 事務處理報告類別 其他資訊
convertPDFtoXDP 將PDF檔案轉換為XDP檔案。 為了讓PDF檔案成功轉換為XDP檔案,PDF檔案必須在AcroForm字典中包含XFA串流。 已處理的文件

計費資料擷取API

最適化表單、HTML5表單和表單集的所有提交事件都視為交易。 依預設,提交PDF表單不會算作交易。 使用提供的 交易記錄API ,將PDF表單提交記錄為交易。

適用性表單

使用案例
說明 事務處理報告類別 其他資訊
提交最適化表單 提交最適化表單以設定提交動作。 已提交的表單
  • 成功的提交包含單筆或兩筆交易。 計算的事務處理數取決於用於提交的提交操作類型。 例如,透過電子郵件提交動作帳戶傳送PDF,可計算兩筆交易。 使用記錄檔案(DOR)服務產生的一筆表單提交交易和另一筆PDF交易。
  • 在最適化表單(最適化表單集)中使用最適化表單只會計入單一交易。 您可以在最適化表單中擁有任意數量的最適化表單。

HTML5 Forms

使用案例
說明 事務處理報告類別 其他資訊
送出HTML5表格 提交HTML5表單以提交表單中設定的URL。 已提交的表單

表單集

API
說明 事務處理報告類別 其他資訊
提交表單集 將表單集提交到表單集中配置的提交URL。 已提交的表單
  • 在最適化表單(最適化表單集)中使用最適化表單只會計入單一交易。 您可以在最適化表單中擁有任意數量的最適化表單。
  • HTML5 Forms表單中的每個表單都會將帳戶設定為個別交易。

OSGi API上的計費互動式通訊和表單導向AEM工作流程

在OSGi上指派表單導向AEM工作流程的工作和檔案服務步驟,以及互動式通訊的所有轉譯,並視為交易處理。 在作者例項上預覽互動式通訊,並使用Agent UI在發佈例項上預覽,不會算作交易。 如果工作流步驟將事務處理入帳,而工作流無法完成,則不會撤消事務處理計數。

互動式通訊 - Web Channel

API
說明 事務處理報告類別 其他資訊
呈現網路頻道 開啟互動式通訊的網頁版本。 已呈交的文件

Interactive Communication - Print Channel

API
說明 事務處理報告類別 其他資訊
轉換 (轉換為PDF) 產生互動式通訊的PDF版本。 已呈交的文件

OSGi上的表單導向AEM工作流程

使用案例
事務處理報告類別 其他資訊
提交分配任務步驟 已提交的表單
提交工作流程應用程式起點 已提交的表單
將互動式通訊(列印頻道)從代理UI送出至工作流程 已呈交的文件

將可計費API記錄為自訂代碼的交易

諸如提交PDF表單、使用代理UI預覽互動式通訊、使用非標準表單提交和自訂實作等動作,不會算作交易。 AEM Forms提供API來記錄這類動作,例如交易。 您可以從自訂實作呼叫API以記 錄交易