フォームデータモデルの操作

フォームデータモデルエディターには、フォームデータモデルの編集と設定を行うための直感的なユーザーインターフェイスとツールが用意されています。フォームデータモデル内の関連データソースでこのエディターを使用して、データモデルオブジェクト、プロパティ、サービスの追加と設定を行うことができます。また、データソースを使用せずにデータモデルオブジェクトとプロパティを作成し、後で各データモデルオブジェクトとプロパティに結び付けることができます。 また、データモデルオブジェクトプロパティのサンプルデータを生成および編集し、アダプティブフォームやインタラクティブ通信の事前入力に使用することもできます。 フォームデータモデルで設定されたデータモデルオブジェクトとサービスをテストして、データソースと適切に統合されていることを確認できます。

Forms のデータ統合機能を初めて使用する場合や、これまでにデータソースの設定やフォームデータモデルの作成を行ったことがない場合は、以下のトピックを参照してください。

• AEM Forms のデータ統合
• データソースの設定
• フォームデータモデルの作成

フォームデータモデルエディターを使用して実行できる様々なタスクや設定について、詳しくはこちらをご覧ください。

データモデルオブジェクトとサービスを追加

データソースを持つフォームデータモデルが既に作成されている場合は、フォームデータモデルエディターを使用して、データモデルオブジェクトとサービスの追加、各種プロパティの設定、データモデルオブジェクト間の関連付けの定義、フォームデータモデルとサービスのテストをおこなうことができます。

フォームデータモデル内の有効なデータソースを使用して、データモデルオブジェクトとサービスを追加することができます。追加したデータモデルオブジェクトは「モデル」タブに表示され、追加したサービスは「サービス」タブに表示されます。

データモデルオブジェクトとサービスを追加するには、以下の手順を実行します。

1. AEM オーサーインスタンスにログインして​フォーム／データ統合​に移動し、データモデルオブジェクトを追加するフォームデータモデルを開きます。

2. データソースペインでデータソースを展開して、使用可能なデータモデルオブジェクトとサービスを表示します。

3. フォームデータモデルに追加するデータモデルオブジェクトとサービスを選択して、選択項目を追加​をタップします。

   

   選択されたデータモデルオブジェクトとサービス

   メモ

   Forms データモデルにリレーショナルデータベースの予約済みキーワードであるオブジェクトが含まれている場合、データの追加、更新または取得に関する問題が発生する可能性があります。そのため、そのようなオブジェクトはフォームデータモデルで使用しないようにしてください。

   「モデル」タブには、フォームデータモデルに追加されたすべてのデータモデルオブジェクトのグラフィカル表現と、それらのオブジェクトのプロパティが表示されます。フォームデータモデル内の各データモデルオブジェクトは、ボックスを使用して表現されます。

   

   追加したデータモデルオブジェクトが表示された「モデル」タブ

   メモ

   データモデルオブジェクトのボックスを選択してドラッグすると、コンテンツ領域内にデータモデルオブジェクトを配置できます。フォームデータモデルに追加されたデータモデルオブジェクトは、データソースペイン内ではすべてグレーアウトされます。

   「サービス」タブには、追加されたサービスが一覧表示されます。

   

   データモデルサービスが表示された「サービス」タブ

   メモ

   OData サービスのメタデータドキュメントには、データモデルオブジェクトとサービスのほかに、2 つのデータモデルオブジェクト間の関連付けを定義するナビゲーションプロパティが含まれます。詳しくは、OData サービスのナビゲーションプロパティの操作を参照してください。

4. 「保存」をタップして、フォームモデルオブジェクトを保存します。

   メモ

   アダプティブフォームのルールを使用して、フォームデータモデルの「サービス」タブで設定したサービスを呼び出すことができます。 設定済みのサービスは、ルールエディターの「サービスを呼び出す」アクションで使用できます。アダプティブフォームのルールでこれらのサービスを使用する方法について詳しくは、「サービスを呼び出す」および「ルールの値を設定する」を参照してください。 ルールエディター.

