アダプティブフォームのルールエディター adaptive-forms-rule-editor

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：

作成対象：

ユーザー
開発者

アダプティブフォームの新規作成または AEM Sites ページへのアダプティブフォームの追加には、最新の拡張可能なデータキャプチャコアコンポーネントを使用することをお勧めします。これらのコンポーネントは、アダプティブフォームの作成における大幅な進歩を表し、ユーザーエクスペリエンスの向上を実現します。この記事では、基盤コンポーネントを使用してアダプティブフォームを作成する古い方法について説明します。

バージョン

記事リンク

AEM as a Cloud Service

ここをクリックしてください

AEM 6.5

この記事

概要 overview

Adobe Experience Manager Forms のルール編集機能により、フォームのビジネスユーザーや開発者がアダプティブフォームオブジェクトでルールを記述できるようになります。これらのルールは、フォームオブジェクト上でトリガーできるアクションを定義します。それらのアクションは、プリセットされた条件、ユーザー入力、およびフォーム上のユーザーアクションに基づいてトリガーされます。これにより、フォームへの入力を正確かつ迅速に行うことができます。

ルールエディターでは、ルールを記述するための直感的でシンプルなユーザーインターフェイスを備えています。ルールエディターは、すべてのユーザーに対してビジュアルエディターを提供します。またルールエディターは、Forms のパワーユーザーに対してのみ、ルールとスクリプトを記述するためのコードエディターを提供します。

ルールエディタは、AEM 6.1 Forms 以前のリリースにおけるスクリプト作成機能を置き換えるものです。ただし、既存のスクリプトは、新しいルールエディターで保持されます。ルールエディターでの既存のスクリプトの操作について詳しくは、既存のスクリプトに対するルールエディターの影響を参照してください。

forms-power-users グループに追加されたユーザーは、新しいスクリプトの作成と既存のスクリプトの編集を行うことができます。forms-users グループのユーザーは、スクリプトを使用できますが、スクリプトの作成や編集はできません。

ルールを理解する understanding-a-rule

ルールとは、アクションと条件を組み合わせたものです。ルールエディターでは、アクションには、フォーム内のオブジェクトの値を非表示、表示、有効化、無効化、または計算するなどのアクティビティが含まれます。「条件」とは、フォームオブジェクトの状態、値、またはプロパティに対して確認や操作を実行し、それによって評価されるブール式を指します。「アクション」は、条件を評価して返された値（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」（それらの逆も同様）です。デフォルトの代替アクションは変更できません。

NOTE

利用可能なルールタイプ（ルールエディターで定義した条件やアクションを含む）は、ルールを作成しているフォームオブジェクトの種類によっても異なります。ルールエディターには、特定のフォームオブジェクトタイプに対して条件およびアクションステートメントを記述するための、有効なルールタイプとオプションのみが表示されます。例えば、パネルオブジェクトでは、「Validate」、「Set Value Of」、「Enable」や「Disable」の各ルールは表示されません。

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

ルール構文の選択ガイドライン guidelines-for-choosing-a-rule-construct

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

ルールを作成する際は一般に、ルールを作成するオブジェクトのコンテキストでルールを考えることです。「フィールド 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」ルールを記述することが推奨されます。
ドロップダウン、ラジオボタン、チェックボックスの各オブジェクトに対してルールを記述する場合、フォーム内のこれらのフォームオブジェクトのオプションや値は、ルールエディターで事前入力されます。

ルールエディターで使用可能な演算子の種類とイベント available-operator-types-and-events-in-rule-editor

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

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 を返します。

ルールエディターで利用可能なルールタイプ available-rule-types-in-rule-editor

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

When whenruletype

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

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

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

When on Object A:

(Condition 1 AND Condition 2 OR Condition 3) is TRUE;

Then, do the following:

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

ラジオボタンやリストなどの複数値コンポーネントに対してルールを作成する場合、オプションが自動的に取得され、それらのオプションを使用してルールを作成できるようになりました。これらのオプションの値を再入力する必要はありません。

