請求対象APIトランザクションレポート

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

AEM Formsは、フォームの送信、プロセスドキュメント、レンダリングドキュメントのためのいくつかのAPIを提供しています。 一部のAPIはトランザクションとして計上され、その他のAPIは無料で使用できます。 このドキュメントは、トランザクションレポートでトランザクションとして計上されるすべてのAPIのリストを提供します。 課金対象のAPIが使用される一般的なシナリオを以下に示します。

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

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

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

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

請求対象ドキュメントサービスAPI

Generate 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を作成します。 処理済みドキュメント
optimizePDF 画質に影響を与えることなく不要なメタデータを削除し、PDFを最適化してファイルサイズを縮小します。 処理済みドキュメント

Distillerサービス

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」操作 XDPテンプレートからPDFフォームをレンダリングします。 XPテンプレートは、Formsデザイナで作成されます。 処理済みドキュメント
exportData PDFフォームまたはXDPテンプレートからデータを抽出します 処理済みドキュメント

Convert PDFサービス

API

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

Barcoded Forms サービス

API

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

Assembler サービス

API

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

PDF Utilityサービス

API

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

Doc Assurance サービス

API

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

請求対象データ取得API

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

アダプティブフォーム

使用例

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

HTML5 のフォーム

使用例

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

フォームセット

API

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

OSGi APIに関する請求対象となるインタラクティブコミュニケーションおよびフォーム中心のAEMワークフロー

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

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

API

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

対話型通信 — 印刷チャネル

API

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

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

使用例

トランザクションレポートカテゴリ 追加情報
タスクの割り当て手順の送信 送信済みフォーム
ワークフローアプリケーションのスタートポイントの送信 送信済みフォーム
Agent UIからワークフローへの対話型通信(印刷チャネル)の送信 レタリング済みドキュメント

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

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

このページ