データモデルオブジェクトと子プロパティの作成

データモデルオブジェクトの作成

設定済みデータソースからデータモデルオブジェクトを追加することも、データソースを使用せずにデータモデルオブジェクトやデータモデルエンティティを作成することもできます。この方法は、フォームデータモデル内でデータソースが設定されていない場合に使用すると、特に便利です。

データソースを使用せずにデータモデルオブジェクトを作成するには、以下の手順を実行します。

1. AEMオーサーインスタンスにログインし、に移動します。 Forms /データ統合​をクリックし、データモデルオブジェクトまたはエンティティを作成するフォームデータモデルを開きます。

2. エンティティを作成​をタップします。

3. データモデルを作成ダイアログで、データモデルオブジェクトの名前を指定して​追加​をタップします。データモデルオブジェクトがフォームデータモデルに追加されます。以下の図に示すように、新しく追加されたデータモデルオブジェクトは、データソースには連結されません。また、プロパティも設定されません。

   

次に、データソースに連結されていないデータモデルオブジェクトで、子プロパティを追加します。

子プロパティを追加

フォームデータモデルエディターを使用すると、データモデルオブジェクト内に子プロパティを作成できます。 作成した時点では、子プロパティはデータソース内のどのプロパティにも連結されません。作成した子プロパティは、データモデルオブジェクト内の別のプロパティに後で連結することができます。

子プロパティを作成するには、以下の手順を実行します。

1. フォームデータモデルでデータモデルオブジェクトを選択して「子プロパティを作成」をタップします。

2. 子プロパティを作成​ダイアログの「名前」フィールドと「タイプ」フィールドで、子プロパティの名前とタイプを指定します。必要に応じて、子プロパティのタイトルと説明を指定することもできます。

3. 作成するプロパティが計算済みプロパティの場合は、「計算済み」を有効にします。計算済みプロパティの値は、ルールまたは式に基づいて評価されます。詳しくは、プロパティの編集を参照してください。

4. データモデルオブジェクトをデータソースに連結すると、追加した子プロジェクトが親データモデルオブジェクトのプロパティに自動的に連結されます。その際、子プロパティの名前とデータタイプは変わりません。

   子プロパティをデータモデルオブジェクトのプロパティに手動で連結するには、「参照をバインド」フィールドの横に表示されている参照アイコンをタップします。オブジェクトの選択​ダイアログに、親データモデルオブジェクトのすべてのプロパティが一覧表示されます。連結するプロパティを選択して、チェックマークアイコンをタップします。子プロパティと同じデータ型のプロパティのみを選択できます。

5. 「完了」をタップして子プロパティを保存し、「保存」タップしてフォームデータモデルを保存します。これで、子プロパティがデータモデルオブジェクトに追加されました。

データモデルのオブジェクトとプロパティを作成した後は、フォームデータモデルに基づいてアダプティブフォームとインタラクティブ通信を引き続き作成することができます。 後で、データソースを使用して設定する場合、フォームデータモデルとデータソースを連結できます。 連結の設定は、関連するアダプティブフォームとインタラクティブ通信内で自動的に更新されます。フォームデータモデルを使用してアダプティブフォームとインタラクティブ通信を作成する方法については、フォームデータモデルの使用を参照してください。

データモデルオブジェクトとプロパティの連結

フォームデータモデルに統合するデータソースが使用可能な状態になったら、データソースの更新に記載されている説明に従い、データソースをフォームデータモデルに追加することができます。その後、以下の手順を実行して、データソースに連結されていないデータモデルオブジェクトとプロパティを連結します。

1. フォームデータモデルで、データソースに連結するデータソースを選択します。

2. 「プロパティを編集」をタップします。

3. プロパティを編集​パネルで、「連結」フィールドの横に表示されている参照アイコンをタップします。この操作により、オブジェクトの選択​ダイアログが表示されます。このダイアログには、フォームデータモデル内に追加されたデータソースが一覧表示されます。

   