例えばリストの場合、赤、青、緑、黄という 4 つのオプションがあります。ルールを作成する場合、オプション（ラジオボタン）が自動的に取得され、これらのオプションを使用してルールを作成できます。以下に例を示します。

multivaluefcdisplaysoptions

「When」ルールを記述するときに、「Clear Value Of」アクションをトリガーできます。「Clear Value Of」アクションは、指定したオブジェクトの値をクリアします。When ステートメントに「Clear Value Of」をオプションとして含めると、複数フィールドで複雑な条件を作成できます。

clearvalue

Hide （非表示）：指定したオブジェクトを非表示にします。

Show （表示）：指定したオブジェクトを表示します。

Enable （有効）：指定したオブジェクトを有効にします。

Disable （無効）：指定したオブジェクトを無効にします。

Invoke service （サービスを起動） フォームデータモデルで設定されたサービスを起動します。「サービスを起動」オプションを選択すると、フィールドが表示されます。このフィールドをタップすると、AEM インスタンス上のすべてのフォームデータモデルで設定されたすべてのサービスが表示されます。フォームデータモデルサービスを選択すると、追加のフィールドが表示されます。このフィールドで、フォームオブジェクトと、指定したサービスの入出力パラメーターをマッピングすることができます。フォームデータモデルサービスの呼び出しについては、ルール例を参照してください。

フォームデータモデルサービスに加えて、ダイレクト WSDL URL を指定して web サービスを起動することができます。ただし、フォームデータモデルサービスには数多くの利点があるので、この方法でサービスを呼び出すことをお勧めします。

フォームデータモデルでのサービス設定について詳しくは、AEM Forms のデータ統合機能を参照してください。

「次の値を設定」は、指定したオブジェクトの値を計算して設定します。オブジェクト値には、文字列、別のオブジェクトの値、数式や関数を使用して計算した値、オブジェクトのプロパティの値、または設定されたフォームデータモデルサービスからの出力値を設定することができます。Web サービスオプションを選択すると、AEM インスタンス上のすべてのフォームデータモデルで設定されたすべてのサービスが表示されます。フォームデータモデルサービスを選択すると、追加のフィールドが表示されます。このフィールドで、フォームオブジェクトと、指定したサービスの入出力パラメーターをマッピングすることができます。

フォームデータモデルでのサービス設定について詳しくは、AEM Forms のデータ統合機能を参照してください。

プロパティを設定 のルールタイプを使用すると、条件アクションに基づいて、指定したオブジェクトのプロパティの値を設定できます。プロパティは、次のいずれかに設定できます。

visible（ブーリアン）
dorExclusion（ブーリアン）
chartType（文字列）
title（文字列）
enabled（ブーリアン）
mandatory（ブーリアン）
validationsDisabled（ブーリアン）
validateExpMessage（文字列）
Value（数値、文字列、日付）
items（リスト）
valid（ブーリアン）
errorMessage（文字列）

これにより、ルールを定義して、アダプティブフォームにチェックボックスを動的に追加することができます。カスタム関数、フォームオブジェクト、またはオブジェクトプロパティを使用して、ルールを定義できます。

プロパティを設定

カスタム関数に基づいてルールを定義するには、ドロップダウンリストから「関数の出力」を選択し、「関数」タブからカスタム関数をドラッグアンドドロップします。条件アクションが満たされると、カスタム関数で定義されているチェックボックスの数がアダプティブフォームに追加されます。

フォームオブジェクトに基づいてルールを定義するには、ドロップダウンリストから「フォームオブジェクト」を選択し、「フォームオブジェクト」タブからフォームオブジェクトをドラッグ＆ドロップします。条件アクションが満たされると、フォームオブジェクトで定義されているチェックボックスの数がアダプティブフォームに追加されます。

オブジェクトプロパティに基づくプロパティの設定ルールを使用すると、アダプティブフォームに含まれる別のオブジェクトプロパティに基づいて、アダプティブフォーム内のチェックボックスの数を追加できます。

