現在表示中:

概要

Adobe Experience Manager Forms のルール編集機能により、フォームのビジネスユーザーや開発者がアダプティブフォームオブジェクトにルールを追加できるようになります。これらのルールは、フォームオブジェクト上でトリガされるアクションを定義します。それらのアクションは、事前定義された条件、ユーザ入力、およびフォーム上のユーザーアクションに基づいてトリガされます。さらに、フォーム入力時の作業を合理化することで、正確で素早く入力できるフォームの実現に役立ちます。

ルールエディタでは、ルールを記述するための直感的でシンプルなユーザーインターフェイスを備えています。ルール記述用のエディターとして、ビジュアルエディターとコードエディターが用意されています。アダプティブフォームオブジェクト上でルールを用いることにより実行できるアクションのうち、主なものは以下のとおりです。

  • オブジェクトの表示 / 非表示を切り替える
  • オブジェクトの有効 / 無効を切り替える
  • オブジェクトの値を設定する
  • オブジェクトの値を検証する
  • 関数を実行することにより、オブジェクトの値を計算する
  • Web サービス操作を呼び出し処理を実行する
  • オブジェクトのプロパティを設定する

ルールエディタは、AEM6.1 Forms 以前のリリースにおけるスクリプト作成機能を置き換えるものです。ただし、既存のスクリプトは、新しいルールエディターからも利用できます。ルールエディタで既存のスクリプトを編集する方法の詳細については、「既存のスクリプトに対するルールエディタの影響」を参照してください。

ルールを理解する

「ルール」とは、アクションと条件を組み合わせたものを指します。ルールエディターでは、「非表示」、「表示」、「有効化」や「無効化」の各アクションに加え、フォーム内のオブジェクトの値を計算するアクションなどを編集できます。「条件」とは、フォームオブジェクトの状態、値、またはプロパティに対して確認や処理を実行し、それにより評価されるブール式を指します。「アクション」は、条件を評価して返された値(True または False)に基づいて実行されます。

ルールエディターでは、事前定義された一連のルールタイプを利用できます。これらのルールには、「When」、「Show」、「Hide」、「Enable」、「Disable」、「Set Value Of」、および「Validate 」などが含まれており、ルールを記述するのに便利です。各ルールタイプでは、ルール内の条件とアクションを定義することができます。この記事では、各ルールタイプについてさらに詳細に説明します。

一般的なルールは、次のいずれかの構文に従います。

条件=アクション

この構文では、条件を最初に定義し、トリガーするアクションを次に定義します。構文は、プログラミング言語における if-then 文に匹敵します。

ルールエディタで「When」ルールタイプを使用することで、条件=アクションの構文が適用されます。

アクション条件

この構文では、トリガーするアクションを最初に定義し、続いて評価条件を定義します。この構文の別の様式は、「アクション=条件=代替アクション」型です。この中では、条件がFalse を返した場合にトリガする代替アクションも定義します。

ルールエディタで「Show」、「Hide」、「Enable」、「Disable」、「Set Value Of」、「Validate 」の各ルールを設定すると、「アクション=条件」ルール構文が適用されます。デフォルトでは、「Show」の代替アクションは「Hide」、「Enable」の代替アクションは「Disable」(それらの逆も同様)です。デフォルトの代替アクションは変更できません。

注意:

利用可能なルールタイプ(ルールエディタで定義した条件やアクションを含む)は、ルールを作成しているフォームオブジェクトの種類によっても異なります。ルールエディターには、条件やアクション構文を作成できる有効なルールタイプとオプションのみが表示されます。すなわち、ここでの表示内容は、特定のフォームオブジェクトタイプに合わせて変化します。たとえば、パネルオブジェクトでは、「Validate」、「Set Value Of」、「Enable」や「Disable」の各ルールは表示されません。

ルールエディターで使用可能なルールタイプの詳細については、「ルールエディターで利用できるルールタイプ」を参照してください。

ルール構文の選択ガイドライン

