交易報表可記帳API transaction-reports-billable-apis

AEM Forms提供多個API來提交表單、處理檔案和轉譯檔案。 有些API是以交易入帳,其他則可供自由使用。 本檔案提供在交易報表中作為交易入帳的所有API清單。 以下是一些使用計費API的常見案例:

  • 提交最適化表單、HTML5表單和表單集
  • 呈現互動式通訊的列印或網頁版本
  • 將檔案從一種格式轉換為另一種格式
  • 平面化動態PDF檔案
  • 產生記錄檔案
  • 將互動式PDF檔案與另一個PDF檔案合併
  • 使用AEM Workflow的指派工作步驟與檔案服務步驟
  • 在最適化表單中使用最適化表單

帳單API不考慮頁數、檔案或表單的長度,或轉譯檔案的最終格式。 交易報告將交易分為兩個類別:已呈現的檔案和Forms已提交。

  • Forms已提交: 若從使用AEM Forms建立的任何型別的表單提交資料,且資料已提交至任何資料儲存庫或資料庫,則視為表單提交。 例如,提交最適化表單、HTML5表單、PDF forms和表單集都會計為已提交的表單。 表單集中的每個表單都視為提交。 例如,如果表單集有5個表單,在提交表單集時,交易報告服務將其計為5個提交。

  • 已轉譯的檔案: 透過結合範本和資料來產生檔案、以數位方式簽署或認證檔案、使用用於檔案服務的計費檔案服務API,或將檔案從一種格式轉換為另一種格式,均被視為檔案已呈現。

NOTE
交易報表UI會顯示三個類別:已提交的Forms、已轉譯的檔案以及已處理的檔案。 已轉譯的檔案和已處理的檔案都會入帳為已轉譯的檔案。

可記帳檔案服務API billable-document-services-apis

產生PDF服務 generate-pdf-service

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

DocAssurance服務 DocAssurance-Service

API
說明
交易報告類別
其他資訊
secureDocument
此API可讓您保護檔案的安全。 您可以使用API來簽署、認證、讀取器延伸或加密PDF檔案。
已處理的文件
只對secureDocument的簽署和認證操作收費。

Distiller服務 distiller-service

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

記錄檔案服務(DoR服務) document-of-record-service-dor-service

API
說明
交易報告類別
其他資訊
轉譯
叫用指定的轉譯方法,以使用提供的引數產生記錄檔案。
已處理的文件

輸出服務 output-service

API
說明
交易報告類別
其他資訊
generatePDFOutput
合併資料和範本以建立PDF檔案。
已處理的文件
generatePDFOutput
合併資料和範本以建立PDF檔案。
已處理的文件
generatePDFOutputBatch
合併資料和範本以建立一組PDF檔案。
已處理的文件
generatePDFOutputBatch API將表單範本與記錄結合,並產生PDF。 當您處理記錄批次時,交易報告服務會將每個記錄計為個別的PDF轉譯。
您可以使用 getGenerateManyFile 此旗標可結合多個轉譯為單一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轉譯。
您可以使用 getGenerateManyFile 此旗標可結合多個轉譯為單一PDF檔案。 無論標幟的狀態為何,服務都會將每筆記錄計為個別的PDF轉譯。

Forms 服務 forms-service

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

轉換PDF服務 convert-pdf-service

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

條碼式Forms服務 barcoded-forms-service

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

組合器服務 assembler-service

API
說明
交易報告類別
其他資訊
叫用
執行指定的DDX檔案並傳回 組合器結果 包含結果檔案的物件。
已處理的文件

下列作業不會作為交易入帳:

  • 建立套件或投資組合
  • 拼接多個XDP
叫用
執行指定的DDX檔案並傳回 組合器結果 包含結果檔案的物件。
已處理的文件
PDF Generator、Forms和輸出服務支援的所有輸入檔案格式,組合器服務都支援所有這些格式作為輸出檔案格式。
toPDFA
使用指定的選項將指定的檔案轉換為PDF/A。
已處理的文件

當您執行下列一或多個作業時,叫用API的使用量會計為交易:

  1. 從非PDF格式轉換成PDF格式。 例如,從XDP格式轉換成PDF格式,兼顧互動和非互動的通訊形式,以及從Word轉換成PDF。
  2. 從PDF格式轉換為PDF/A格式。
  3. 從PDF格式轉換為非PDF格式。 範例包括從PDF到影像格式的轉換或從PDF到文字格式的轉換。
NOTE
  • 組合器服務的叫用API可以在內部根據輸入呼叫另一個服務的計費的API。 因此,叫用API可計為無、單一或多個交易。 計算交易數取決於輸入和叫用的內部API。
  • 使用組合器服務產生的單一PDF檔案可計為無、單一或多個交易。 計算交易數目取決於提供的DDX代碼。

PDF公用程式服務 pdf-utility-service

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

可記帳資料擷取API billable-data-capture-apis

調適型表單、HTML5 Forms和表單集的所有提交事件都會計為交易。 依預設,PDF表單的提交不會作為交易入帳。 使用提供的 交易錄製器API 將PDF forms提交記錄為交易。

最適化表單 adaptive-forms

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

HTML5 Forms html-forms

使用案例
說明
交易報告類別
其他資訊
提交HTML5表單
提交HTML5表單以提交在表單中設定的URL。
已提交的表單

表單集 form-set

API
說明
交易報告類別
其他資訊
提交表單集
將表單集提交至表單集中設定的提交URL。
已提交的表單
  • 在最適化表單(最適化表單集)中使用最適化表單時,只會計算單一交易。 在最適化表單中可以有任意數量的最適化表單。
  • HTML5 Forms表單中的每個表單都會將帳戶設定為個別交易。

OSGi API上的可計費互動式通訊與表單中心AEM工作流程 billable-interactive-communication-and-form-centric-aem-workflows-on-osgi-apis

在OSGi上指派以表單為中心的AEM Workflow的工作和檔案服務步驟,以及互動式通訊的所有轉譯,並作為交易入帳。 在製作執行個體上預覽互動式通訊,以及使用代理程式UI在發佈執行個體上預覽,不會計為交易。 如果工作流程步驟將交易入帳,但工作流程無法完成,則不會迴轉交易計數。

互動式通訊 - Web Channel interactive-communication-web-channel

API
說明
交易報告類別
其他資訊
轉譯Web管道
開啟互動式通訊的Web版本。
已呈交的文件

互動式通訊 — Print Channel interactive-communication-print-channel

API
說明
交易報告類別
其他資訊
轉譯 (轉換成PDF)
產生互動式通訊的PDF版本。
已呈交的文件

OSGi上的表單中心AEM工作流程 form-centric-aem-workflows-on-osgi

使用案例
交易報告類別
其他資訊
提交指派工作步驟
已提交的表單
提交工作流程應用程式起點
已提交的表單
從Agent UI提互動動式通訊(Print Channel)至工作流程
已呈交的文件

將可記帳API記錄為自訂程式碼的交易 recording-billable-apis-as-transactions-for-custom-code

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

相關文章 related-articles

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2