チュートリアル:フォームデータモデルの作成

04-create-form-data-model-main

これは、「最初のインタラクティブ通信の作成」シリーズを構成するチュートリアルです。チュートリアル内のユースケースを理解して実際に操作できるように、このシリーズのチュートリアルを最初から順に学習することをお勧めします。

このチュートリアルについて

AEM Forms のデータ統合モジュールにより、AEM ユーザープロファイル、RESTful Web サービス、SOAP ベースの Web サービス、OData サービス、リレーショナルデータベースなど、様々なバックエンドデータソースを使用してフォームデータモデルを作成することができます。フォームデータモデル内でデータモデルオブジェクトとサービスを設定し、そのフォームデータモデルをアダプティブフォームに関連付けることができます。アダプティブフォームのフィールドは、データモデルオブジェクトのプロパティに連結されます。フォームデータモデル内のサービスを使用して、アダプティブフォームに事前にデータを取り込み、送信されたフォームデータをデータモデルオブジェクトに書き込むことができます。

フォームデータの統合機能とフォームデータモデルについて詳しくは、「AEM Forms のデータ統合機能」を参照してください。

このチュートリアルでは、フォームデータモデルの準備、作成、設定を行い、そのフォームデータモデルをインタラクティブ通信に関連付けるための手順について、順を追って説明します。このチュートリアルを完了すると、次の操作を実行できるようになります。

フォームデータモデルは以下に類似しています。

フォームデータモデル

A. 設定済みのデータソース B. データソーススキーマ C. 利用可能なサービス D. データモデルオブジェクト E. 設定済みサービス

前提条件

作業を開始する前に、以下の条件が満たされているかどうかを確認してください。

手順 1:データベースの設定

インタラクティブ通信の作成にはデータベースが不可欠です。このチュートリアルではデータベースを使用して、インタラクティブ通信のフォームデータモデルと永続性機能を表示します。顧客、請求および通話のテーブルを含むデータベースを設定します。以下の画像は、顧客テーブルのサンプルデータを示しています。

sample_data_cust

以下の DDL ステートメントを使用して、データベース内に customer というテーブルを作成します。