4. データソースツリーを展開し、連結するデータモデルオブジェクトを選択してチェックマークアイコンをタップします。

5. 「完了」をタップしてプロパティを保存し、「保存」をタップしてフォームデータモデルを保存します。これで、データモデルオブジェクトがデータソースに連結されました。これ以降は、データモデルオブジェクトに「連結されていない」というテキストが表示されることはありません。

   

サービスの設定

データモデルオブジェクトのデータの読み取りと書き込みを行うには、以下の手順を実行して、読み取りサービスと書き込みサービスを設定します。

1. データモデルオブジェクト上部のチェックボックスを選択して「プロパティを編集」をタップします。

   

   データモデルオブジェクトの読み取りサービスと書き込みサービスの設定を行う「プロパティを編集」

   プロパティ編集ダイアログが表示されます。

   

   プロパティを編集ダイアログ

   メモ

   OData サービスのメタデータドキュメントには、データモデルオブジェクトとサービスのほかに、2 つのデータモデルオブジェクト間の関連付けを定義するナビゲーションプロパティが含まれます。OData サービスデータソースをフォームデータモデルに追加すると、フォームデータモデル内のすべてのナビゲーションプロパティに対して、フォームデータモデル内のサービスが使用可能になります。 このサービスを使用して、対応するデータモデルオブジェクトのナビゲーションプロパティを読み取ることができます。

   このサービスの使用について詳しくは、「OData サービスのナビゲーションプロパティの操作」を参照してください。

2. 「トップレベルオブジェクト」を切り替えて、データモデルオブジェクトを最上位のモデルオブジェクトにするかどうかを指定します。

   フォームデータモデルで設定されたデータモデルオブジェクトは、フォームデータモデルに基づくアダプティブフォームのコンテンツブラウザーの「データモデルオブジェクト」タブで使用できます。 2 つのデータモデルオブジェクト間の関連付けを追加すると、「データモデルオブジェクト」タブで、関連付け先のデータモデルオブジェクトが、関連付け元のデータモデルオブジェクトの下にネストされます。ネストされたデータモデルが最上位のオブジェクトの場合は、「データモデルオブジェクト」タブにも別々に表示されます。 そのため、入れ子になった階層の内側と外側の 2 つのエントリが表示され、フォームの作成者が混乱する可能性があります。 関連するデータモデルオブジェクトをネストされた階層内だけで表示するには、そのデータモデルオブジェクトの「トップレベルオブジェクト」プロパティを無効にします。

3. 選択したデータモデルオブジェクトの読み取りサービスと書き込みサービスを選択します。各サービスの引数が表示されます。

   

   従業員データソースに対して設定されている読み取りサービスと書き込みサービス

4. 読み取りサービスの引数に表示されている をタップして、ユーザープロファイル属性、リクエスト属性またはリテラル値にその引数を連結し、連結値を指定します。

5. 「完了」をタップして引数を保存し、もう一度「完了」をタップしてプロパティを保存します。次に、「保存」をタップしてフォームデータモデルを保存します。

バインド読み取りサービスの引数

連結値に基づいて、バインド読み取りサービスの引数をユーザープロファイル属性、リクエスト属性またはリテラル値に連結します。この値が引数としてサービスに渡され、指定した値に関連付けられた詳細がデータソースから取得されます。

リテラル値

連結先​ドロップダウンメニューから「リテラル」を選択し、「連結値」フィールドに値を入力します。値に関連付けられている詳細がデータソースから取得されます。静的な値に関連付けられた詳細を取得するには、このオプションを使用します。

この例では、4367655678 に関連付けられた詳細が、mobilenum 引数の値としてデータソースから取得されます。モバイル番号の引数に値を渡す場合、関連する詳細には、顧客名、顧客の住所、市区町村などのプロパティを含めることができます。

