トランザクションレポート請求可能 API

トランザクションとして計上されるすべての API のリスト

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

  • アダプティブフォーム、HTML5 フォーム、フォームセットの送信
  • インタラクティブ通信の印刷バージョンまたは Web バージョンのレンダリング
  • ある形式から別の形式へのドキュメントの変換
  • ダイナミックPDFドキュメントの統合
  • レコードのドキュメントの生成
  • インタラクティブPDFドキュメントと別のPDFドキュメントの結合
  • AEM Workflows のタスク割り当て手順とドキュメントサービス手順の使用
  • アダプティブフォーム内でのアダプティブフォームの使用

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

  • Forms Submitted: AEM Formsで作成された任意のタイプのフォームからデータが送信され、そのデータが任意のデータストレージリポジトリまたはデータベースに送信された場合、そのデータはフォーム送信と見なされます。 例えば、アダプティブフォーム、HTML5 フォーム、PDF forms、フォームセットは、送信されたフォームとして計上されます。 フォームセット内の各フォームは、送信と見なされます。 例えば、フォームセットに 5 つのフォームが含まれている場合、フォームセットが送信されると、トランザクションレポートサービスはそのフォームセットを 5 件の送信としてカウントします。
  • レンダリングされたドキュメント： テンプレートとデータを組み合わせたドキュメントの生成、ドキュメントのデジタル署名または認証、ドキュメントサービスの課金可能なドキュメントサービス API の使用、ある形式から別の形式へのドキュメントの変換は、ドキュメントとして計上されます。
メモ

トランザクションレポート UI には、次の 3 つのカテゴリが表示されます。Forms送信済み、レンダリングされたドキュメント、処理されたドキュメント。 レンダリングされたドキュメントと処理されたドキュメントの両方が、レンダリングされたドキュメントとして計上されます。

課金対象のドキュメントサービス API

GeneratePDFサービス

API

 説明 トランザクションレポートカテゴリ 追加情報
createPDF サポートされているファイルタイプからAdobe PDFを作成します。 処理済みドキュメント
createPDF2 サポートされているファイルタイプからAdobe PDFを作成します。 処理済みドキュメント
exportPDF Adobe PDFをサポートされるファイルタイプに変換します。 処理済みドキュメント
exportPDF2 Adobe PDFをサポートされるファイルタイプに変換します。 処理済みドキュメント
exportPDF3 Adobe PDFをサポートされるファイルタイプに変換します。 処理済みドキュメント
htmlFileToPdf

PDFページからHTMLを作成

 処理済みドキュメント
htmlToPdf PDFページを指す URL からHTMLを作成します。 処理済みドキュメント
htmlToPdf2 PDFページを指す URL からHTMLを作成します。 処理済みドキュメント
optimizePDF PDFを最適化し、画質に影響を与えることなく不要なメタデータを削除してファイルサイズを縮小します。 処理済みドキュメント

Distiller Service

API

 説明 トランザクションレポートカテゴリ 追加情報
createPDF
 サポートされているファイルタイプからAdobe PDFを作成します。 処理済みドキュメント
createPDF2 サポートされているファイルタイプからAdobe PDFを作成します。 処理済みドキュメント

レコードのドキュメントサービス（DoR サービス）

API

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

Output サービス

API

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

Forms サービス

API

 説明 トランザクションレポートカテゴリ 追加情報
｢renderPDFForm｣操作 PDFフォームを XDP テンプレートからレンダリングします。 XP テンプレートは、Forms Designer で作成されます。 処理済みドキュメント
exportData テンプレートフォームまたは XDPPDFからデータを抽出します 処理済みドキュメント

変換PDFサービス

API

 説明 トランザクションレポートカテゴリ 追加情報
toImage PDFドキュメントを画像ドキュメントのリストに変換します。 サポートされる画像形式は、JPEG、JPEG2K、PNG、TIFFです。 処理済みドキュメント
toPS オプション仕様で指定されたPDFを使用して、フラットオプションファイルを PostScript 形式に変換します。 処理済みドキュメント

Barcoded Forms サービス

API

 説明 トランザクションレポートカテゴリ 追加情報
decode Document オブジェクト内のすべてのバーコードをデコードし、バーコードから取得されたデータを含む org.w3c.dom.Document オブジェクトを返します。 処理済みドキュメント

Assembler サービス

