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

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

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

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

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

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

• データベースの設定
• MySQL データベースをデータソースとして設定する
• フォームデータモデルの作成
• フォームデータモデルを設定する
• フォームデータモデルのテストを行う

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

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

前提条件

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

• 「データベースを設定する」セクションの記載に従って MySQL データベースにサンプルデータが取り込まれていること
• 「JDBCデータベースドライバーのバンドル」で説明されている、MySQL JDBCドライバー用のOSGiバンドル

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

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

次の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

呼び出し​テーブルには、呼び出し日、呼び出し時間、呼び出し番号、呼び出し期間、呼び出し料金などの呼び出しの詳細が含まれます。 customer​テーブルは、「モバイル番号(mobilenum) 」フィールドを使用して呼び出しテーブルにリンクされます。 customer​テーブルにリストされているモバイル番号ごとに、calls​テーブルに複数のレコードが存在します。 例えば、calls​テーブルを参照して、1457892541​携帯電話番号の呼び出しの詳細を取得できます。

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

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

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

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

1. MySQLデータベース用のJDBCドライバーをOSGiバンドルとしてインストールします。

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

   2. 「インストール/更新」をタップします。 「Upload / Install Bundles」ダイアログが表示されます。

   3. 「Choose File」をタップし、MySQL JDBC ドライバーの OSGi バンドルを探して選択します。「Start Bundle」と「Refresh 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 Return: 「Test on Return」オプショ ンを有効に します。

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

      • Transaction Isolation：このオプションの値を「READ_COMMITTED」に設定します。

   他のプロパティはデフォルトの値のままにし、「保存」をタップします。

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

   

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

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

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

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

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

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

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

   

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

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

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

• データモデルオブジェクトとサービスの追加
• データモデルオブジェクト用の計算済み子プロパティの作成
• データモデルオブジェクト間の関連付けの追加
• データモデルオブジェクトプロパティの編集
• データモデルオブジェクト用サービスの設定

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

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

2. 先ほど作成した​FDM_Create_First_IC​フォームデータモデルを次に示します。 これを選択し、「編集」をタップします。

   選択したデータソース​MySQL​が​データソース​ウィンドウに表示されます。

   

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

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

     • 請求
     • 通話
     • 顧客

   • Services:

     • get
     • 更新

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

   

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

   

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

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

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

• 使用料=通話料+会議通話料+ SMS料+モバイルインターネット料+ローミング国際料金+ローミング国際料金+ VAS （これらのプロパティはすべて請求データモデルオブジェクトに存在します）
  usagecharges​子計算済みプロパティの詳細については、インタラクティブ通信の計画を参照してください。

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

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

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

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

   

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

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

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

   

6. 数式で、callcharges​と​confcallcharges​をそれぞれ1番目と2番目のオブジェクトとして選択します。 演算子として「プラス」を選択します。数式内の領域をタップして「拡張式」をタップし、smscharges、internetcharges、roamingnational、roamingintnl、および vas を数式のオブジェクトに追加します。

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

   

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

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

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

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

   

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

   

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

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

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. 「サンプルデータを編集」ウィンドウでデータを編集して「保存」をタップします。ウィンドウを閉じます。