フォームデータモデルの使用 use-form-data-model
AEM Forms のデータ統合機能により、各種のバックエンドデータソースを使用してフォームデータモデルを作成できます。作成したデータフォームは、様々なアダプティブフォームとインタラクティブなコミュニケーションのワークフローで、スキーマとして使用できます。 そのためには、データソースの設定を行い、そのデータソース内の有効なデータモデルオブジェクトとデータモデルサービスに基づいて、フォームデータモデルを作成する必要があります。 詳しくは、以下のトピックを参照してください。
JSON スキーマの拡張機能であるフォームデータモデルを使用して、以下の処理を行うことができます。
アダプティブフォームとアダプティブフォームフラグメントを作成する create-af
フォームデータモデルに基づいて、アダプティブフォームとアダプティブフォームフラグメントを作成できます。 フォームデータモデルを使用してアダプティブフォームまたはアダプティブフォームフラグメントを作成するには、以下の手順を実行します。
-
プロパティを追加画面の「フォームモデル」タブで、 次から選択 ドロップダウンリストから「フォームデータモデル」を選択します。
-
「フォームデータモデルを選択」を選択して展開します。 すべての有効なフォームデータモデルが一覧表示されます。
フォームデータモデルを選択します。
-
（アダプティブフォームフラグメントのみ）フォームデータモデル内の 1 つのデータモデルオブジェクトのみに基づいて、アダプティブフォームフラグメントを作成できます。 フォームデータモデル定義ドロップダウンを展開します。 指定したフォームデータモデル内のすべてのデータモデルオブジェクトがリスト表示されます。 リストからデータモデルオブジェクトを選択します。
フォームデータモデルに基づいてアダプティブフォームまたはアダプティブフォームフラグメントを作成すると、アダプティブフォームエディターのコンテンツブラウザーの「データモデルオブジェクト」タブにフォームデータモデルオブジェクトが表示されます。
データモデルオブジェクトをアダプティブフォームまたはアダプティブフォームフラグメントにドラッグアンドドロップすると、フォームフィールドを追加することができます。 追加されたフォームフィールドには、メタデータのプロパティが保持され、データモデルオブジェクトのプロパティとの連結が保持されます。 この連結により、フォームの送信時は、対応するデータソース内のフィールド値が更新され、フォームのレンダリング時は、対応するデータソース内のフィールドに値が取り込まれます。
インタラクティブなコミュニケーションを作成 create-ic
フォームデータモデルに基づいて、インタラクティブなコミュニケーションを作成できます。フォームデータモデルを使用して、設定済みデータソースのデータをインタラクティブなコミュニケーションに事前に取り込むことができます。 また、フォームデータモデルに基づいて、インタラクティブなコミュニケーションの構築ブロック（テキスト、リストおよび条件のドキュメントフラグメントなど）を作成できます。
インタラクティブなコミュニケーションまたはドキュメントフラグメントを作成する際に、フォームデータモデルを選択できます。 次の図は、インタラクティブなコミュニケーションを作成ダイアログの「一般」タブを示しています。
インタラクティブなコミュニケーションを作成ダイアログの「一般」タブ
詳しくは、次を参照してください。
サンプルデータを使用したプレビュー preview-ic
フォームデータモデルエディターでは、フォームデータモデル内のデータモデルオブジェクト用のサンプルデータを生成して編集できます。 このデータを使用すると、インタラクティブなコミュニケーションとアダプティブフォームをプレビューおよびテストできます。 プレビュー表示を行う前に、フォームデータモデルの操作の説明に従って、サンプルデータを生成します。
サンプルのフォームデータモデルのデータを使用してインタラクティブなコミュニケーションをプレビューするには：
- AEM オーサーインスタンスで、フォーム／フォームとドキュメントに移動します。
- インタラクティブなコミュニケーションを選択してツールバーで「プレビュー」を選択し、「Web チャネル」、「印刷チャネル」、または「両方のチャネル」を選択します。これにより、選択したインタラクティブなコミュニケーションのプレビューが表示されます。
- プレビューの[チャネル]ダイアログで、「フォームデータモデルのデータのテスト」が選択されていることを確認して「プレビュー」を選択します。
サンプルデータが取り込まれた状態のインタラクティブなコミュニケーションが表示されます。
同様に、サンプルデータが取り込まれた状態のアダプティブフォームをプレビュー表示するには、作成者モードでアダプティブフォームを開いて「プレビュー」を選択します。
フォームデータモデルサービスを使用したデータの事前入力 prefill
AEM Forms には、すぐに使用できるフォームデータモデル事前入力サービスが用意されています。フォームデータモデルに基づいて、このサービスをアダプティブフォームおよびインタラクティブなコミュニケーションで使用することができます。 この事前入力サービスは、アダプティブフォームおよびインタラクティブなコミュニケーション内のデータモデルオブジェクトに対してデータソースのクエリを実行し、フォームまたは通信のレンダリング時にデータを事前入力します。
アダプティブフォームに対してフォームデータモデル事前入力サービスを有効にするには、アダプティブフォームコンテナのプロパティを開き、基本アコーディオンの 事前入力サービス ドロップダウンで「フォームデータモデル事前入力サービス」を選択します。 次に、各プロパティを保存します。
インタラクティブなコミュニケーションでフォームデータモデル事前入力サービスを設定するには、インタラクティブなコミュニケーションの作成時に「事前入力サービス」ドロップダウンで「フォームデータモデル事前入力サービス」を選択します。後でプロパティを編集することもできます。
インタラクティブなコミュニケーションのプロパティ編集ダイアログ
送信されたアダプティブフォームデータのデータソースへの書き込み write-af
ユーザーがフォームデータモデルに基づいてフォームを送信するとき、データモデルオブジェクトの送信データがそのデータソースに書き込まれるようにフォームを設定することができます。 この設定を行うために、AEM Forms には、すぐに使用できるフォームデータモデル送信アクションが用意されています。これは、フォームデータモデルをベースとするアダプティブフォーム専用のアクションです。 これにより、データモデルオブジェクトに送信されたデータが、そのデータソースに書き込まれます。
フォームデータモデル送信アクションを設定するには、アダプティブフォームコンテナのプロパティを開き、送信アコーディオンの「送信アクション」ドロップダウンで「フォームデータモデルを使用して送信」を選択します。 次に、 送信するデータモデルオブジェクトの名前 ドロップダウンで、目的のデータモデルオブジェクトを探して選択します。 各プロパティを保存します。
フォームを送信すると、設定されているデータモデルオブジェクトのデータが、各データソースに書き込まれます。
バイナリデータモデルオブジェクトのプロパティを使用して、フォームの添付ファイルをデータソースに送信することもできます。 添付ファイルを JDBC データソースに送信するには、次の手順を実行します。
-
バイナリプロパティを含むデータモデルオブジェクトをフォームデータモデルに追加します。
-
アダプティブフォームで、「添付ファイル」コンポーネントをコンポーネントブラウザーからアダプティブフォームにドラッグ＆ドロップします。
-
追加されたコンポーネントを選択し、次に
-
「バインド参照」フィールドで
-
アダプティブフォームコンテナプロパティの「送信」セクションで、「フォームの添付ファイルを送信」を有効にします。 これで、フォーム送信時に、バイナリプロパティフィールド内の添付ファイルがデータソースに送信されます。
ルールを使用したアダプティブフォーム内のサービスの呼び出し invoke-services
フォームデータモデルに基づくアダプティブフォームの場合、ルールを作成して、フォームデータモデル内で設定されているサービスを呼び出すことができます。 ルール内の「サービスを起動」操作を実行すると、フォームデータモデル内のすべての有効なサービスが一覧表示され、サービスの入力フィールドと出力フィールドを選択できます。 「指定値」というルールタイプを使用してフォームデータモデルサービスを呼び出し、そのサービスから返された出力に対するフィールドの値を設定することもできます。
例えば以下のルールの場合、従業員 ID を入力として使用する Get サービスが呼び出され、このサービスから返された値が、フォーム内の対応する扶養家族 ID フィールド、姓フィールド、名フィールド、性別フィールドに設定されます。
また、guidelib.dataIntegrationUtils.executeOperation API を使用して、ルールエディターのコードエディターで JavaScript を記述することもできます。 API について詳しくは、「フォームデータモデルサービスを呼び出すための API」を参照してください。