どのルール構文を使用しても大部分のユースケースを満たすことはできますが、ここでは特定のルールを選択するための、いくつかのガイドラインを紹介します。ルールエディターで使用可能なルールの詳細については、「ルールエディターで利用できるルールタイプ」を参照してください。

  • ルールを作成する際は一般に、ルールを作成するオブジェクトの背景について考えることから始めます。「フィールド A」にユーザが入力した値に応じて、「フィールド B」の表示・非表示を切り替える場合を想定します。この場合、「フィールド A」の状態を評価し、その戻り値に基づいて「フィールド B」のアクションをトリガします。

    従って、「フィールド B」(状態を評価するオブジェクト)上にルールを記述する場合、「条件=アクション」型の構文か、または「When」のルールタイプを使用します。同様に、「フィールド A」についても、「アクション=条件」構文か、または「Show」・「Hide」のルールタイプを使用します

  • 時には、1 つの条件に基づいて複数のアクションを実行する必要があるかもしれません。そのような場合は、「条件=アクション」構文の使用を推奨します。この構文では、一度条件を評価し、その後に複数のアクション文を指定することができます。

    たとえば、ユーザーが「フィールド A」に入力した値を確認する条件を設け、その戻り値に応じて「B」、「C」、「D」の各フィールドを非表示にするには、まず、「フィールド A」に対して「条件=アクション」の構文を記述するか、あるいは「When」のルールタイプを使用し、「B」、「C」、「D」の各フィールドについて表示状態を制御するアクションを作成します。この形式を取らない場合は、「B」、「C」、「D」のフィールドごとに別々のルールを3つ記述し、それぞれ「フィールド A」の状態を確認させる必要が生じます。この例では、3つのオブジェクトに「Show」・「Hide」のルールのタイプを記述するよりも、むしろ単一のオブジェクトに「When」のルールタイプを記述する方が効率的です。

  • 複数の条件に基づいてアクションをトリガする場合は、「アクション=条件」構文の使用が奨励されます。たとえば、「B」、「C」、「D」の各フィールドの状態を評価し、その戻り値に応じて「フィールド A」の表示・非表示を切り替える場合は、「フィールド A」に「表示・非表示」のルールタイプを記述します。
  • 1つの条件に対して1つのアクションが指定されているルールでは、「条件=アクション」または「アクション=条件」構文を使用してください。
  • フィールドに値を入力した直後や、フィールドを閉じた直後にルールによって条件を確認し、アクションを実行する場合は、条件を評価するフィールドに対して「条件=アクション」型の構文か、「When」のルールタイプを記述することが奨励されます。 
  • 「When」のルール内に記述した条件は、その条件が適用されるオブジェクトの値をユーザが変更した際に評価されます。しかし、値が変更された場合にサーバ側でアクションをトリガする場合(値を事前入力する場合など)は、フィールドの初期化時にアクションをトリガーする「When」ルールを記述することが推奨されます。

ルールエディターで使用可能な演算子の種類とイベント

ルールエディタ-では、次のような論理演算子やイベントを使用してルールを作成することができます。

  • Is Equal To(次と等しい)
  • Is Not Equal To(次と等しくない)
  • Starts With(次の値で始まる)
  • Ends With(次の値で終わる)
  • Contains(次を含む)
  • Is Empty(空である)
  • Is Not Empty(空ではない)
  • Has Selected(選択済み):チェックボックス、ドロップダウン、ラジオボタンの特定のオプションをユーザーが選択した場合に true を返します。
  • Is Initialized (event)(初期化(イベント型))フォームオブジェクトがブラウザでレンダリングされたときに true を返します。
  • Is Changed (event)(変更(イベント型)):フォームオブジェクトに入力された値または選択したオプションをユーザーが変更したときに true を返します。

ルールエディターで利用可能なルールタイプ

ルールエディターでは、ルールを記述するための、事前定義された一連のルールタイプを利用できます。ここからは、各ルールタイプについて詳しく説明します。ルールエディターでルールを記述する詳細については、「ルールの作成」を参照してください。

When

When」のルールタイプは、「条件=アクション=代替アクション」のルール構文に従います。また、単に「条件=アクション」構文が使用されることもあります。このルールタイプでは、評価条件を指定し、条件が満たされた(True)場合にトリガするアクションを記述します。「When」のルールタイプの使用中、複数の「AND」および「OR」演算子を使用してネスト式を作成することができます。

「When」のルールタイプを使用することで、フォームオブジェクトの状態を評価し、1つ以上のオブジェクトに対してアクションを実行することができます。 

代表的な「When」のルール構文は、次のようになります。

____________________________________________

When on Object A:

(条件1 AND 条件2 OR 条件3) is TRUE;

Then, do the following:

Action 2 on Object B;
AND
Action 3 on Object C;

 

_____________________________________________

状態を確認できるのは「When」ルールを指定したオブジェクトに限られますが、以下のアクションは複数のオブジェクトに対してトリガすることができます。 

  • Hide(非表示):指定したオブジェクトを非表示にします。
  • Show(表示):指定したオブジェクトを表示します。
  • Enable(有効):指定したオブジェクトを有効にします。
  • Disable(無効):指定したオブジェクトを無効にします。
  • Set value of(指定値):指定したオブジェの値を取得し、設定します。オブジェクト値には、文字列、他のオブジェクトの値、数式や関数により計算された値、またはオブジェクトのプロパティの値を指定することができます。
  • Invoke web service(Web サービス操作を呼び出す):Web サービス操作を呼び出します。Web サービスへの WSDL URL を指定する必要があります。その後、実行する操作を選択できるようになります。また、Webサービスをルールエディターのメニュー項目として利用できるよう、ルールエディターから Web サービスを事前設定することもできます。
  • Set property(プロパティを設定):指定したオブジェクトのプロパティ値を設定します。
  • Clear value of(値のクリア):指定したオブジェの値をクリアします。
  • Set Focus(フォーカス):指定したオブジェクトにフォーカスを置きます。
  • Save Form(フォームの保存):フォームを保存します。
  • Submit Forms(フォームの送信):フォームを送信します。
  • Reset Form(フォームのリセット):フォームをリセットします。
  • Validate Form(フォームの検証):フォームを検証します。
  • Add Instance(インスタンスの追加):指定した繰り返し可能なパネルまたはテーブル行のインスタンスを追加します。
  • Remove Instance(インスタンスの削除):指定した繰り返し可能なパネルまたはテーブル行のインスタンスを削除します。

Set value(指定値)