次の図は、アダプティブフォーム内のドロップダウンリスト数に基づいて、チェックボックスを動的に追加する例を示しています。

オブジェクトプロパティ

Clear value of （値のクリア）：指定したオブジェの値をクリアします。

Set Focus （フォーカスの設定）：指定したオブジェクトにフォーカスを設定します。

Save Form （フォームの保存）：フォームを保存します。

Submit Forms （フォームの送信）：フォームを送信します。

Reset Form （フォームのリセット）：フォームをリセットします。

Validate Form （フォームの検証）：フォームを検証します。

Add Instance （インスタンスの追加）：指定した繰り返し可能なパネルまたは表の行のインスタンスを追加します。

Remove Instance （インスタンスの削除）：指定した繰り返し可能なパネルまたは表の行のインスタンスを削除します。

「移動先」は、他のインタラクティブ通信、他のアダプティブフォーム、画像やドキュメントフラグメントなどの他のアセット、または外部 URL に移動します。詳しくは、インタラクティブ通信にボタンを追加するを参照してください。

次の値を設定 set-value-of

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

「Set Value Of」のルールタイプは、パネルやツールバーボタンなどのすべてのフォームオブジェクトで使用できるわけではありません。標準的な「Set Value Of」ルールは、次の構文を有します。

Set value of Object A to:

（文字列 ABC） OR
（オブジェクト C のオブジェクトプロパティ X） OR
（関数からの値） OR
（数式表現からの値） OR
（データモデルサービスまたは Web サービスの出力値）;

When （オプション）：

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

次の例では、dependentid フィールドの値を入力とし、Relation フィールドの値を getDependent フォームデータモデルサービスの Relation 引数の出力に設定します。

set-value-web-service

フォームデータモデルサービスを使用した「Set Value Of」ルールの例

NOTE

さらに、「Set Value Of」ルールを使用して、フォームデータモデルサービスまたは web サービスの出力からドロップダウンリストのコンポーネントのすべての値を計算できます。ただし、選択する出力引数が配列型であることを確認してください。配列に返されたすべての値は、指定したドロップダウンリストで使用できるようになります。

Show（表示） show

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

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

Show Object A;

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

Else:

Hide Object A;

Hide（非表示） hide

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

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

Hide Object A;

When:

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

Else:

Show Object A;

Enable（有効） enable

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

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

Enable Object A;

When:

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

Else:

Disable Object A;

Disable（無効） disable

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

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

Disable Object A;

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

Else:

Enable Object A;

Validate（検証） validate

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

代表的な「検証」ルールは、次のようになります。

Validate Object A;

Using:

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

NOTE

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

スクリプトの検証

オプションを設定 setoptionsof

「次のオプションを設定」ルールタイプを使用すると、アダプティブフォームにチェックボックスを動的に追加するルールを定義できます。フォームデータモデルまたはカスタム関数を使用して、ルールを定義できます。

カスタム関数に基づいてルールを定義するには、ドロップダウンリストから「関数の出力」を選択し、「関数」タブからカスタム関数をドラッグ＆ドロップします。カスタム関数で定義されているチェックボックスの数が、アダプティブフォームに追加されます。

カスタム関数

カスタム関数を作成するには、「ルールエディターのカスタム関数」を参照してください。

フォームデータモデルに基づいてルールを定義するには：

ドロップダウンリストから「サービス出力」を選択します。
データモデルオブジェクトを選択します。
「値を表示」ドロップダウンリストからデータモデルオブジェクトプロパティを選択します。アダプティブフォーム内のチェックボックスの数は、データベース内のそのプロパティに対して定義されたインスタンスの数から得られます。
「値を保存」ドロップダウンリストからデータモデルオブジェクトプロパティを選択します。

FDM 設定オプション

ルールエディターのユーザーインターフェイスを理解する understanding-the-rule-editor-user-interface

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

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

アダプティブフォームをオーサリングモードで開きます。
ルールを記述するフォームオブジェクトを選択し、コンポーネントツールバーで「」を選択します。ルールエディターのユーザーインターフェイスが表示されます。