CREATE TABLE `customer` (
   `mobilenum` int(11) NOT NULL,
   `name` varchar(45) NOT NULL,
   `address` varchar(45) NOT NULL,
   `alternatemobilenumber` int(11) DEFAULT NULL,
   `relationshipnumber` int(11) DEFAULT NULL,
   `customerplan` varchar(45) DEFAULT NULL,
   PRIMARY KEY (`mobilenum`),
   UNIQUE KEY `mobilenum_UNIQUE` (`mobilenum`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8

以下の DDL ステートメントを使用して、データベース内に bills というテーブルを作成します。

CREATE TABLE `bills` (
   `billplan` varchar(45) NOT NULL,
   `latepayment` decimal(4,2) NOT NULL,
   `monthlycharges` decimal(4,2) NOT NULL,
   `billdate` date NOT NULL,
   `billperiod` varchar(45) NOT NULL,
   `prevbal` decimal(4,2) NOT NULL,
   `callcharges` decimal(4,2) NOT NULL,
   `confcallcharges` decimal(4,2) NOT NULL,
   `smscharges` decimal(4,2) NOT NULL,
   `internetcharges` decimal(4,2) NOT NULL,
   `roamingnational` decimal(4,2) NOT NULL,
   `roamingintnl` decimal(4,2) NOT NULL,
   `vas` decimal(4,2) NOT NULL,
   `discounts` decimal(4,2) NOT NULL,
   `tax` decimal(4,2) NOT NULL,
   PRIMARY KEY (`billplan`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8

以下の DDL ステートメントを使用して、データベース内に calls というテーブルを作成します。

CREATE TABLE `calls` (
   `mobilenum` int(11) DEFAULT NULL,
   `calldate` date DEFAULT NULL,
   `calltime` varchar(45) DEFAULT NULL,
   `callnumber` int(11) DEFAULT NULL,
   `callduration` varchar(45) DEFAULT NULL,
   `callcharges` decimal(4,2) DEFAULT NULL,
   `calltype` varchar(45) DEFAULT NULL
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8

通話 テーブルには、通話の日付、通話の時間、通話番号、通話時間、通話料金などの詳細が含まれます。顧客 テーブルは携帯電話番号(mobilenum)フィールドにより通話テーブルとリンクしています。顧客​テーブルにリストされた各携帯電話番号ごとに、通話​テーブルに複数の記録があります。例えば、1457892541 という携帯電話番号の通話の詳細を、通話​テーブルを参照することで取得できます。

請求​テーブルには請求日、請求期間、月額利用料、通話料金などの請求明細が含まれます。顧客​テーブルは請求プランフィールドにより​請求​テーブルとリンクしています。顧客​テーブルには、各顧客と関連付けられたプランがあります。請求​テーブルには、既存のすべてのプランの価格の詳細が含まれます。例えば、Sarah のプランの詳細を顧客テーブルから取得し​​この情報を使って請求テーブルから価格の詳細を取得することができます​

手順 2:MySQL データベースをデータソースとして設定する

各種のデータソースを設定して、フォームデータモデルを作成することができます。このチュートリアルでは、サンプルデータが取り込まれた MySQL データベースの設定を行います。サポートされている他のデータソースとその設定方法については、「AEM Forms のデータ統合機能」を参照してください。

MySQL データベースを設定するには、以下の手順を実行します。

  1. 以下の手順により、MySQL データベース用の JDBC ドライバーを OSGi バンドルとしてインストールします。

    1. AEM Forms のオーサーインスタンスに管理者としてログインし、AEM Web コンソールバンドルに移動します。デフォルトの URL は、https://localhost:4502/system/console/bundles です。

    2. Install/Update をタップします。「Upload / Install Bundles」ダイアログが表示されます。

    3. Choose File」をタップし、MySQL JDBC ドライバーの OSGi バンドルを探して選択します。Start BundleRefresh Packages を選択して Install または Update をタップします。Oracle が提供する MySQL の JDBC ドライバーがアクティブになっていることを確認します。ドライバーがインストールされます。

  2. 以下の手順により、MySQL データベースをデータソースとして設定します。

    1. AEM Web コンソール(https://localhost:4502/system/console/configMgr)に移動します。

    2. Apache Sling Connection Pooled DataSource」という設定を探し、その設定をタップして編集モードで開きます。

    3. 設定ダイアログで、以下の詳細情報を指定します。

      • Datasource name:任意のデータソース名を指定します。例えば、 MySQL などを指定します。

      • DataSource service property name:データソース名を保管するサービスプロパティの名前を指定します。この名前は、データソースインスタンスを OSGi サービスとして登録する際に指定されます。例えば、「datasource.name」などを指定します。

      • JDBC driver class:JDBC ドライバーの Java クラス名を指定します。MySQL データベースの場合は、com.mysql.jdbc.Driver と指定します。

      • JDBC connection URI:データベースの接続 URL を指定します。ポート 3306 とスキーマ teleca 上で稼働する MySQL データベースの場合、URL は jdbc:mysql://'server':3306/teleca?autoReconnect=true&useUnicode=true&characterEncoding=utf-8 です。

      • Username:データベースのユーザー名を指定します。データベースとの接続を確立するには、JDBC ドライバーを有効にする必要があります。

      • Password:データベースのパスワードを指定します。データベースとの接続を確立するには、JDBC ドライバーを有効にする必要があります。

      • Test on Borrow:Test on Borrow オプションを有効にします。

      • Test on Return:Test on Return オプションを有効にします。

      • Validation Query:プールからの接続状態を確認するための SQL SELECT クエリを指定します。このクエリでは、1 行以上の行が返される必要があります。例:select * from customer

      • Transaction Isolation:このオプションの値を「READ_COMMITTED」に設定します。
        上記以外のプロパティはデフォルトのままにして Save をタップします。

    以下のような設定が作成されます。

    Apache 設定

手順 3:フォームデータモデルを作成する

AEM Forms には、設定済みデータソースを使用してフォームデータモデルを作成するための直感的なユーザーインターフェイスが用意されています。1 つのフォームデータモデル内で複数のデータソースを使用することができます。本チュートリアルのユースケースでは、MySQL をデータソースとして使用します。

フォームデータモデルを作成するには、以下の手順を実行します。

  1. AEM オーサーインスタンスで、フォームデータ統合​に移動します。

  2. 作成フォームデータモデル​の順にタップします。

  3. フォームデータモデル作成ウィザードで、フォームデータモデルの​名前​を指定します。例えば FDM_Create_First_IC などと指定します。「次へ」をタップします。

  4. データソース選択画面に、すべての設定済みデータソースが一覧表示されます。MySQL データソースを選択して​作成​をタップします。

    MYSQL データソース

  5. 完了」をクリックします。FDM_Create_First_IC というフォームデータモデルが作成されます。

手順 4:フォームデータモデルを設定する

フォームデータモデルの設定には以下が含まれます。

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

  1. AEM オーサーインスタンスで、フォームデータ統合​に移動します。デフォルトの URL は、https://localhost:4502/aem/forms.html/content/dam/formsanddocuments-fdm です。

  2. 前の手順で作成した FDM_Create_First_IC というフォームデータモデルが表示されます。これを選択し、「編集」をタップします。

    選択されたデータソース MySQL が​データソース​ペインに表示されます。

    FDM 用の MYSQL データソース

  3. MySQL データソースツリーを展開します。teleca スキーマで、以下のデータモデルオブジェクトとサービスを選択します。

    • データモデルオブジェクト:

      • 請求
      • 通話
      • 顧客
    • Services:

      • get
      • 更新

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

    データモデルオブジェクトサービスを選択

    請求、通話および顧客のデータモデルオブジェクトは、「モデル」タブの右側のペインに表示されます。get サービスと update サービスは、「サービス」タブに表示されます。

    データモデルオブジェクト

データモデルオブジェクト用の計算済み子プロパティの作成

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

ユースケースに基づき、以下の数式を使って​請求​データモデルオブジェクトの usagecharges 計算済み子プロパティを作成します。

  • 利用料金 = 通話料金 + 会議通話料金 + SMS 料金 + 携帯インターネット料金 + 国内ローミング料金 + 国際ローミング料金 + VAS(これらのすべてのプロパティは bills データモデルオブジェクトに含まれます)usagecharges の計算済み子プロパティについて詳しくは、インタラクティブ通信の計画を参照してください。

請求データモデルオブジェクト用の計算済み子プロパティを作成するには、次の手順を実行します。

  1. 請求​データモデルオブジェクト上部のチェックボックスを選択して、「子プロパティを作成」をタップします。

  2. 子プロパティを作成​ペインで、

    1. 子プロパティの名前として usagecharges を入力します。
    2. 計算済み」を有効にします。
    3. タイプとして「フロート」を選択し、「完了」をタップし、子プロパティを​請求​データモデルオブジェクトに追加します。

    子プロパティを作成

  3. ルールを編集」をタップしてルールエディターを開きます。

  4. 作成」をタップします。「Set Value」ルールウィンドウが開きます。

  5. オプション選択ドロップダウンで、「数式」を選択します。

    使用料金ルールエディター

  6. 数式の最初のオブジェクトとして「callcharges」を選択し、2 番目のオブジェクトとして「confcallcharges」を選択します。演算子として「プラス」を選択します。数式内の領域をタップして「拡張式」をタップし、smschargesinternetchargesroamingnationalroamingintnl、および vas を数式のオブジェクトに追加します。

    次の画像はルールエディター内の数式を示しています。

    使用料金ルール

  7. 完了」をタップします。ルールエディター内でルールが作成されます。

  8. 閉じる」をタップして、ルールエディターウィンドウを閉じます。

データモデルオブジェクト間の関連付けの追加

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

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

ユースケースに基づき、データモデルオブジェクト間で以下の関連付けを作成します。

関連付け データモデルオブジェクト
1:n customer:calls(月々の請求書で、1 人の顧客と複数の通話を関連付けられます)
1:1 customer:bills(特定の月の請求書で、1 つの請求を 1 人の顧客と関連付けます)

データモデルオブジェクト間で関連性を作成するには、以下の手順を実行します。

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

  2. 関連付けを追加​ペインで、以下の操作を実行します。

    • 関連付けのタイトルを入力します。これはオプションのフィールドです。

    • タイプ」ドロップダウンリストから「1 対多」を選択します。

    • モデルオブジェクト」ドロップダウンリストから calls を選択します。

    • サービス」ドロップダウンリストから get を選択します。

    • 追加」をタップして、プロパティを使用して​顧客​データモデルオブジェクトを​通話​データモデルオブジェクトにリンクします。ユースケースに基づいて、通話データモデルオブジェクトは顧客データモデルオブジェクトの携帯電話番号プロパティにリンクされている必要があります。引数を追加​ダイアログボックスが開きます。

    関連付けを追加

  3. 引数を追加​ダイアログボックスで、

    • 名前」ドロップダウンリストから「mobilenum」を選択します。携帯電話プロパティは、顧客および通話データモデルオブジェクトで利用できる共通プロパティです。その結果、プロパティは顧客と通話データモデルオブジェクト間の関連付けを作成するために使用されます。顧客データモデルオブジェクトに用意された各携帯電話番号ごとに、通話テーブルに複数の記録を参照できます。

    • 引数の任意のタイトルと説明を指定する。

    • 連結先」ドロップダウンリストから「customer」を選択します。

    • 連結値」ドロップダウンリストから「mobilenum」を選択します。

    • 追加」をタップします。

    引数の関連付けを追加

    mobilenum プロパティが​引数​セクションに表示されます。

    引数の関連付けを追加

  4. 完了」をタップすると、顧客と通話データモデルオブジェクト間で 1:n の関連付けが作成されます。

    顧客および通話データモデルオブジェクト間で関連付けを作成したら、顧客と通話データモデルオブジェクト間で 1:1 の関連付けを作成します。

  5. 顧客​データモデルオブジェクト上部のチェックボックスを選択して「関連付けを追加」をタップします。関連付けを追加​プロパティペインが表示されます。

  6. 関連付けを追加​ペインで、以下の操作を実行します。

    • 関連付けのタイトルを入力します。これはオプションのフィールドです。

    • タイプ」ドロップダウンリストから「1 対 1」を選択します。

    • モデルオブジェクト」ドロップダウンリストから「請求」を選択します。

    • サービス」ドロップダウンリストから get を選択します。billplan プロパティは請求テーブルのプライマリキーであり、「引数」セクションにすでに用意されています。
      請求および顧客データモデルオブジェクトは、それぞれbillplan(請求)および customerplan(顧客)プロパティを使ってリンクされています。これらのプロパティ間で連結を作成し、MySQL データベースに含まれるあらゆる顧客の計画の詳細を取得します。

    • 連結先」ドロップダウンリストから「customer」を選択します。

    • 連結値」ドロップダウンリストから「customerplan」を選択します。

    • 完了」をタップして billplan と customerplan プロパティの間で連結を作成します。

    顧客請求の関連付けを追加

    以下の画像は、データモデルオブジェクト間の関連付けと、関連付けの作成に使用されているプロパティを示します。

    fdm_associations

データモデルオブジェクトプロパティの編集

顧客とほかのデータモデルオブジェクト間で関連付けを作成後、顧客プロパティを編集し、データモデルオブジェクトから取得されたデータに基づいてプロパティを定義します。ユースケースに基づいて、携帯電話番号は顧客データモデルオブジェクトからデータを取得するためのプロパティとして使用されます。

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

  2. 顧客​を​トップレベルモデルオブジェクト​として指定します。

  3. 読み取りサービス」ドロップダウンで「get」を選択します。

  4. 引数​セクションで、

    • 連結先」ドロップダウンリストから「属性を要求」を選択します。

    • mobilenum を連結値として指定します。

  5. 書き込み​サービスのドロップダウンリストから「更新」を選択します。

  6. 引数​セクションで、

    • mobilenum プロパティとして、「連結先」ドロップダウンリストから「顧客」を選択します。

    • 連結値」ドロップダウンリストから「mobilenum」を選択します。

  7. 完了」をタップして、プロパティを保存します。

    サービスの設定

  8. 通話​データモデルオブジェクト上部のチェックボックスを選択して「プロパティを編集」をタップします。プロパティを編集​ペインが開きます。

  9. トップレベルモデルオブジェクト​を、通話​データモデルオブジェクトに対して無効にします。

  10. 完了」をタップします。

    手順 8~10 を繰り返し、請求​データモデルオブジェクトのプロパティを設定します。

サービスの設定

  1. サービス」タブに移動します。

  2. get サービスを選択して「プロパティの編集」をタップします。プロパティを編集​ペインが開きます。

  3. プロパティを編集​ペインで、

    • 任意のタイトルと説明を入力します。

    • 出力モデルオブジェクト」ドロップダウンリストから「顧客」を選択します。

    • 完了」をタップして、プロパティを保存します。

    プロパティの編集

  4. update サービスを選択して「プロパティの編集」をタップします。プロパティを編集​ペインが開きます。

  5. プロパティを編集​ペインで、

    • 任意のタイトルと説明を入力します。

    • 入力モデルオブジェクト」ドロップダウンリストから「顧客」を選択します。

    • 完了」をタップします。

    • 保存」をタップして、フォームデータモデルを保存します。

    サービスプロパティを更新

手順 5:フォームデータモデルとサービスのテストを実行する

データモデルオブジェクトとサービスをテストすることにより、フォームデータモデルが正しく設定されているかどうかを確認することができます。

テストを実行するには、以下の手順を実行します。

  1. モデル​タブに移動し、顧客​データモデルオブジェクトを選択して、モデルオブジェクトをテスト​をタップします。

  2. テストフォームデータモデル​ウィンドウの​モデル / サービスを選択​ドロップダウンリストから​モデルオブジェクトを読み込み​を選択します。

  3. 入力​セクションで、設定済み MySQL データベース内の mobilenum プロパティを指定して​テスト​をタップします。

    指定した mobilenum プロパティに関連付けられている顧客の詳細情報がデータベースから取得され、以下のように「出力」セクションに表示されます。ダイアログボックスを閉じます。

    データモデルのテストをおこなう

  4. サービス」タブに移動します。

  5. get サービスを選択して​サービスをテスト​をタップします。

  6. 入力​セクションで、設定済み MySQL データベース内の mobilenum プロパティを指定して​テスト​をタップします。

    指定した mobilenum プロパティに関連付けられている顧客の詳細情報がデータベースから取得され、以下のように「出力」セクションに表示されます。ダイアログボックスを閉じます。

    サービスをテスト

サンプルデータの編集と保存

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

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

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

    サンプルデータを編集する

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

このページ