ユーザープロファイルの属性

連結先​ドロップダウンメニューから「ユーザープロファイル属性」を選択し、「連結値」フィールドに属性名を入力します。AEM インスタンスにログインしたユーザーの詳細は、属性名に基づいてデータソースから取得されます。

属性名が 連結値 フィールドには、ユーザーの属性名まで完全なバインディングパスを含める必要があります。 以下の URL を開いて、CRXDE のユーザー詳細にアクセスします。

https://[server-name]:[port]/crx/de/index.jsp#/home/users/

この例では、grios ユーザーの「連結値」フィールドに profile.empid を指定します。

id 引数を使用してユーザープロファイルの empid 属性の値を取得し、それを引数として読み取りサービスに渡しています。ログインしたユーザーに関連付けられた empid の従業員データモデルオブジェクトから、関連付けられたプロパティの値を読み取って返します。

リクエスト属性

リクエスト属性を使用して、データソースから関連付けられたプロパティを取得します。

1. 連結先​ドロップダウンメニューから「リクエスト属性」を選択し、「連結値」フィールドに属性名を入力します。

2. head.jsp のオーバーレイを作成します。オーバーレイを作成するには、CRX DEを開き、https://<server-name>:<port number>/crx/de/index.jsp#/libs/fd/af/components/page2/afStaticTemplatePage/head.jsp ファイルを https://<server-name>:<port number>/crx/de/index.jsp#/apps/fd/af/components/page2/afStaticTemplatePage/head.jsp にコピーします

   メモ

   • 静的テンプレートを使用する場合は、head.jsp を以下の場所にオーバーレイします。
     /libs/fd/af/components/page2/afStaticTemplatePage/head.jsp
   • 編集可能なテンプレートを使用する場合は、aftemplatedpage.jsp を以下の場所でオーバーレイします。
     /libs/fd/af/components/page2/aftemplatedpage/aftemplatedpage.jsp

3. リクエスト属性に paramMap を設定します。例えば、apps フォルダーの .jsp ファイルに以下のコードを含めます。

   <%Map paraMap = new HashMap();
    paraMap.put("<request_attribute>",request.getParameter("<request_attribute>"));
    request.setAttribute("paramMap",paraMap);
   

   例えば、以下のコードを使用して、データソースから petid の値を取得します。

   <%Map paraMap = new HashMap();
   paraMap.put("petId",request.getParameter("petId"));
   request.setAttribute("paramMap",paraMap);%>
   

詳細は、リクエストで指定された属性名に基づいてデータソースから取得されます。

例えば、リクエストで属性を petid=100 と指定すると、属性値に関連付けられたプロパティがデータソースから取得されます。

関連付けの追加

通常、データソース内のデータモデルオブジェクト間には関連付けが作成されています。この関連付けは、1 対 1 の場合もあれば、1 対多の場合もあります。例えば、1 人の従業員に対して複数の扶養家族を関連付けることができます。これを、1 対多の関連付けといいます。関連するデータモデルオブジェクトを接続するライン上では、「1:n」として表示されます。それに対して、特定の従業員 ID で一意の従業員名が返される場合などは、1 対 1 の関連付けになります。

データソース内の関連データモデルオブジェクトをフォームデータモデルに追加した場合、それらの関連付けは維持され、矢印の線で接続された状態で表示されます。フォームデータモデル内の異なる複数のデータソース全体で、データモデルオブジェクト間に関連付けを作成できます。

関連付けを追加するには、以下の手順を実行します。

1. データモデルオブジェクト上部のチェックボックスを選択して「関連付けを追加」をタップします。関連付けを追加ダイアログが表示されます。

   

   メモ

   OData サービスのメタデータドキュメントには、データモデルオブジェクトとサービスのほかに、2 つのデータモデルオブジェクト間の関連付けを定義するナビゲーションプロパティが含まれます。フォームデータモデルで関連付けを追加する際に、これらのナビゲーションプロパティを使用することができます。詳しくは、OData サービスのナビゲーションプロパティの操作を参照してください。

   関連付けを追加ダイアログが表示されます。

   

   関連付けを追加ダイアログ