選択したフォームオブジェクトの既存のルールが、このビューに一覧表示されます。既存ルールの詳細な管理方法については、ルール管理を参照してください。
「作成」を選択して、新しいルールを記述します。ルールエディターの初回起動時は、ルールエディターの UI がビジュアルエディターモード（デフォルト）で表示されます。

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

A. コンポーネントルールの表示 a-component-rule-display

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

B. フォームオブジェクトと関数 b-form-objects-and-functions-br

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

「フォームオブジェクト」タブには、アダプティブフォームに含まれているオブジェクトがすべて階層表示されます。ここには、オブジェクトのタイトルとタイプが表示されます。ルールの作成時は、フォームオブジェクトをルールエディターまでドラッグ＆ドロップすることができます。オブジェクトまたは関数をプレースホルダーにドラッグ＆ドロップしてルールの作成や編集を行うと、適切な値の型がプレースホルダーに自動的に取り込まれるます。

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

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

関数タブ

NOTE

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

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

C. フォームオブジェクトと関数の切り替え c-form-objects-and-functions-toggle-br

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

D. ルールのビジュアルエディター d-visual-rule-editor

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

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

E. ビジュアルコードエディターの切り替えボタン e-visual-code-editors-switcher

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

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

AEM web コンソール（https://[host]:[port]/system/console/configMgr）にアクセスします。
アダプティブフォームとインタラクティブ通信の Web チャネル設定 をクリックして編集します。
ルールエディターのデフォルトモード ドロップダウンから、「ビジュアルエディター」または「コードエディター」を選択します。
「保存」をクリックします。

F. 「完了」ボタンと「キャンセル」ボタン f-done-and-cancel-buttons

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

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

ルールを記述 write-rules

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

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

ビジュアルエディターの使用 using-visual-editor

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

Create-rule-example

ローン申し込みフォームの例の「Loan Requirements（融資要件）」セクションでは、配偶者の有無、給与、および配偶者の給与（既婚の場合）を申請者が指定する必要があります。ユーザー入力に基づいて、ルールはローン適格額を計算し、「Loan Eligibility（貸付資格）」フィールドに表示します。次のルールを適用して、シナリオを実装します。

配偶者の「Salary（給与）」フィールドは、婚姻状況に「Married（既婚）」を選んだ場合にのみ表示されます。
融資適格額は、全給与の 50 パーセントとして計算されます。

ルールを記述する際は、以下の手順を実行します。

まず、「Marital Status（配偶者の有無）」のラジオボタンの選択内容に応じて「Spouse Salary（配偶者の給与）」フィールドの表示・非表示を制御するためのルールを記述します。

融資申請フォームをオーサリングモードで開きます。「配偶者の有無」コンポーネントを選択し、「」を選択します。次に、「作成」を選択し、ルールエディターを起動します。

ルールエディターを起動すると、「When」ルールがデフォルトで選択されます。また、ルールエディターを起動したフォームオブジェクト（この場合は「Marital Status（配偶者の有無）」）は、「When」文に入力されています。

選択したオブジェクトを変更または修正できませんが、以下に示すように、ルールドロップダウンを使用して別のルールタイプを選択できます。別のオブジェクトにルールを作成する場合は、「キャンセル」を選択してルールエディターを終了し、目的のフォームオブジェクトから再度起動します。
「状態の選択」ドロップダウンを選択し、「次の値と等しい」を選択します。「文字列を入力」フィールドが表示されます。

「Marital Status（配偶者の有無）」のラジオボタンでは、「Married （既婚）」と「Single （独身）」のオプションに対して、それぞれ 0 と 1 の値が割り当てられています。以下に示すように、割り当てられた値は、「編集」ラジオボタンダイアログの「タイトル」タブから確認することができます。
ルール内の「文字列を入力」フィールドで、0 を指定します。

