トランザクションレポート請求可能 API transaction-reports-billable-apis

バージョン
記事リンク
AEM 6.5
ここをクリックしてください
AEM as a Cloud Service
この記事

AEM Forms には、フォームの送信、ドキュメントの処理、ドキュメントのレンダリングをおこなうための API がいくつか用意されています。一部の API はトランザクションとして計上され、それ以外は自由に使用できます。このドキュメントでは、トランザクションレポートでトランザクションとして計上されるすべての API のリストを示します。課金対象の API が使用される一般的なシナリオを次に示します。

  • アダプティブフォームの送信
  • ある形式から別の形式へのドキュメントの変換
  • ダイナミック PDF ドキュメントの統合
  • レコードのドキュメントの生成(Forms サービスまたは Output サービスを使用)
  • インタラクティブ PDF ドキュメントと別の PDF ドキュメントの結合
  • AEM ワークフローのタスク割り当て手順と Communication API 手順の使用

請求 API は、ページ数、ドキュメントまたはフォームの長さ、レンダリング済みドキュメントの最終的な形式を考慮しません。トランザクションレポートでは、トランザクションが送信済みフォームとレンダリング済みドキュメントの 2 つのカテゴリに分類されます。

  • 送信済みフォーム: AEM Forms で作成された任意のタイプのフォームからデータが送信され、そのデータが任意のデータストレージリポジトリーまたはデータベースに送信された場合、そのデータはフォーム送信と見なされます。例えば、アダプティブフォームまたはフォームセットを送信すると、送信済みフォームと見なされます。フォームセットに 5 つのフォームが含まれている場合、フォームセットを送信すると、トランザクションレポートサービスでは 5 件の送信としてカウントされます。

  • レンダリング済みドキュメント: ​テンプレートとデータを組み合わせたドキュメントの生成、ドキュメントの電子署名または認証、ドキュメントサービスの課金可能なドキュメントサービス API の使用、ある形式から別の形式へのドキュメントの変換は、レンダリング済みドキュメントとして見なされます。

課金対象のドキュメントサービス API billable-document-services-apis

PDF 生成サービス generate-pdf-service

API
説明
トランザクションレポートカテゴリ
追加情報
createPDF
テンプレートから PDF ドキュメントを生成し、そのドキュメントにデータを結合します。
処理済みドキュメント
exportPDF
XDP ファイルまたは PDF ドキュメントをサポートされているファイルタイプに変換します。
処理済みドキュメント

Output サービス output-service

API
説明
トランザクションレポートカテゴリ
追加情報
generatePDFOutput
データとテンプレートを結合して、PDF ドキュメントを作成します。
処理済みドキュメント
generatePDFOutput(PDFOutputOptions)
データとテンプレートを結合して、PDF ドキュメントを作成します。
処理済みドキュメント
generatePDFOutputBatch
データとテンプレートを結合して、一連の PDF ドキュメントを作成します。
処理済みドキュメント
generatePrintedOutput
XDP および PDF ドキュメントを PostScript(PS)、Printer Command Language(PCL)および ZPL ファイル形式に変換します。
処理済みドキュメント
generatePrintedOutput(PrintedOutputOptions)
XDP および PDF ドキュメントを PostScript(PS)、Printer Command Language(PCL)および ZPL ファイル形式に変換します。
処理済みドキュメント
generatePrintedOutputBatch
XDP および PDF ドキュメントのセットを、PostScript(PS)、Printer Command Language(PCL)および ZPL の各ファイル形式に変換します。
処理済みドキュメント

DocAssurance サービス DocAssurance-Service

API
説明
トランザクションレポートカテゴリ
追加情報
secureDocument
この API を使用すると、ドキュメントを保護できます。API を使用して、PDF ドキュメントの署名、認証、Reader 用の拡張、暗号化を行うことができます。
処理済みドキュメント
secureDocument の署名および認証操作のみが請求されます。

レコードのドキュメント(DOR)サービス document-of-record-dor-forms-service-and-output-service

API
説明
トランザクションレポートカテゴリ
追加情報
render
指定されたレンダリングメソッドを呼び出して、設定されたパラメーターを使用してレコードのドキュメントを生成します。
Forms サービスを使用して処理されたドキュメント

