Batch API
Batch API を使用すると、テンプレートから複数のインタラクティブ通信を作成できます。テンプレートは、データのないインタラクティブ通信です。Batch API は、データとテンプレートを組み合わせて、インタラクティブな通信を作成します。この API は、インタラクティブ通信を大量に作成する際に役立ちます。例えば、複数の顧客に電話料金やクレジットカードの明細書を送信する場合です。
バッチ生成 API について詳しくは、こちらを参照してください
この記事では、Batch API を使用してインタラクティブなコミュニケーションドキュメントを生成するためのサンプルアセットを提供します。
監視フォルダーを使用したバッチ生成
- インタラクティブなコミュニケーションテンプレートを AEM Forms サーバーに読み込みます。
- 監視フォルダーの設定を読み込みます。これにより、C ドライブに
batchAPIというフォルダーが作成されます。
Windows 以外のオペレーティングシステムで AEM Forms を実行している場合は、次の 3 つの手順に従ってください。
- 監視フォルダーを開きます
- BatchAPIWatchedFolder を選択し、「編集」をクリックします。
- オペレーティングシステムに合わせてパスを変更します。
-
zip ファイルをダウンロードしてコンテンツを解凍します。zip ファイルには、
beneficiaries.jsonファイルを含むjsonfileという名前のフォルダーが含まれています。このファイルには、3 つのドキュメントを生成するためのデータが含まれています。 -
jsonfileフォルダーを監視フォルダーの入力フォルダーにドロップします。 -
フォルダーを処理用に取得したら、監視フォルダーの結果フォルダーを確認します。生成された 3 つの PDF ファイルが表示されます
REST リクエストを使用したバッチ生成
Batch API は、REST リクエストを通じて 呼び出すことができます。他のアプリケーションの REST エンドポイントを公開して、API を呼び出してドキュメントを生成できます。
提供されるサンプルアセットは、インタラクティブ通信ドキュメントを生成するための REST エンドポイントを公開します。サーブレットは、次のパラメーターを受け入れます。
- fileName - ファイルシステム上のデータファイルの場所。
- templatePath - IC テンプレートのパス
- saveLocation - 生成したドキュメントをファイルシステム上に保存する場所
- channelType - 印刷、web またはその両方
- recordId - インタラクティブ通信の名前を設定する要素の JSON パス
次のスクリーンショットは、パラメーターとその値を示しています
サーバーへのサンプルアセットのデプロイ
- パッケージマネージャーを使用した ICTemplate の読み込み
- パッケージマネージャーを使用したカスタム送信ハンドラーの読み込み
- Forms とドキュメントインターフェイスを使用したアダプティブフォームの読み込み
- Felix web コンソールを使用したカスタム OSGI バンドルのデプロイと開始
- フォームを送信したバッチ生成のトリガー