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

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

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

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

  • Forms Submitted: 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ドキュメントを作成します。 処理済みドキュメント
generatePDFOutput データとテンプレートをマージしてPDFドキュメントを作成します。 処理済みドキュメント
generatePDFOutputBatch データとテンプレートをマージして、PDFドキュメントのセットを作成します。 処理済みドキュメント generatePDFOutputBatch APIは、フォームテンプレートとレコードを組み合わせてPDFを生成します。 レコードのバッチを処理する場合、トランザクションレポートサービスは各レコードを個別のPDFレンディションとしてカウントします。
getGenerateManyFilesフラグを使用する と、複数のレンディションを単一のPDFファイルに組み合わせることができます。フラグのステータスに関係なく、サービスは各レコードを個別の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の各ファイル形式に変換します。 処理済みドキュメント generatePDFOutputBatch APIは、フォームテンプレートとレコードを組み合わせてPDFを生成します。 レコードのバッチを処理する場合、トランザクションレポートサービスは各レコードを個別のPDFレンディションとしてカウントします。
getGenerateManyFilesフラグを使用する と、複数のレンディションを単一のPDFファイルに組み合わせることができます。フラグのステータスに関係なく、サービスは各レコードを個別のPDFレンディションとしてカウントします。

Forms サービス

API

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

Convert 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オブジェクトを返します。 処理済みドキュメント PDF Generator、Forms、およびOutputサービスでサポートされるすべての入力ファイル形式、Assemblerサービスでは、出力ファイル形式としてこれらすべての形式がサポートされます。
toPDFA 指定したオプションを使用して、指定したドキュメントをPDF/Aに変換します。 処理済みドキュメント
メモ
  • Assemblerサービスのinvoke APIは、入力に応じて、別のサービスの課金対象APIを内部的に呼び出すことができます。 したがって、呼び出しAPIは、なし、単一または複数のトランザクションとして計上できます。 カウントされるトランザクションの数は、入力と呼び出された内部APIによって異なります。
  • Assemblerサービスを使用して生成された単一のPDFドキュメントは、なし、単一または複数のトランザクションと見なすことができます。 カウントされるトランザクションの数は、指定されたDDXコードによって異なります。

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

API

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

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

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

アダプティブフォーム

使用例

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

HTML5 のフォーム

使用例

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

フォームセット

API

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

OSGi API上の請求可能なインタラクティブ通信とフォーム中心のAEMワークフロー

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

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

API

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

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

API

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

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

使用例

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

請求可能なAPIをカスタムコードのトランザクションとして記録する

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

このページ