Set Value Of」のルールタイプを使用すると、指定した条件の条件に応じてフォームオブジェクトの値を設定することができます。値には、他のオブジェクトの値や、リテラル文字列、数式や関数から算出された値、または他のオブジェクトのプロパティ値を指定することができます。同様に、関数や数式から算出された構成要素、文字列、プロパティ、または値を確認することもできます。

「Set Value Of」のルールタイプは、パネルやツールバーボタンなどの一部のフォームオブジェクトでは利用できないことに注意してください。

標準的な「Set Value Of」ルールは、次の構文を有します。

____________________________________________

Set value of Object A to:

(オブジェクト B の値) OR
(ABC の文字列) OR
(オブジェクト C のオブジェクト プロパティ) OR
(関数からの値) OR
(数式表現からの値);

When:

(条件1 AND 条件2 AND 条件3) is TRUE;

____________________________________________

ドロップダウン、ラジオボタンおよびチェックボックスに事前入力された値

以下のフォームオブジェクトに向けてルールを記述する場合、フォームオブジェクトのオプションや値はルールエディタ上で事前入力します。

  • ドロップダウン
  • ラジオボタン
  • チェックボックス

Show(表示)

Show」のルールタイプでは、条件を満たしているかどうかに基づいて、フォームオブジェクトの表示・非表示を切り替えることができます。「Show」のルールタイプでは、条件が満たされていないか、あるいは False が返された場合に、「Show」アクションをトリガします。

代表的な「Show」のルール構文は、次のようになります。

____________________________________________

Show Object A;

When:

(条件1 OR 条件2 OR 条件3) is TRUE;

Else:

Hide Object A;

____________________________________________

Hide(非表示)

Hide」のルールタイプでは、「Show」のルールタイプと同様に、条件を満たしているかどうか基づいて、フォームオブジェクトの表示・非表示を切り替えることができます。「Hide」のルールタイプでは、条件が満たされていないか、あるいは False が返された場合に、「非表示」アクションをトリガします。

代表的な「Hide」のルール構文は、次のようになります。

____________________________________________

Hide Object A;

When:

(条件1 AND 条件2 AND 条件3) is TRUE;

Else:

Show Object A;

____________________________________________

Enable(有効)

Enable」のルールタイプを使用すると、条件を満たしているか否かに基づいて、フォームオブジェクトを有効または無効にすることができます。「Enable」のルールタイプでは、条件が満たされていないか、あるいは False が返された場合に、「Enable」アクションをトリガします。

代表的な「Enable」のルール構文は、次のようになります。

____________________________________________

Enable Object A;

When:

(条件1 AND 条件2 AND 条件3) is TRUE;

Else:

Disable Object A;

____________________________________________

Disable(無効)

Disable」のルールタイプでは、「Enable」のルールタイプと同様に、条件を満たしているか否かに基づいて、フォームオブジェクトを有効または無効にすることができます。「Disable」のルールタイプでは、条件が満たされていないか、あるいは False が返された場合に、「Disable」アクションをトリガします。

代表的な「Disable」のルール構文は、次のようになります。

____________________________________________

Disable Object A;

When:

(条件1 OR 条件2 OR 条件3) is TRUE;

Else:

Enable Object A;

____________________________________________

Validate

Validate」のルールタイプでは、式を使用してフィールド内の値を検証します。たとえば、式を記述することで、特定の名前のテキストボックスに特殊文字や数字が含まれていないことを確認することができます。

代表的な「Validate」のルール構文は、次のようになります。

____________________________________________

Validate Object A;

Using:

(式1 AND 式2 AND 式3) is TRUE;

____________________________________________

注意:

入力値が検証ツールと一致しない場合は、検証メッセージをユーザに対して表示させることができます。メッセージの内容は、サイドバー内のコンポーネントプロパティにある「スクリプト検証メッセージ」フィールドから指定できます。

script-validation

ルールエディタのユーザーインターフェイスを理解する

ルールエディタでは、ルールの記述や管理のための、総合的でシンプルなユーザインタフェースが用意されています。ルールエディターのユーザインターフェイスは、オーサリングモードで開いたアダプティブフォーム内から起動できます。

ルールエディターのユーザインターフェイスを起動するには:

  1. アダプティブフォームをオーサリングモードで開きます。

  2. ルールを記述するフォームオブジェクトをタップし、「コンポーネントツールバー」でをタップします。ルールエディタのユーザーインターフェイスが表示されます。

    create-rules

    選択したフォームオブジェクト上に既に存在するルールは、このビューに表示されます。既存ルールの詳細な管理方法については、「ルール管理」を参照してください。

  3. 作成」をタップして、新規ルールを追加します。ルールエディターの初回起動時は、ルールエディターの UI がビジュアルエディターモード(デフォルト)で表示されます。

    ルールエディターのユーザインターフェイス
    拡大画像を開くにはここをクリック

    ここからは、ルールエディターのユーザインターフェイスに含まれる各要素について説明します。

A. コンポーネントルールの表示

ルールエディターを起動したアダプティブフォームオブジェクトのタイトルと、現在選択されているルールタイプを表示します。上記の例では、ルールエディターは「Salary(給与) 」と名付けられたアダプティブフォームオブジェクトから起動されており、「When」のルールタイプが選択されています。

B. フォームオブジェクトと関数

ルールエディタのユーザーインターフェイスの左側のペインには、「フォームオブジェクト」と「関数」の2つのタブが含まれています。