2. 関連付けを追加パネルで、以下の操作を実行します。

   • 関連付けのタイトルを入力します。
   • 関連付けのタイプ（「1 対 1」または「1 対多」）を選択します。
   • 関連付けるデータモデルオブジェクトを選択します。
   • 選択したモデルオブジェクトからデータを読み取るための読み取りサービスを選択します。読み取りサービスの引数が表示されます。必要に応じて引数を編集し、関連付けるデータモデルオブジェクトのプロパティにその引数を連結します。

   以下に示す例では、「扶養家族」データモデルオブジェクトの読み取りサービスのデフォルト引数が dependentid になっています。

   

   「扶養家族」読み取りサービスのデフォルト引数が dependentid になっている

   ただし、この引数は、関連付けるデータモデルオブジェクト間の共通プロパティ（この例の場合は Employeeid）でなければなりません。そのため、Employeeid 引数を「従業員」データモデルオブジェクトの id プロパティにバインドして、関連付けられている扶養家族の詳細情報を「扶養家族」データモデルオブジェクトから取得する必要があります。

   

   更新後の引数とバインド

   「完了」をクリックして、引数を保存します。

3. 「完了」をタップして関連付けを保存し、「保存」をタップしてフォームデータモデルを保存します。

4. さらに関連付けを作成するには、上記の手順を繰り返します。

プロパティの編集

フォームデータモデル内で追加されたデータモデルオブジェクト、プロパティ、サービスのプロパティを編集することができます。

プロパティを編集するには、以下の手順を実行します。

1. フォームデータモデル内のデータモデルオブジェクト、プロパティ、またはサービスの横に表示されているチェックボックスを選択します。

2. 「プロパティを編集」をタップします。選択したモデルオブジェクト、プロパティ、またはサービスの「プロパティを編集」パネルが表示されます。

   • データモデルオブジェクト：読み取りサービスと書き込みサービスを指定し、引数を編集します。
   • プロパティ：プロパティのタイプ、サブタイプ、形式を指定します。選択したプロパティをデータモデルオブジェクトのプライマリキーにするかどうかを指定することもできます。
   • サービス：サービスの入力モデルオブジェクト、出力タイプ、引数を指定します。Get サービスの場合は、配列を返す必要があるかどうかを指定することができます。

   

   Get サービスのプロパティを編集ダイアログ

3. 「完了」をタップしてプロパティを保存し、「保存」をタップしてフォームデータモデルを保存します。

計算済みプロパティを作成

計算済みプロパティとは、ルールまたは式に基づいて値が計算されるプロパティのことです。ルールを使用して、計算済みプロパティの値を、リテラル文字列、数値、数式の計算結果、フォームデータモデル内の別のプロパティの値に設定できます。

例えば、FirstName プロパティと LastName プロパティの値を組み合わせた値を持つ FullName プロパティを作成することができます。そのためには、以下の手順を実行します。

1. という名前でプロパティを作成します。 FullName のデータタイプは String です。

2. 「計算済み」を有効にし、「完了」をタップしてプロパティを作成します。

   

   これにより、FullName という名前の計算済みプロパティが作成されます。このプロパティの横に、計算済みプロパティであることを表すアイコンが表示されます。

   

3. 「FullName」プロパティを選択して「ルールを編集」をタップします。ルールエディターウィンドウが表示されます。

4. ルールエディターウィンドウで、「作成」をタップします。「Set Value」ルールウィンドウが表示されます。

   オプション選択ドロップダウンで、「数式」を選択します。「フォームデータモデルのオブジェクト」オプションと「文字列」オプションを選択することもできます。

