AEM Forms提供數個API,可提交表單、處理檔案及轉譯檔案。 有些API會記為交易,有些則可免費使用。 本文檔提供在事務處理報告中作為事務處理入帳的所有API的清單。 以下是使用計費API的一些常見案例:
計費API不會計入頁數、檔案或表單的長度,或轉譯檔案的最終格式。 事務處理報表將事務處理分為兩個類別:已呈現的檔案和Forms已提交。
Forms已提交: 從以AEM Forms建立的任何類型表單提交資料,且資料已提交至任何資料儲存存放庫或資料庫時,即視為表單提交。例如,提交最適化表單時,HTML5表單、PDF forms和表單集會計為提交的表單。 表單集中的每個表單都視為提交。 例如,如果表單集有5個表單,則提交表單集時,交易報告服務會將其計為5個提交。
已呈現的文檔: 通過組合模板和資料、數字簽名或認證文檔、使用可計費文檔服務API進行文檔服務,或將文檔從一種格式轉換為另一種格式來生成文檔,都被視為已呈現的文檔。
交易報表UI會顯示三個類別:Forms已提交、已呈現的檔案和已處理的檔案。 所呈現的文檔和所處理的文檔均作為所呈現的文檔入帳。
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。 | 已處理的文件 |
|
optimizePDF | 最佳化PDF,移除不必要的中繼資料而不影響品質,借此縮小檔案大小。 | 已處理的文件 |
API |
說明 | 交易記錄報表類別 | 其他資訊 |
createPDF |
從支援的檔案類型建立Adobe PDF。 | 已處理的文件 | |
createPDF2 | 從支援的檔案類型建立Adobe PDF。 | 已處理的文件 |
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範本擷取資料 | 已處理的文件 |
API |
說明 | 交易記錄報表類別 | 其他資訊 |
toImage | 將PDF文檔轉換為影像文檔清單。 支援的影像格式為JPEG、JPEG2K、PNG和TIFF。 | 已處理的文件 | |
toPS | 使用選項規範中指定的選項將平面PDF檔案轉換為PostScript格式。 | 已處理的文件 |
API |
說明 | 交易記錄報表類別 | 其他資訊 |
解碼 | 解碼Document對象中的所有條形碼,並返回一個org.w3c.dom.Document對象,該對象包含從條碼中檢索的資料。 | 已處理的文件 |
API |
說明 | 交易記錄報表類別 | 其他資訊 |
調用 | 執行指定的DDX文檔並返回包含結果文檔的AssemblerResult對象。 | 已處理的文件 | 下列業務不會作為交易入賬:
|
調用 | 執行指定的DDX文檔並返回包含結果文檔的AssemblerResult對象。 | 已處理的文件 | PDF生成器、Forms和輸出服務支援的所有輸入檔案格式,組合器服務支援所有這些格式作為輸出檔案格式。 |
toPDFA | 使用指定的選項將指定的文檔轉換為PDF/A。 | 已處理的文件 |
API |
說明 | 交易記錄報表類別 | 其他資訊 |
convertPDFtoXDP | 將PDF檔案轉換為XDP檔案。 為了將PDF檔案成功轉換為XDP檔案,PDF檔案必須在AcroForm字典中包含XFA資料流。 | 已處理的文件 |
適用性表單、HTML5 Forms和表單集的所有提交事件都會計為交易。 依預設,提交PDF表單不會計為交易。 使用提供的事務記錄器API將PDF forms提交記錄為事務。
使用案例 |
說明 | 交易記錄報表類別 | 其他資訊 |
提交最適化表單 | 提交最適化表單以配置提交操作。 | 已提交的表單 |
|
使用案例 |
說明 | 交易記錄報表類別 | 其他資訊 |
提交HTML5表單 | 提交HTML5表單以提交表單中設定的URL。 | 已提交的表單 |
API |
說明 | 交易記錄報表類別 | 其他資訊 |
提交表單集 | 將表單集提交到在表單集中配置的提交URL。 | 已提交的表單 |
|
在OSGi上指派以表單為中心的AEM工作流程的任務和檔案服務步驟,以及互動式通訊的所有轉譯,並以交易記帳。 在製作執行個體上預覽互動式通訊和使用代理程式UI在發佈執行個體上預覽沒有計為交易。 如果工作流步驟將事務處理入帳,且工作流無法完成,則事務處理計數不會被撤消。
API |
說明 | 交易記錄報表類別 | 其他資訊 |
轉譯Web通道 | 開啟互動式通訊的網頁版本。 | 已呈交的文件 |
|
API |
說明 | 交易記錄報表類別 | 其他資訊 |
轉譯 (轉換為PDF) | 生成互動式通信的PDF版本。 | 已呈交的文件 |
|
使用案例 |
交易記錄報表類別 | 其他資訊 |
提交分配任務步驟 | 已提交的表單 |
|
提交工作流應用程式起始點 | 已提交的表單 | |
從代理UI提交互動式通訊(列印通道)至工作流程 | 已呈交的文件 |
提交PDF表單、使用代理程式UI預覽互動式通訊、使用非標準表單提交和自訂實作等動作不會計為交易。 AEM Forms提供API來記錄這類動作,例如交易。 您可以從自訂實作呼叫API以記錄交易。