条件をWhen Marital Status is equal to Marriedと定義しました。次に、この条件が True の場合に実行するアクションを定義します。
Then ステートメントで、アクションを選択 ドロップダウンリストから「表示」を選択します。
「オブジェクトをドロップするか、または次から選択」フィールドの「フォームオブジェクト」タブから「Spouse Salary （配偶者の給与）」フィールドをドラッグ・ドロップします。目的のフォームオブジェクトから再度起動します。あるいは、「オブジェクトをドロップするか、または次から選択」フィールドを選択し、ポップアップメニューから「配偶者の給与」フィールドを選択します。この中には、フォーム内のすべてのフォームオブジェクトが一覧表示されます。

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

「完了」を選択し、ルールを保存します。

配偶者の有無が「Single（独身）」の場合は「Spouse Salary（配偶者の給与）」フィールドを非表示にするため、手順 1～5 を繰り返して別のルールを定義します。ルールエディターでは、ルールが次のように表示されます。

write-rules-visual-editor-8

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

write-rules-visual-editor-9

次に、融資適格金額を算出するためのルールを記述します。ここでは、総給与の 50% として計算され、「Loan Eligibility（貸付資格）」フィールドに表示されます。このように表示させるには、「Loan Eligibility（貸付資格）」フィールド上に「Set value Of」ルールを作成します。

「オーサリングモードで「Loan Eligibility（貸付資格）」フィールドを選択し、「」を選択します。次に、「作成」を選択し、ルールエディターを起動します。
ルールのドロップダウンから「指定値」ルールを選択します。
「オプションの選択」を選択し、「数式」を選択します。数式記述用のフィールドが表示されます。
数式記述用のフィールドでは、次のように行います。
- 最初の「オブジェクトをドロップまたは次から選択」の「フォームオブジェクト」タブから「Salary（給与）」フィールドを選択するかドラッグ＆ドロップします。
- 「演算子を選択」フィールドから「プラス」を選択します。
- 「フォームオブジェクト」タブから、他の ドロップオブジェクトの「 Spouse Salary （配偶者の給与）」フィールドを選択またはドラッグ＆ドロップするか、「ここ」 フィールドを選択します。

次に、式フィールドの周りのハイライト表示された領域を選択し、「拡張式」を選択します。

write-rules-visual-editor-13

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

write-rules-visual-editor-14

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

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

「条件の追加」を選択し、「When」文を追加します。

When ステートメント内で、以下の操作を行います。
- 最初の「オブジェクトをドロップまたは次から選択」フィールドの「フォームオブジェクト」タブから「Marital Status（配偶者の有無）」フィールドを選択またはドラッグ＆ドロップします。
- 「演算子を選択」フィールドから「is equal to（次と等しい）」を選択します。
- 他の「オブジェクトをドロップまたは次から選択」フィールドから「文字列」を選択し、「文字列を入力」フィールドに「Married （既婚）」を入力します。
ルールは、ルールエディターで最終的には次のように表示されます。

「完了」を選択し、ルールを保存します。
ステップ 7～12 を繰り返し、配偶者の有無が「Single（独身）」であれば融資適格額を計算する別のルールを定義します。ルールエディターでは、ルールが次のように表示されます。

NOTE

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

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

write-rules-visual-editor-18

コードエディターの使用 using-code-editor

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

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

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

ルールエディターで JavaScript コードを記述する際に、次の表示キューが構造と構文に役立ちます。

構文のハイライト表示機能
自動インデント機能
フォームオブジェクト、関数、プロパティに関するヒントと提案
フォームコンポーネントの名前と一般的な JavaScript 関数を自動的に入力する機能

javascriptruleeditor

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

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

この jsdoc は、

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

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

サポートされるjsdocタグ：