5. 数式の最初のオブジェクトとして「FirstName」を選択し、2 番目のオブジェクトとして「LastName」を選択します。演算子として「プラス」を選択します。

   「完了」、「閉じる」の順に選択して、ルールエディターウィンドウを閉じます。ルールは以下のようになります。

   

6. フォームデータモデルで、「保存」をタップします。これで、計算済みプロパティが設定されました。

OData サービスのナビゲーションプロパティの操作

OData サービスでは、ナビゲーションプロパティを使用して、2 つのデータモデルオブジェクト間の関連付けが定義されます。これらのプロパティは、エンティティタイプまたは複合タイプに対して定義されます。例えば、サンプルの TripPin OData サービスのメタデータファイルから抽出した以下のコードの場合、Friends、BestFriend、Trips という 3 つのナビゲーションプロパティが Person エンティティに含まれています。

ナビゲーションプロパティについて詳しくは、「OData のドキュメント」を参照してください。

<edmx:Edmx xmlns:edmx="https://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
<script/>
<edmx:DataServices>
<Schema xmlns="https://docs.oasis-open.org/odata/ns/edm" Namespace="Microsoft.OData.Service.Sample.TrippinInMemory.Models">
<EntityType Name="Person">
<Key>
<PropertyRef Name="UserName"/>
</Key>
<Property Name="UserName" Type="Edm.String" Nullable="false"/>
<Property Name="FirstName" Type="Edm.String" Nullable="false"/>
<Property Name="LastName" Type="Edm.String"/>
<Property Name="MiddleName" Type="Edm.String"/>
<Property Name="Gender" Type="Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender" Nullable="false"/>
<Property Name="Age" Type="Edm.Int64"/>
<Property Name="Emails" Type="Collection(Edm.String)"/>
<Property Name="AddressInfo" Type="Collection(Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location)"/>
<Property Name="HomeAddress" Type="Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location"/>
<Property Name="FavoriteFeature" Type="Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature" Nullable="false"/>
<Property Name="Features" Type="Collection(Microsoft.OData.Service.Sample.TrippinInMemory.Models.Feature)" Nullable="false"/>
<NavigationProperty Name="Friends" Type="Collection(Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person)"/>
<NavigationProperty Name="BestFriend" Type="Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"/>
<NavigationProperty Name="Trips" Type="Collection(Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip)"/>
</EntityType>

フォームデータモデル内で OData サービスを設定すると、そのフォームデータモデル内のサービスを経由して、エンティティコンテナ内のすべてのナビゲーションプロパティを使用できるようになります。このサンプルの TripPin OData サービスでは、フォームデータモデル内の GET LINK サービスを使用して、Person エンティティコンテナに含まれている 3 つのナビゲーションプロパティを読み取ることができます。

以下の図では、フォームデータモデル内の GET LINK of Person /People サービスがハイライト表示されています。これは、TripPin OData サービスの Person エンティティに含まれている 3 つのナビゲーションプロパティを組み合わせたサービスです。

フォームデータモデルの「サービス」タブに GET LINK サービスを追加すると、サービス内で使用する出力モデルオブジェクトとナビゲーションプロパティを選択するための各種プロパティを編集できるようになります。例えば、以下の GET LINK of Person /People サービスでは、出力モデルオブジェクトとして「Trip」を使用し、ナビゲーションプロパティとして「Trips」を使用しています。

この例では、出力モデルオブジェクトとして「Person」を選択し、ナビゲーションプロパティの引数として「Friends」または「BestFriend」を選択することもできます（どちらを選択するかは、「配列を返しますか？」ボタンが有効になっているか無効になっているかによって異なります）。

同様に、フォームデータモデルで関連付けを追加する際に GET LINK サービスを選択し、サービスのナビゲーションプロパティを設定できます。ただし、ナビゲーションプロパティを選択するには、連結先​ドロップダウンメニューで「リテラル」に設定されている必要があります。

サンプルデータの生成と編集