API

 説明 トランザクションレポートカテゴリ 追加情報
呼び出し 指定した DDX ドキュメントを実行し、 AssemblerResult 結果のドキュメントを含むオブジェクト。 処理済みドキュメント 次の操作はトランザクションとして計上されません。
  • パッケージまたはポートフォリオの作成
  • 複数の XDP のステッチ
呼び出し 指定した DDX ドキュメントを実行し、 AssemblerResult 結果のドキュメントを含むオブジェクト。 処理済みドキュメント Assembler サービスは、PDFGenerator、Formsおよび Output サービスがサポートするすべての入力ファイル形式を、出力ファイル形式としてサポートします。
toPDFA 指定したオプションを使用して、指定したドキュメントをPDF/A に変換します。 処理済みドキュメント
メモ
  • Assembler サービスの invoke API は、入力に応じて別のサービスの課金対象 API を内部的に呼び出すことができます。 したがって、呼び出し API は、なし、単一または複数のトランザクションとして計上できます。 カウントされるトランザクションの数は、入力と呼び出される内部 API によって異なります。
  • Assembler サービスを使用して生成された単一のPDFドキュメントは、なし、単一または複数のトランザクションとして計上できます。 カウントされるトランザクションの数は、指定された DDX コードによって異なります。

PDFユーティリティサービス

API

 説明 トランザクションレポートカテゴリ 追加情報
convertPDFtoXDP PDFドキュメントを XDP ファイルに変換します。 PDFドキュメントを XDP ファイルに正しく変換するには、PDFドキュメントに AcroForms ディクショナリ内の XFA ストリームが含まれている必要があります。 処理済みドキュメント

Doc Assurance サービス

API

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

課金対象のデータキャプチャ API

アダプティブフォーム、HTML5 Formsおよびフォームセットのすべての送信イベントは、トランザクションとして計上されます。 デフォルトでは、トランザクションフォームのPDFはトランザクションとして計上されません。 提供された トランザクションレポート API トランザクションとしてPDF formsの送信を記録する。

アダプティブフォーム

ユースケース

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

HTML5 のフォーム

ユースケース

 説明 トランザクションレポートカテゴリ 追加情報
HTML5 フォームの送信 フォームで設定された URL を送信するためにHTML5 フォームを送信します。 送信済みフォーム

フォームセット

API

 説明 トランザクションレポートカテゴリ 追加情報
フォームセットの送信 フォームセットを、フォームセットで設定された送信 URL に送信します。 送信済みフォーム
  • アダプティブフォーム（アダプティブフォームフォームセット）内でアダプティブフォームを使用すると、1 回のトランザクションのみが考慮されます。 アダプティブフォーム内には、任意の数のアダプティブフォームを含めることができます。
  • HTML5 Formsフォームセット内の各フォームは、別々のトランザクションとしてアカウントされます。

OSGi API 上の課金対象のインタラクティブ通信とフォーム中心のAEMワークフロー

OSGi 上の Form 中心のAEM Workflows のタスクとドキュメントサービスのステップと、インタラクティブ通信のすべてのレンディションを割り当てます。これらはトランザクションとして計上されます。 オーサーインスタンス上でインタラクティブ通信をプレビューし、エージェント UI を使用してパブリッシュインスタンス上でプレビューすることは、トランザクションとしては考慮されません。 ワークフローステップでトランザクションが考慮され、ワークフローの完了に失敗した場合、トランザクション数は元に戻されません。

インタラクティブ通信 - Web チャネル

API

 説明 トランザクションレポートカテゴリ 追加情報
Web チャネルのレンダリング インタラクティブ通信の Web バージョンを開きます。 レタリング済みドキュメント

インタラクティブ通信 — 印刷チャネル

API

 説明 トランザクションレポートカテゴリ 追加情報
レンダー ( 変換してPDF) インタラクティブPDFの通信バージョンを生成します。 レタリング済みドキュメント

OSGi 上のフォームベース AEM ワークフロー

使用例

 トランザクションレポートカテゴリ 追加情報
タスクの割り当てステップの送信 送信済みフォーム
ワークフローアプリケーションのスタートポイントの送信 送信済みフォーム
エージェント UI からワークフローへのインタラクティブ通信（印刷チャネル）の送信 レタリング済みドキュメント

カスタムコードのトランザクションとしての課金対象 API の記録

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

このページ