プライベート
構文：@private
プライベート関数は、カスタム関数として含まれていません。
名前
構文：@name funcName <Function Name>
或いは, @function funcName <Function Name> または @func funcName <Function Name> を使用できます。
funcName ：関数の名前です（スペースは使用不可）。
<Function Name>：関数の表示名です。
メンバー
構文：@memberof namespace
関数に名前空間を追加します。
パラメーター
構文：@param {type} name <Parameter Description>
或いは、@argument {type} name <Parameter Description> または @arg {type} name <Parameter Description> を使用できます。
関数で使用されるパラメーターを表示します。関数には、複数のパラメータタグを設けることができます。各パラメーターは、実行順序に応じて 1 個のタグを設けることができます。
{type} は、パラメータータイプを表します。許可されているパラメータータイプは、以下のとおりです。
1. 文字列
2. 数値
3. ブール値
4. 対象範囲
範囲を使用して、アダプティブフォームのフィールドを参照します。フォームが遅延読み込みを使用している場合は、scopeを使用してフィールドにアクセスできます。フィールドは、フィールドが読み込まれたときか、フィールドがグローバルとしてマークされているときにアクセスできます。

他のすべてのパラメータータイプは、上記のいずれかに分類されます。「なし」はサポートされていません。必ず上記のタイプのいずれかを選択してください。タイプでは大文字と小文字が区別されません。パラメーター name. <Parameter Descrption> <parameter> can have multiple words. </parameter> では、スペースは使用できません。
戻り値のタイプ
構文：@return {type}
または、@returns {type} を使用できます。
目的などの、関数に関する情報を追加します。{type} は、関数の戻り値のタイプを表します。許可されている戻り値のタイプは次のとおりです。
1. 文字列
2. 数値
3. ブール値
他のすべての戻り値のタイプは、上記のいずれかに分類されます。「なし」はサポートされていません。必ず上記のタイプのいずれかを選択してください。戻り値のタイプでは、大文字と小文字が区別されません。

This
構文：@this currentComponent

ルールが記述されているアダプティブフォームコンポーネントを参照するには、@this を使用します。

次の例は、フィールド値に基づいています。次の例では、ルールによりフォーム内のフィールドが非表示になります。this.valueのthis部分は、ルールが記述されている基になるアダプティブフォームコンポーネントを参照します。

code language-none

code language-none
`/** * @function myTestFunction * @this currentComponent * @param {scope} scope in which code inside function will be executed. */ myTestFunction = function (scope) { if(this.value == "O"){ scope.age.visible = true; } else { scope.age.visible = false; } }`

   /**
   * @function myTestFunction
   * @this currentComponent
   * @param {scope} scope in which code inside function will be executed.
   */
   myTestFunction = function (scope) {
      if(this.value == "O"){
            scope.age.visible = true;
      } else {
         scope.age.visible = false;
      }
   }

NOTE

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

また、ルールエディターでカスタム関数を使用することもできます。カスタム関数の作成手順について詳しくは、アダプティブフォームのカスタム関数の記事を参照してください。

ルール管理 manage-rules

フォームオブジェクトを選択し、続けて￥」を選択すると、オブジェクト上に既存のルールが一覧表示されます。タイトルを表示し、ルール概要をプレビューできます。さらに、UI を使用して、ルール概要全体の展開と表示、ルールの順序変更、ルールの編集、ルールの削除を行うことができます。

リストルール

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

展開／折りたたみ：ルールリスト内の「コンテンツ」の列には、ルールの内容が表示されます。デフォルトビューにルール内容の全体が表示されていない場合は、「」を選択してビューを展開します。
並べ替え：新しく作成したルールはすべて、ルールリストの一番下に追加されます。ルールは上から下に順に実行されます。一番上のルールが最初に実行され、続いて同じタイプの他のルールが実行されます。例えば、「When」、「Show」、「Enable」および「When」の各ルールが、リストの 1～4 番目にある場合、一番上にある「When」ルールが最初に実行され、次に 4 番目の「When」ルールが実行されます。そして、「Show」ルールおよび「Enable」ルールが実行されます。
ルールの順序を変更するには、をタップするか、リスト内の目的の位置にドラッグアンドドロップします。
編集：ルールを編集するには、ルールタイトルの横にあるチェックボックスを選択します。ルールを編集および削除するための追加のオプションが表示されます。「編集」を選択し、選択したルールをルールエディターで開きます。ルールエディターは、以前にルールを作成する際に使用したモードに応じて、ビジュアルエディターモードまたはコードエディターモードで開きます。
削除：ルールを削除するには、ルールを選択し「削除」を選択します。
有効／無効：場合によっては、ルールの使用を一時的に停止する必要があります。1 つ以上のルールを選択し、アクションツールバーの「無効にする」を選択して無効にすることができます。ルールが無効化されている場合は、ランタイムには実行されません。無効になっているルールを有効にするには、そのルールを選択して、アクションツールバーの「有効にする」を選択します。ルールの「ステータス」列には、ルールが有効か無効かが表示されます。