フォームデータモデルエディターでは、計算済みプロパティを含む、すべてのデータモデルオブジェクトプロパティのサンプルデータを、フォームデータモデル内で生成することができます。 各プロパティで設定されたデータタイプに基づいて、一連のランダムな値がサンプルデータとして生成されます。このサンプルデータを編集して保存することもできます。サンプルデータを再生成した場合も、編集したサンプルデータは保存されたままになります。

サンプルデータを生成して編集するには、以下の手順を実行します。

1. フォームデータモデルを開き、をタップします。 サンプルデータを編集. サンプルデータが生成され、サンプルデータ編集ウィンドウに表示されます。

   

2. 「サンプルデータを編集」ウィンドウでデータを編集して「保存」をタップします。

次に、サンプルデータを使用して、フォームデータモデルに基づいて、インタラクティブ通信の事前入力とテストをおこなうことができます。 詳しくは、フォームデータモデルの使用を参照してください。

データモデルオブジェクトとサービスのテスト

フォームデータモデルが設定されているが、使用する前に、設定済みのデータモデルオブジェクトおよびサービスが期待どおりに動作しているかどうかをテストする必要がある場合があります。 データモデルオブジェクトとサービスをテストするには、以下の手順を実行します。

1. フォームデータモデル内のデータモデルオブジェクトまたはサービスを選択してをタップします。 モデルオブジェクトのテスト または サービスをテスト、それぞれ。

   フォームデータモデルをテストウィンドウが表示されます。

   

2. フォームデータモデルをテストウィンドウの入力ペインで、テストするデータモデルオブジェクトまたはサービスを選択します。

3. テストコードで引数の値を指定して「テスト」をタップします。テストが成功すると、出力パネルに出力情報が表示されます。

   

同様の方法で、フォームデータモデル内の他のデータモデルオブジェクトやサービスをテストできます。

入力データの自動検証

フォームデータモデルは、DermisBridge API を呼び出す際に入力として受け取ったデータを（フォームデータモデルで使用可能な検証条件に基づいて）検証します。検証は、API の呼び出しに使用されるクエリオブジェクトに設定された ValidationOptions フラグに基づいて行われます。

このフラグは、以下のいずれかの値に設定できます。

• 完全：FDM は、すべての制約に基づいて検証を実行します
• オフ：検証なし
• 基本：FDM は、「required」制約および「nullable」制約に基づいて検証を実行します

ValidationOptionsフラグに値が設定されていない場合、入力データに対して​基本​検証が実行されます。

以下に、検証フラグを​完全​に設定する例を示します。

operationOptions.setValidationOptions(ValidationOptions.FULL);

フォームデータモデルは、データタイプ制約のリストに基づいて入力データを検証します。入力データに対する制約のリストは、データソースによって異なる場合があります。

以下の表に、データソースに基づく入力データの制約事項を示します。

この例では、Swagger ファイルで定義されている最大制約、最小制約、必須制約に基づいて入力データが検証されます。注文 ID が存在し、その値が 1 ～ 10 の場合にのみ、入力データは検証条件を満たします。

   parameters: [
   {
   name: "orderId",
   in: "path",
   description: "ID of pet that needs to be fetched",
   required: true,
   type: "integer",
   maximum: 10,
   minimum: 1,
   format: "int64"
   }
   ]

入力データが検証条件を満たさない場合は、例外が表示されます。ログレベルが「デバッグ」に設定されている場合は、error.log ファイルにエラーが記録されます。例：

21.01.2019 17:26:37.411 *ERROR* com.adobe.aem.dermis.core.validation.JsonSchemaValidator {"errorCode":"AEM-FDM-001-044","errorMessage":"Input validations failed during operation execution.","violations":{"/orderId":["numeric instance is greater than the required maximum (maximum: 10, found: 16)"]}}

次の手順

これで、アダプティブフォームとインタラクティブ通信のワークフローで使用する準備が整い、作業用フォームデータモデルが作成されました。 詳しくは、フォームデータモデルの使用を参照してください。