「フォームオブジェクト」タブには、アダプティブフォームに含まれているオブジェクトがすべて階層表示されます。ここには、オブジェクトのタイトルとタイプが表示されます。ルールの作成時は、フォームオブジェクトをルールエディターまでドラッグ&ドロップすることができます。

1つ以上の有効なルールが適用されているフォームオブジェクトには、緑のドットが付いています。フォームオブジェクトに適用されているルールのいずれかが無効な場合、フォームオブジェクトには黄色のドットが付きます。

「関数」タブには、「合計」、「最小値」、「最大値」、「平均値」、「個数」や「検査フォーム」などの組み込み関数のセットが含まれます。これらの関数をルールに記述することで、繰り返しパネルやテーブル行の値を計算し、計算結果をアクションや条件文の中で使用することができます。また、カスタム関数を記述することもできます。

「関数」タブ

注意:

「フォームオブジェクト」と「関数」の各タブ内では、オブジェクトや関数の名前やタイトルを基にテキスト検索を行うことができます。

フォームオブジェクトの左側のツリーでは、フォームオブジェクトをタップすることで、各オブジェクトに適用されるルールを表示することができます。ここでは、各フォームオブジェクトのルール間を移動できるだけでなく、フォームオブジェクト間でルールをコピー&ペーストすることもできます。詳しくは、「ルールのコピー&ペースト」を参照してください。

C. フォームオブジェクトと関数の切り替え

トグルボタンをタップすると、フォームオブジェクトペインと関数ペインを切り替えることができます。

D. ルールのビジュアルエディター

ルールを記述するビジュアルエディターは、ルールエディターのユーザーインターフェイスをビジュアルエディタモードに切り替えると表示されます。ここでは、ルールの種類を選択し、それに応じて条件とアクションを定義することができます。ルール内の条件とアクションを定義するときは、「フォームオブジェクト」ペインや「関数」ペインから、フォームオブジェクトや関数をドラッグ&ドロップすることができます。

ルールのビジュアルエディターの詳細については、「ルールの作成」を参照してください。

E. ビジュアルコードエディターの切り替えボタン

ルールエディターの右上にある切り替えボタンを押すことで、ビジュアルエディターモードからルールエディター(またはその逆)に切り替えることができます。ルールエディターの初回起動時は、ビジュアルエディタモードで開きます。ルールを記述する際はビジュアルエディターモードに、ルールスクリプトを記述する際はコードエディタモードに切り替えて使用します。ただし、コードエディターからルールを変更や記述した場合は、コードエディタをクリアしない限り、同じルールをビジュアルエディターから表示することはできません。

