AEM Forms には、フォームの送信、ドキュメントの処理、ドキュメントのレンダリングをおこなうための API がいくつか用意されています。一部の API はトランザクションとして計上され、それ以外は自由に使用できます。このドキュメントでは、トランザクションレポートでトランザクションとして計上されるすべての API のリストを示します。課金対象の API が使用される一般的なシナリオを次に示します。
請求 API は、ページ数、ドキュメントまたはフォームの長さ、レンダリング済みドキュメントの最終的な形式を考慮しません。トランザクションレポートは、トランザクションを、レンダリングされたドキュメントと送信されたフォームの 2 つのカテゴリに分類します。
送信済みフォーム: AEM Forms で作成された任意のタイプのフォームからデータが送信され、そのデータが任意のデータストレージリポジトリーまたはデータベースに送信された場合、そのデータはフォーム送信と見なされます。例えば、アダプティブフォーム、HTML5 フォーム、PDF Forms、フォームセットは、送信済みフォームとして計上されます。フォームセット内の各フォームは、送信と見なされます。例えば、フォームセットに 5 つのフォームが含まれている場合、フォームセットが送信されると、トランザクションレポートサービスはそのフォームセットを 5 件の送信としてカウントします。
レンダリングされたドキュメント: テンプレートとデータを組み合わせたドキュメントの生成、ドキュメントのデジタル署名または認証、ドキュメントサービスの課金可能なドキュメントサービス API の使用、ある形式から別の形式へのドキュメントの変換は、ドキュメントのレンダリングとして計上されます。
トランザクションレポート UI には、送信済み Forms、レンダリング済みドキュメント、処理済みドキュメントの 3 つのカテゴリが表示されます。レンダリング済みドキュメントと処理済みドキュメントの両方が、レンダリング済みドキュメントとして計上されます。
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 を最適化します。 | 処理済みドキュメント |
API |
説明 | トランザクションレポートカテゴリ | 追加情報 |
secureDocument |
この API を使用すると、ドキュメントを保護できます。 API を使用して、PDFドキュメントの署名、認証、Reader 用の拡張、暗号化を行うことができます。 | 処理済みドキュメント | secureDocument の署名および認証操作のみが請求されます。 |
API |
説明 | トランザクションレポートカテゴリ | 追加情報 |
createPDF |
サポートされているファイルタイプから Adobe PDF を作成します。 | 処理済みドキュメント | |
createPDF2 | サポートされているファイルタイプから Adobe PDF を作成します。 | 処理済みドキュメント |
API |
説明 | トランザクションレポートカテゴリ | 追加情報 |
render | 指定されたレンダリングメソッドを呼び出して、設定されたパラメーターを使用してレコードのドキュメントを生成します。 | 処理済みドキュメント |
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 レンディションとしてカウントします。 |
API |
説明 | トランザクションレポートカテゴリ | 追加情報 |
renderPDFForm | PDF フォームを XDP テンプレートからレンダリングします。XP テンプレートは、Forms Designer で作成されます。 | 処理済みドキュメント | |
exportData | PDF フォームまたは XDP からデータを書き出し | 処理済みドキュメント |
API |
説明 | トランザクションレポートカテゴリ | 追加情報 |
toImage | PDF ドキュメントを画像ドキュメントのリストに変換します。サポートされる画像形式は、JPEG、JPEG2K、PNG、TIFF です。 | 処理済みドキュメント | |
toPS | オプション仕様で指定した PDF を使用して、フラットオプションファイルを PostScript 形式に変換します。 | 処理済みドキュメント |
API |
説明 | トランザクションレポートカテゴリ | 追加情報 |
Decode | Document オブジェクト内のすべてのバーコードをデコードし、バーコードから取得されたデータを含む org.w3c.dom.Document オブジェクトを返します。 | 処理済みドキュメント |
API |
説明 | トランザクションレポートカテゴリ | 追加情報 |
呼び出し | 指定した DDX ドキュメントを実行し、結果のドキュメントを含む AssemblerResult オブジェクトを返します。 | 処理済みドキュメント | 次の操作はトランザクションとして計上されません。
|
呼び出し | 指定した DDX ドキュメントを実行し、結果のドキュメントを含む AssemblerResult オブジェクトを返します。 | 処理済みドキュメント | Assembler サービスは、PDF Generator、Forms、Output サービスがサポートするすべての入力ファイル形式を、出力ファイル形式としてサポートします。 |
toPDFA | 指定したオプションを使用して、指定したドキュメントを PDF/A に変換します。 | 処理済みドキュメント |
呼び出し API の使用状況は、次の操作を 1 つ以上実行すると、トランザクションとしてカウントされます。
API |
説明 | トランザクションレポートカテゴリ | 追加情報 |
convertPDFtoXDP | PDF ドキュメントを画像ファイルに変換します。PDFドキュメントを XDP ファイルに正しく変換するには、AcroForms ディクショナリ内にPDFドキュメントに XFA ストリームが含まれている必要があります。 | 処理済みドキュメント |
アダプティブフォーム、HTML5 Forms、フォームセットのすべての送信イベントは、トランザクションとして計上されます。デフォルトでは、トランザクションフォームの PDF はトランザクションとして計上されません。提供したトランザクションレコーダー API を使用して、PDF フォームの送信をトランザクションとして記録します。
ユースケース |
説明 | トランザクションレポートカテゴリ | 追加情報 |
アダプティブフォームの送信 | アダプティブフォームを設定済みの送信アクションに送信します。 | 送信済みフォーム |
|
ユースケース |
説明 | トランザクションレポートカテゴリ | 追加情報 |
HTML5 フォームの送信 | フォームで設定された URL を送信するために HTML5 フォームを送信します。 | 送信済みフォーム |
API |
説明 | トランザクションレポートカテゴリ | 追加情報 |
フォームセットの管理 | フォームセットを、フォームセットで設定された送信 URL に送信します。 | 送信済みフォーム |
|
OSGi 上の Form 中心の AEM Workflows のタスクとドキュメントサービスのステップと、インタラクティブ通信のすべてのレンディションを割り当てます。これらはトランザクションとしてカウントされます。オーサーインスタンス上でインタラクティブ通信をプレビューし、エージェント UI を使用してパブリッシュインスタンス上でプレビューすることは、トランザクションとしては考慮されません。ワークフローステップがトランザクションとして考慮され、ワークフローの完了に失敗した場合、トランザクション数は元に戻されません。
API |
説明 | トランザクションレポートカテゴリ | 追加情報 |
Web チャネルのレンダリング | インタラクティブ通信の web バージョンを開きます。 | レンダリング済みドキュメント |
|
API |
説明 | トランザクションレポートカテゴリ | 追加情報 |
レンダー(PDF に変換) | インタラクティブ PDF の通信バージョンを生成します。 | レンダリングされたドキュメント |
|
使用例 |
トランザクションレポートカテゴリ | 追加情報 |
割り当てタスクの送信手順 | 送信済みフォーム |
|
ワークフローアプリケーションのスタートポイントの送信 | 送信済みフォーム | |
エージェント UI からワークフローへのインタラクティブ通信(印刷チャネル)の送信 | レンダリングされたドキュメント |
PDF フォームの送信、エージェント UI を使用したインタラクティブな通信のプレビュー、非標準のフォーム送信の使用、カスタム実装などのアクションは、トランザクションとして考慮されません。AEM Forms は、トランザクションなどのアクションを記録する API を提供します。カスタム実装から API を呼び出して、トランザクションを記録することができます。