disablerule

ルールのコピー＆ペースト copy-paste-rules

ルールを 1 つのフィールドから他の類似したフィールドにコピー＆ペーストすると、時間を節約できます。

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

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

既存ルールの詳細な管理方法については、ルール管理を参照してください。
ルールタイトルの横にあるチェックボックスを選択します。ルールを管理するための追加のオプションが表示されます。「コピー」を選択します。

ルールをペーストする別のフォームオブジェクトを選択し、「ペースト」を選択します。さらに、ルールを編集して、変更を加えることができます。

note note

NOTE

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

「完了」を選択し、ルールを保存します。

ネスト式 nestedexpressions

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

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

complexexpression

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

drag-and-drop

日付式の条件 dateexpression

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

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

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

dateexpressioncondition

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

dateexpressionconditionmet

数値比較条件 number-comparison-conditions

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

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

numbercomparisoncondition

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

additionalproofrequested

既存のスクリプトに対するルールエディターの影響 impact-of-rule-editor-on-existing-scripts

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

「スクリプト」タブで記述する必要があったスクリプトや式は、ルールエディターからすべて利用できます。ビジュアルエディターでは表示や編集ができませんが、forms-power-users グループに含まれるユーザーであれば、コードエディターでスクリプトを編集できます。

ルールの例 example

フォームデータモデルサービスを呼び出し invoke

ローン額、加入年数、申請者の信用度スコアを入力として、EMI 額と利率を含むローンプランを返す、web サービス GetInterestRates を考えます。Web サービスをデータソースとして使用し、フォームデータモデルを作成します。データモデルオブジェクトと get サービスをフォームモデルに追加します。フォームデータモデルの「サービス」タブにサービスが表示されます。その後、データモデルオブジェクトのフィールドを含むアダプティブフォームを作成し、ローン総額、加入年数、申込者の信用度についてユーザーの入力を取得します。計画の詳細を取得するために Web サービスをトリガーするボタンを追加します。適切なフィールドで出力が算出されます。

次のルールは、「サービスを起動」アクションを設定してシナリオ例を実行する方法を示しています。

example-invoke-services

アダプティブフォームルールを使用したフォームデータモデルサービスの呼び出し

NOTE

入力が配列タイプの場合、配列をサポートするフィールドが「出力」ドロップダウンセクションに表示されます。

「When」ルールを使用して複数のアクションをトリガーする triggering-multiple-actions-using-the-when-rule

ローン申し込みフォームでは、ローンの申請者が既存の顧客であるかどうかを判断する必要があります。ユーザーが提供する情報に基づいて、顧客 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

コードエディターでのルール

ルール内で関数出力を使用する using-a-function-output-in-a-rule

発注フォームでは、次のテーブルが表示されます。ユーザーはこのテーブルに注文を入力します。このテーブルの特徴は次のとおりです。

最初の行は反復可能なので、ユーザーは複数の製品を注文し、それぞれ異なる数量を指定することができます。この要素の名前は、「Row1」です。
反復可能な行と「Product Quantity（製品数量）」の列が重なるセルでは、タイトルが「Quantity（数量）」になっています。このセルの要素名は「productquantity」です。
表の 2 行目は反復しません。また、この行と「Product Quantity（製品数量）」の列が重なるセルでは、タイトルが「Total Quantity（合計数量）」になっています。

example-function-table

A. 行 1 B. 数量 C. 合計数量

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

example-function-output