AEM Forms では、ルールを記述するために最後に使用したルールエディタモードを記憶します。これにより、ルールエディタの次回起動時も同じモードで開きます。ただし、デフォルトモードを設定することで、ルールエディタを指定されたモードで開くこともできます。更新するには、次の手順を実行します。

  1. AEM Web コンソール(http://[host]:[port]/system/console/configMgr)を開きます。
  2. アダプティブフォーム設定サービス」をクリックして設定します。
  3. ルールエディターのデフォルトモード」のドロップダウンから、「ビジュアルエディター」または「コードエディター」を選択します。
  4. 保存」をクリックします。

F. 「完了」ボタンと「キャンセル」ボタン

ルールを保存するには、「完了」ボタンを押します。ルールは、不完全な状態でも保存することができます。ただし、不完全なルールは無効なため、実行されることはありません。フォームオブジェクトに対して保存されたルールは、次回に同じフォームオブジェクトからルールエディターを起動すると一覧表示されます。このビューでは、既存のルールを管理することができます。詳しくは、「ルール管理」を参照してください。

キャンセル」ボタンを押すと、ルールに加えた変更を破棄し、ルールエディターを閉じます。

ルールの記述

ルールを記述するには、ビジュアルルールエディターまたはコードエディターを使用します。ルールエディターの初回起動時は、ビジュアルエディタモードで開きます。その後は、コードエディターモードに切り替えてルールを記述することもできます。ただし、コードエディターからルールを変更や記述した場合は、コードエディターをクリアしない限り、同じルールをビジュアルエディターから表示することはできません。これにより、ルールエディターの次回起動時も、前回ルールの作成に使用したのと同じモードで開きます。

最初に、ビジュアルエディターを使用してルールを作成する方法を説明します。

ビジュアルエディターを使用する

ここでは、次のフォーム例と共に、ビジュアルエディターでルールを作成する方法について説明します。

create-rule-example

フォーム例のローン申込書における「Loan Requirements(融資要件)」のセクションでは、配偶者の有無や自身の給与(および既婚者の場合は配偶者の給与)を入力することが要求されます。ルールでは、ユーザー入力に基づいて融資適格金額を算出し、「Loan Eligibility(融資適格額)」フィールドに表示します。次のルールを適用して、シナリオを実装します。

  • 配偶者の「Salary(給与)」フィールドは、婚姻状況に結婚を選んだ場合にのみ表示されます。
  • 融資適格額は、全給与の50パーセントとして計算されます。
ルールを記述する際は、以下の手順を実行します。
  1. まず、「Marital Status(婚姻状況)」のラジオボタンの選択内容に応じて「Spouse Salary(配偶者の給与)」フィールドの表示・非表示を制御するためのルールを記述します。 

    融資申請フォームをオーサリングモードで開きます。「Marital Status(婚姻状況)」コンポーネントをタップし、 をタップします。次に、ルールエディターを起動し「作成」をタップします。

    write-rules-visual-editor-1

    ルールエディターの起動時は、デフォルトで「When」ルールが選択されています。また、ルールエディターを起動したフォームオブジェクト(この場合は「Marital Status(婚姻状況)」)は、「When」文に入力されています。

    選択したオブジェクトを変更することはできませんが、ルールのドロップダウンを使用することで別のルールタイプを選択することはできます(以下を参照)。別のオブジェクトに新しいルールを作成する場合は、「キャンセル」をタップしてルールエディターを終了し、そのオブジェクトから再びルールエディターを起動します。

  2. 状態の選択」のドロップダウンをタップし、「is equal to(等しい)」を選択します。「文字列を入力」フィールドが表示されます。

    write-rules-visual-editor-2

    「Marital Status(婚姻状況)」のラジオボタンでは、「Married(既婚)」と「Single(独身)」のオプションに対して、それぞれ 01 の値が割り当てられています。以下に示すように、割り当てられた値は、「編集」ラジオボタンダイアログの「タイトル」タブから確認することができます。

    ルールエディターから割り当てたラジオボタンの値
  3. ルール内の「文字列を入力」フィールドで、0 を指定します。

    write-rules-visual-editor-4

    ここでは、「When Marital Status is equal to Married(婚姻状況が「既婚」の場合)」を条件に指定しています。 次に、この条件が True の場合に実行するアクションを定義します。

  4. その後の文では、「アクションの選択」ドロップダウンから「表示」を選択します。

    write-rules-visual-editor-5
  5. オブジェクトをドロップするか、または次から選択」フィールドの「フォームオブジェクト」タブから「Spouse Salary(配偶者の給与)」フィールドをドラッグ・ドロップします。あるいは、「オブジェクトをドロップするか、または次から選択」フィールドをタップし、ポップアップメニューから「Spouse Salary(配偶者の給与)」フィールドを選択します。この中には、フォーム内のすべてのフォームオブジェクトが一覧表示されます。

    write-rules-visual-editor-6

    ルールエディターでは、ルールが次のように表示されます。

    write-rules-visual-editor-7

    完了」をクリックして、ルールを保存します。

  6. 婚姻状況が「Single(独身)」の場合は「Spouse Salary(配偶者の給与)」フィールドを非表示にするため、手順1~5を繰り返して別のルールを定義します。ルールエディターでは、ルールが次のように表示されます。

    write-rules-visual-editor-8

    注意:

    また、同じ動作を実装する場合は、「Marital Status(婚姻状況)」フィールドに2つの「いつ」ルールを記述する代わりに、「Spouse Salary(配偶者の給与)」フィールド上に1つの「表示」ルールを設けることもできます。

    write-rules-visual-editor-9
  7. 次に、融資適格金額を算出するためのルールを記述します。ここでは、総給与の50パーセントとして計算され、「Loan Eligibility(貸付資格)」フィールドに表示されます。これをするには、「Loan Eligibility」フィールド上に「指定値」ルールを作成します。

    オーサリングモードで「Loan Eligibility」フィールドをタップし、 をタップします。次に「作成」をタップし、ルールエディターを起動します。

  8. ルールのドロップダウンから「指定値」ルールを選択します。

    write-rules-visual-editor-10
  9. オプションの選択」をタップして「数式」を選択します。数式記述用のフィールドが表示されます。

    write-rules-visual-editor-11
  10. 数式記述用のフィールドでは:

    • 「フォームオブジェクト」タブで、最初の「オブジェクトをドロップするか、または次から選択」フィールドから「Salary(給与)」フィールドを選択するか、またはドラッグ&ドロップします。
    • 演算子の選択」フィールドから「プラス」を選択します。
    • 「フォームオブジェクト」タブの「オブジェクトをドロップするか、または次から選択」フィールドから「Spouse Salary(配偶者の給与)」フィールドを選択するか、またはドラッグ&ドロップします。
    write-rules-visual-editor-12
  11. 次に、式フィールドの周りの強調表示された領域をタップし、「拡張式」をタップします。

    write-rules-visual-editor-13

    拡張式フィールドでは、「演算子の選択」フィールドから「divided by(割り算)」を選択し、「オプションの選択」フィールドから「Number(数字)」を選択します。次に、数字フィールドに 2 を入力します。

    write-rules-visual-editor-14

    注意:

    「オプションの選択」フィールドから、コンポーネント、関数、数式、およびプロパティの各値を使用することで、複雑な式を作成することもできます。

    次に、True が返された場合に式を実行する条件を作成します。

  12. 「条件の追加」をタップして、「When」文を追加します。

    write-rules-visual-editor-15

    「When」文内で:

    • 「フォームオブジェクト」タブで、最初の「オブジェクトをドロップするか、または次から選択」フィールドから「Marital Status(婚姻状況)」フィールドを選択します。
    • 演算子の選択」フィールドから「is equal to」を選択します。
    • 他の「オブジェクトをドロップまたは次から選択」フィールドから「文字列」を選択し、「文字列を入力」フィールドに「Married(既婚)」を入力します。
    ルールは、ルールエディターで最終的には次のように表示されます。
    write-rules-visual-editor-16

    完了」をクリックして、ルールを保存します。

  13. ステップ 7~12 を繰り返し、婚姻状況が「Single(独身)」であれば融資適格額を計算する別のルールを定義します。ルールエディターでは、ルールが次のように表示されます。

    write-rules-visual-editor-17

注意:

代わりに、「When」ルール内で融資適格性を計算するために「Set Value Of」文を使用することもできます。このルールは、「Spouse Salary(配偶者の給与)」フィールドの表示・非表示を切り替えるために作成したものです。「Marital Status(婚姻状況)」が「Single(独身)」の場合、ルールエディターでは組み合わせルールが次のように表示されます。

同様に、「Spouse Salary(配偶者の給与)」フィールドの表示・非表示を切り替えるための別の組み合わせルールを記述することで、「Marital Status(婚姻状況)」が「Married(既婚)」の場合にも融資適格性を計算することができます。

write-rules-visual-editor-18

コードエディターを使用する

ルールエディターでは、ビジュアルエディターを使用して作成したルールの JavaScript コードを自動的に生成します。生成されたコードを表示するには、ビジュアルエディターからコードエディターに切り替えます。ただし、コードエディターでルールコードを変更した場合、ビジュアルエディターに戻すことはできません。ビジュアルエディターではなく、コードエディターでルールを記述することを希望する場合は、コードエディターで新たにルールを記述することもできます。これら2つのモードは、ビジュアルコードエディターの切り替えボタンから切り替えることができます。

アダプティブフォームのコードエディターで使用される式言語は Javascript です。すべての数式は有効なJavaScriptの数式で、アダプティブフォームのスクリプトモデルAPIを使用しています。これらの数式は、特定のタイプの値を返します。アダプティブフォームクラス、イベント、オブジェクトおよびパブリック API の完全なリストについては、「Javascriptライブラリアダプティブフォームの API リファレンス」をご覧ください。

コードエディターでルールを記述する際の詳細なガイドラインは、「アダプティブフォーム上の式」を参照してください。

ルールエディターでのカスタム関数

「関数出力」の下にリストされている「合計」のような既存の関数に加え、頻繁に使用するカスタム関数を記述することもできます。記述した関数は、その上に jsdoc が付記されていることを確認してください。

この jsdoc は、

  • カスタムの設定や説明を使用する場合に必須です。
  • JavaScriptでは関数を宣言する方法が複数存在するため、コメントを活用して関数を区別することが大切です。

詳しくは、usejsdoc.org を参照してください。

サポートされている jsdoc タグ:

  • Private
    Syntax(プライベート構文):@private
    プライベート関数は、カスタム関数に含まれてはいません。
  • Name
    Syntax(名前構文):@name funcName <関数名>
    または、@function funcName <関数名> ないし @func funcName <関数名> を使用できます。
    funcName:関数の名前です(スペースは使用不可)。
    <関数名>:関数の表示名です。
  • Member
    Syntax(メンバー構文):@memberof namespace
    関数に名前空間を追加します。
  • Parameter
    Syntax(パラメータ構文):@param {type} name <パラメータの説明>
    または、@argument {type} name <パラメータの説明> ないし @arg {type} name <パラメータの説明>を使用することができます。
    関数で使用されるパラメータを表示します。関数には、複数のパラメータタグを設けることができます。各パラメーターは、実行順序に応じて 1 個のタグを設けることができます。
    {type}は、パラメータータイプを表します。許可されているパラメータータイプは、以下のとおりです。
    1. string
    2. number
    3. boolean

    他のすべてのパラメータの種類は、上記のいずれかに分類されます。「なし」はサポートされていません。上記のタイプのいずれかを選択していることを確認してください。タイプでは、大文字と小文字は区別されません。パラメータでは、スペースは使用できません。<パラメータ説明>複数の単語を含めることができます。

  • Return Type
    Syntax(戻り値のタイプの構文):@return {type}
    または、@returns {type} を使用することもできます。
    目的などの、関数に関する情報を追加します。 
    {type} は、関数の戻り値の型を指定します。許可されている戻り値のタイプは次のとおりです。
    1. string
    2. number
    3. boolean

    他のすべての戻り値の型は、上記のいずれかに分類されます。「なし」はサポートされていません。上記のタイプのいずれかを選択していることを確認してください。戻り値の型では、大文字と小文字は区別されません。

注意:

カスタム関数の前に記述するコメントには、概要を含めることができます。概要は複数の行に拡張することができます。終端にはタグを使用します。説明を簡潔にするため、ルールビルダーでは1行以内に抑えるように心がけてください。

カスタム関数を追加する

たとえば、正方形の面積を計算するカスタム関数を追加するとします。横の長さは、ユーザの入力を使用します。ユーザ入力は、フォーム内の数値ボックスを通して受け取ります。計算された出力は、フォーム内の別の数値ボックスに表示されます。カスタム機能を追加するには、最初にクライアントライブラリを作成し、次に CRX リポジトリに追加する必要があります。

次の手順を実行してクライアントライブラリを作成し、それを CRX リポジトリに追加します。 

  1. クライアントライブラリを作成します。詳しくは、「クライアント側ライブラリの使用」を参照してください。

  2. CRXDE 上で、文字列型の値「customfunction」と共に「categories」プロパティを clientlib フォルダに追加します。

    注意:

    customfunction」は、カテゴリの一例です。clientlib フォルダで作成したカテゴリには、任意の名前を付けることができます。

CRXリポジトリにクライアントライブラリを追加した後は、アダプティブフォームでそれを使用します。これにより、カスタム関数をルールとしてフォーム内で使用することができます。次の手順を実行して、アダプティブフォームにクライアントライブラリを追加します。 

  1. フォームを編集モードで開きます。
    フォームを編集モードで開くには、フォームを選択し、「開く」をタップします。

  2. 編集モードでコンポーネントを選択し、「」/「アダプティブフォームコンテナ」をタップしてから をタップします。

  3. サイドバーの「クライアントライブラリの名前」の下から、クライアントライブラリを追加します。(この例では、「customfunction」)。

    カスタム関数をクライアントライブラリを追加する
  4. 入力数値ボックスを選択し、 をタップしてルールエディターを開きます。

  5. ルールの作成」をタップします。フォームの出力フィールドに入力の二乗値を表示するルールを、次のオプションを使用して作成します。

    完了」をタップします。これでカスタム機能が追加されました。

関数の宣言でサポートされる型

文関数

function area(len) {
    return len*len;
}

この関数は、jsdoc コメント無しで追加されています。

関数表現

var area;
//Some codes later
/** */
area = function(len) {
    return len*len;
};

関数表現と文関数

var b={};
/** */
b.area = function(len) {
    return len*len;
}

変数の関数宣言

/** */
var x1,
    area = function(len) {
        return len*len;
    },
    x2 =5, x3 =true;

制限:関数宣言をリストにまとめた場合、カスタム関数では、変数リストから最初の関数宣言のみが選択されます。関数表現は、すべての関数宣言に使用することができます。

オブジェクトの関数宣言

var c = {
    b : {
        /** */
        area : function(len) {
            return len*len;
        }
    }
};

注意:

カスタム関数では、必ずjsdoc を使用てください。jsdoc 型のコメントが奨励されていますが、カスタム関数としての機能を区別できるよう、空の jsdoc 型コメントを含めてください。これにより、カスタム関数のデフォルト処理が可能になります。

ルール管理

フォームオブジェクトをタップし、続けて をタップすると、オブジェクト上に既存のルールが一覧表示されます。ここでは、タイトルを表示し、ルール概要をプレビュー表示することができます。また、UI からルール概要を拡大して全体を表示したり、ルール順序を変更したり、ルールを編集・削除したりすることもできます。

list-rules

ルールに対しては、以下の操作を実行できます。

  • ルールリスト内の「コンテンツ」の列には、ルールの内容が表示されます。デフォルトビューにルール内容の全体が表示されていない場合は、 をタップしてビューを展開します。
  • 作成した新しいルールは、すべてルールリストの一番下に追加されます。ルールは上から下に順に実行されます。一番上のルールが最初に実行され、続けて同じタイプの他のルールが実行されます。たとえば、「When」、「Show」、「Enable」、および「When」の各ルールが、リストの1~4番目にある場合、一番上にある「When」ルールが最初に実行され、次に4番目の「When」ルールが実行されます。そして、「Show」ルールおよび「Enable」ルールが実行されます。
    ルールの順序を変更するには、対象の をタップするか、リスト内の所望の位置にドラッグ&ドロップします。
  • ルールを編集するには、ルールタイトルの横にあるチェックボックスを選択します。ルールを編集・削除するための追加オプションが表示されます。「編集」をタップし、選択したルールをルールエディターで開きます。ルールエディターは、以前にルールを作成する際に使用したモードに応じて、ビジュアルエディターモードまたはコードエディターモードで開きます。
  • ルールを削除するには、ルールを選択し「削除」をタップします。

ルールのコピー&ペースト

時間を節約するために、フィールドのルールを別の類似したフィールドにコピー&ペーストすることができます。

ルールをコピー&ペーストするには、次の手順を実行します。

  1. ルールをコピーするフォームオブジェクトをタップし、コンポーネントツールバーから をタップします。フォームオブジェクトが選択された状態でルールエディターのユーザーインタフェースが表示され、既存のルールが表示されます。

    CopyRule

    既存ルールの詳細な管理方法については、「ルール管理」を参照してください。

  2. ルールタイトルの横にあるチェックボックスを選択します。ルールを管理するための追加オプションが表示されます。「コピー」をタップします。

    CopyRule2
  3. ルールを貼り付ける別のフォームオブジェクトを選択し、「貼り付け」をタップします。また、貼り付けたルールは編集して変更を加えることもできます。

    注意:

    別のフォームオブジェクトにルールを貼り付けることができるのは、コピーされたルールのイベントを、貼り付け先のフォームオブジェクトがサポートしている場合に限られます。たとえば、ボタンはクリックイベントをサポートします。ボタンのクリックイベントにはルールを貼り付けることができますが、チェックボックスには貼り付けできません。

  4. 完了」をクリックして、ルールを保存します。

ネスト式

ルールエディターでは、複数の「AND」と「OR」演算子を使用して、ネストしたルールを作成することができます。ルール内には、複数の「AND」と「OR」演算子を混在させることもできます。 

以下の例では、ネストされたルールを紹介します。ここでは、必要な条件が満たされた際に、子供の親権適格性についてのメッセージをユーザーに表示します。

ComplexExpression

ルール内で条件をドラッグアンドドロップして編集することもできます。条件の前のハンドル()をタップし続けます。次に示すようにカーソルが手の形になったら、ルール内の任意の場所に条件をドラッグアンドドロップします。ルール構造が変化します。

drag-and-drop

日付式の条件

ルールエディターでは、日付比較を使用して条件を作成できます。 

次に示す条件の例では、ユーザーが日付フィールドに入力することによって指定する家屋の住宅ローンが既に取得されている場合、静的テキストオブジェクトを表示します。 

ユーザーが入力した物件の住宅ローンの日付が過去のものである場合、アダプティブフォームは収入計算に関する注記を表示します。次のルールは、ユーザーが入力した日付を現在の日付と比較し、ユーザーが入力した日付が現在の日付より前の場合、フォームは(Income という名前の)テキストメッセージを表示します。

DateExpressionCondition

入力された日付が現在の日付よりも前の場合、フォームはテキストメッセージ(Income)を次のように表示します。

DateExpressionConditionMet

数値比較条件

ルールエディターでは、2 つの数値を比較する条件を作成できます。 

次に示す条件の例では、申込者が現在の住所に住んでいる月数が 36 に満たない場合、静的テキストオブジェクトを表示します。 

NumberComparisonCondition

現在の居住地住所に住んでいる期間が 36 か月に満たないことをユーザーが指定した場合、フォームは、追加の居住地証明が要求される場合があるという通知を表示します。 

AdditionalProofRequested

既存のスクリプトに対するルールエディタの影響

AEM 6.1 Forms 機能パック 1 より前のバージョンの AEM Forms では、フォームの作成者や開発者がダイナミック動作をアダプティブフォームに追加する際に、「編集」コンポーネントダイアログの「スクリプト」タブを使用して式を記述していました。現行バージョンでは、「スクリプト」タブの代わりにルールエディターが導入されています。

「スクリプト」タブで記述する必要があったスクリプトや式は、ルールエディターからすべて利用できます。ビジュアルエディターでは表示や編集ができませんが、コードエディターからは編集も可能です。 

ルールの例

「When」ルールを使用して複数のアクションをトリガする

ローン申込フォームでは、ローンの申請者が既存の顧客であるかどうかを判断する必要があります。この情報に基づいて、顧客 ID フィールドの表示・非表示を切り替えます。また、申請者が既存の顧客であれば、顧客 ID フィールドにフォーカスを置きます。ローン申込フォームは、次のコンポーネントから構成されます。

  • Are you an existing Geometrixx customer?(Geometrixxに既に登録されていますか?)」のラジオボタンでは、「はい」と「いいえ」のオプションが設けられています。「はい」の値は 0、「いいえ」の値は 1 です。
  • Geometrixx customer ID(Geometrixx 顧客 ID)」のテキストフィールドには、顧客 ID が入力されます。
この動作を実装するためラジオボタンに「When」ルールを記述すると、ビジュアルルールエディターにはルールが次のように表示されます。
when-rule-example
ビジュアルエディターに表示されたルール

上のルール例では、「When」セクション内の文は条件に当たります。これが True を返すと、「Then」セクションで指定されたアクションが実行されます。

コードエディターでは、ルールが次のように表示されます。

when-rule-example-code
コードエディターに表示されたルール

ルール内で関数出力を使用する

発注フォームでは、次の表が表示されます。この中には、発注者が注文を入力します。表の内容:

  • 最初の行は反復可能です。このため、ユーザーは複数の製品を注文し、それぞれ異なる量を指定することができます。このエレメントの名前は、「Row1」です。
  • 反復可能な行と「Product Quantity(製品数量)」の列が重なるセルでは、タイトルが「Quantity(数量)」になっています。このセルのエレメント名は「productquantity」です。
  • 表の2行目は反復しません。また、この行と「Product Quantity(製品数量)」の列が重なるセルでは、タイトルが「Total Quantity(合計数量)」になっています。
example-function-table
A. Row1 B. Quantity(数量) C. Total Quantity(合計数量) 

ここでは、「Product Quantity(製品数量)」列で指定された数量を全製品について合計し、「Total Quantity(合計数量)」セルに合計値を表示する必要があります。この動作は、以下に示すように、「Total Quantity(合計数量)」セルに「Set Value Of」ルールを記述することにより実装できます。

example-function-output
ビジュアルエディターに表示されたルール

コードエディターでは、ルールが次のように表示されます。

example-function-output-code
コードエディターに表示されたルール

式を使用してフィールド値を検証する

上の例で説明した発注書フォームでは、価格が 10000 を超える商品について、1 個を超える数量は発注が制限されています。この動作を実装するには、以下に示すように「Validate」ルールを記述します。 

example-validate
ビジュアルエディターに表示されたルール

コードエディターでは、ルールが次のように表示されます。

example-validate-code
コードエディターに表示されたルール

本作品は Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License によってライセンス許可を受けています。  Twitter™ および Facebook の投稿には、Creative Commons の規約内容は適用されません。

法律上の注意   |   プライバシーポリシー