Show Menu
トピック×

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

AEM formsには、フォームの送信、ドキュメントの処理、ドキュメントのレンダリングを行うためのAPIがいくつか用意されています。 一部のAPIはトランザクションとして計上され、その他のAPIは無料で使用できます。 このドキュメントでは、トランザクションレポートでトランザクションとして計上されるすべてのAPIのリストを提供します。 課金対象のAPIが使用される一般的なシナリオを次に示します。
  • アダプティブフォーム、HTML5フォーム、フォームセットの送信
  • インタラクティブ通信の印刷版またはWeb版のレンダリング
  • ある形式から別の形式へのドキュメントの変換
  • ダイナミックPDFドキュメントの統合
  • レコードのドキュメントの生成
  • インタラクティブPDFドキュメントと別のPDFドキュメントの結合
  • AEM Workflowsのタスクの割り当て手順とドキュメントサービス手順の使用
  • アダプティブフォーム内でのアダプティブフォームの使用
課金APIは、ページ数、ドキュメントやフォームの長さ、レンダリングされたドキュメントの最終形式を考慮しません。 トランザクションレポートは、トランザクションを次の2つのカテゴリに分けます。レンダリングされたドキュメントと送信されたフォーム。
  • ​送信済みのフォーム:AEM Formsで作成された任意の種類のフォームからデータが送信され、データがデータストレージリポジトリまたはデータベースに送信される場合、フォーム送信と見なされます。 例えば、アダプティブフォーム、HTML5フォーム、PDFフォーム、フォームセットの送信は、送信されたフォームと見なされます。 フォームセット内の各フォームは送信と見なされます。 例えば、フォームセットに5つのフォームが含まれている場合、フォームセットが送信されると、トランザクションレポートサービスはそのフォームセットを5件の送信としてカウントします。
  • ​レンダリングされたドキュメント:テンプレートとデータを組み合わせてドキュメントを生成し、ドキュメントに電子署名または認証し、ドキュメントサービス用の請求可能なドキュメントサービスAPIを使用したり、ドキュメントを別の形式に変換したりして、ドキュメントをレンダリングしたドキュメントと見なします。
トランザクションレポートUIには、次の3つのカテゴリが表示されます。送信済みのフォーム、レンダリングされたドキュメント、処理されたドキュメント。 レンダリングされたドキュメントと処理されたドキュメントの両方が、レンダリングされたドキュメントとして計上されます。

課金対象のDocument Services API

Generate PDF Service

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 Service

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

レコードのドキュメントサービス(DoRサービス)

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

Output サービス

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

Forms サービス

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

Convert PDF Service

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

Barcoded Forms サービス

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

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ストリームが含まれている必要があります。 処理済みドキュメント

請求対象データ取得API

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

アダプティブフォーム

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

HTML5 のフォーム

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

フォームセット

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

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

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

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

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

Interactive Communication - Print Channel

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

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

使用事例

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

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