Assembler サービス assembler-service

API
説明
トランザクションレポートカテゴリ
追加情報
呼び出し
指定した入力ドキュメントに対して DDX を実行し、結果のドキュメントを含むオブジェクトを返します
処理済みドキュメント

次の操作はトランザクションとして計上されません。

  • パッケージまたはポートフォリオの作成
  • 複数の XDP のステッチ
呼び出し
指定した入力ドキュメントに対して DDX を実行し、結果のドキュメントを含むオブジェクトを返します
処理済みドキュメント
Assembler サービスは、PDF Generator、Forms、Output サービスがサポートするすべての入力ファイル形式を、出力ファイル形式としてサポートします。
toPDFA
指定したオプションを使用して、指定したドキュメントを PDF/A に変換します。
処理済みドキュメント

次の操作を 1 つ以上実行すると、呼び出し API の使用がトランザクションとしてカウントされます。

  1. PDF 以外の形式から PDF 形式への変換。
  2. PDF 形式から PDF/A 形式への変換。
  3. PDF 形式から非 PDF 形式への変換。例としては、PDF 形式から画像形式への変換、または PDF 形式からテキスト形式への変換があります。
NOTE
  • Assembler サービスの invoke API は、入力に応じて別のサービスの課金対象 API を内部的に呼び出すことができます。したがって、呼び出し API は、0、単一、複数のトランザクションのいずれかとして計上される可能性があります。カウントされるトランザクションの数は、入力と呼び出される内部 API によって異なります。
  • Assembler サービスを使用して生成された単一の PDF ドキュメントは、0、単一、複数のトランザクションのいずれかとして計上される可能性があります。カウントされるトランザクションの数は、指定されたコードによって異なります。

課金対象のデータキャプチャ API billable-data-capture-apis

アダプティブフォームのすべての送信イベントは、トランザクションとして計上されます。デフォルトでは、トランザクションフォームの PDF はトランザクションとして計上されません。提供したトランザクションレコーダー API を使用して、PDF フォームの送信をトランザクションとして記録します。

アダプティブフォーム adaptive-forms

ユースケース
説明
トランザクションレポートカテゴリ
追加情報
アダプティブフォームの送信
アダプティブフォームを設定済みの送信アクションに送信します。
送信済みフォーム
  • 送信が成功した場合、1 回または 2 回のトランザクションが発生します。カウントされるトランザクションの数は、送信に使用する送信アクションのタイプによって異なります。例えば、メール送信アクションを使用した PDF の送信は、2 回のトランザクションが発生します。フォーム送信するトランザクション 1 回と、レコードのドキュメント(DOR)サービスを使用して PDF が生成されるトランザクション 1 回です。
  • アダプティブフォーム(アダプティブフォームフォームセット)内でアダプティブフォームを使用すると、1 回のトランザクションのみがカウントされます。アダプティブフォーム内には、任意の数のアダプティブフォームを含めることができます。

課金対象のフォーム中心の AEM ワークフロー billable--form-centric-aem-workflows

フォーム中心の AEM ワークフローのタスクおよびドキュメントサービスの割り当て手順は、トランザクションとして計上されます。ワークフローステップがトランザクションとして考慮され、ワークフローの完了に失敗した場合、トランザクション数は元に戻されません。

フォーム中心の AEM ワークフロー form-centric-aem-workflows

ユースケース
トランザクションレポートカテゴリ
追加情報
割り当てタスクの送信手順
送信済みフォーム
ワークフローアプリケーションのスタートポイントの送信
送信済みフォーム

カスタムコードのトランザクションとしての課金対象 API の記録 recording-billable-apis-as-transactions-for-custom-code

PDF フォームの送信、エージェント UI を使用したインタラクティブな通信のプレビュー、非標準のフォーム送信の使用、カスタム実装などのアクションは、トランザクションとして考慮されません。AEM Forms は、トランザクションなどのアクションを記録する API を提供します。カスタム実装から API を呼び出して、トランザクションを記録することができます。

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab