第18章 Business Central における DRL ルールの作成

手順

1. Business Central で、Menu Design Projects に移動して、プロジェクト名をクリックします。
2. Add Asset DRL file をクリックします。

3. 参考となる DRL ファイル 名を入力し、適切な パッケージ を選択します。指定するパッケージは、必要なデータオブジェクトが割り当てられている、またはこれから割り当てるパッケージにする必要があります。

   ドメイン固有言語 (DSL) アセットがプロジェクトに定義されている場合は、Show declared DSL sentences を選択することもできます。この DSL アセットは、DRL デザイナーで定義する条件およびアクションに使用できるオブジェクトです。

4. OK をクリックして、ルールアセットを作成します。

   新しい DRL ファイルが、Project Explorer の DRL パネルに追加されます。Show declared DSL sentences オプションを選択した場合は、DSLR パネルに追加されます。この DRL ファイルを割り当てたパッケージは、ファイルの上位にリストされます。

5. DRL デザイナーの左パネルの Fact types リストで、ルールに必要なすべてのデータオブジェクトとデータオブジェクトフィールドがリストされていることを確認します (それぞれを展開します)。リストされていない場合は、DRL ファイルの import 命令文を使用して、その他のパッケージから関連するデータオブジェクトをインポートするか、パッケージに データオブジェクトを作成 します。

6. データオブジェクトをすべて配置したら、DRL デザイナーの Model タブに戻り、以下のいずれかのコンポーネントで DRL ファイルを定義します。

   DRL ファイル内のコンポーネント

   package
   
   import
   
   function  // Optional
   
   query  // Optional
   
   declare   // Optional
   
   global   // Optional
   
   rule "rule name"
       // Attributes
       when
           // Conditions
       then
           // Actions
   end
   
   rule "rule2 name"
   
   ...

   • package: (自動) これは、DRL ファイルを作成し、パッケージを選択すると定義されます。

   • import: このパッケージ、または DRL ファイルで使用するその他のパッケージのデータオブジェクトを指定します。パッケージとデータオブジェクトは packageName.objectName の形式で指定し、複数のインポートは別々の行に指定します。

     データオブジェクトのインポート

     import org.mortgages.LoanApplication;

   • function: (任意) DRL ファイルのルールが使用する関数を指定します。DRL ファイルの関数は、Java クラスではなく、ルールのソースファイルにセマンティックコードを追加します。関数は、特に、ルールのアクション (then) 部分が繰り返し使用され、パラメーターだけがルールごとに異なる場合に便利です。DRL ファイルのルールで、関数を宣言したり、ヘルパークラスから静的メソッドを関数としてインポートしたりすることで、ルールのアクション (then) 部分で、名前を指定して関数を使用できます。

     ルールに関数を宣言して使用 (オプション 1)

     function String hello(String applicantName) {
         return "Hello " + applicantName + "!";
     }
     
     rule "Using a function"
       when
         // Empty
       then
         System.out.println( hello( "James" ) );
     end

     ルールに関数をインポートして使用 (オプション 2)

     import function my.package.applicant.hello;
     
     rule "Using a function"
       when
         // Empty
       then
         System.out.println( hello( "James" ) );
     end

   • query: (任意) DRL ファイルのルールに関連するファクトに対してデシジョンエンジンを検索するのに使用します。DRL ファイルにクエリー定義を追加してから、アプリケーションコードで一致する結果を取得します。クエリーは、定義した条件セットを検索するため、when または then を指定する必要はありません。クエリー名は KIE ベースでグローバルとなるため、プロジェクトにあるその他のすべてのルールクエリーと重複しないようにする必要があります。クエリーの結果に戻るには、ksession.getQueryResults("name") を使用して、従来の QueryResults 定義を設定します ("name" はクエリー名)。これにより、クエリーの結果が返り、クエリーに一致したオブジェクトを取得できるようになります。DRL ファイルのルールに、クエリーと、クエリー結果パラメーターを定義します。

     DRL ファイルにおけるクエリー定義の例

     query "people under the age of 21"
         $person : Person( age < 21 )
     end

     クエリー結果を取得するためのアプリケーションコードの例

     QueryResults results = ksession.getQueryResults( "people under the age of 21" );
     System.out.println( "we have " + results.size() + " people under the age  of 21" );

   • declare: (任意) DRL ファイルのルールが使用する新しいファクトタイプを宣言します。Red Hat Process Automation Manager の java.lang パッケージのデフォルトのファクトタイプは Object ですが、必要に応じて DRL ファイルに別のタイプを宣言することもできます。DRL ファイルにファクトタイプを宣言すると、Java などの低級言語でモデルを作成せず、デシジョンエンジンに直接新しいファクトモデルを定義するようになります。

     新しいファクトタイプの宣言および使用

     declare Person
       name : String
       dateOfBirth : java.util.Date
       address : Address
     end
     
     rule "Using a declared type"
       when
         $p : Person( name == "James" )
       then   // Insert Mark, who is a customer of James.
         Person mark = new Person();
         mark.setName( "Mark" );
         insert( mark );
     end

   • global: (任意) DRL ファイルのルールで使用するグローバル変数を組み込みます。グローバル変数は通常、ルールの結果で使用するアプリケーションサービスなど、ルールのデータやサービスを提供し、ルールの結果で追加されるログや値など、ルールからのデータを返します。KIE セッション設定や REST 操作を使用してデシジョンエンジンのワーキングメモリーにグローバル値を設定し、DRL ファイルのルールの上にグローバル変数を宣言してから、これをルールのアクション部分 (then) で使用します。グローバル変数が複数ある場合は、DRL ファイルで行を分けて使用してください。

     デシジョンエンジンに対するグローバルリストの設定

     List<String> list = new ArrayList<>();
     KieSession kieSession = kiebase.newKieSession();
     kieSession.setGlobal( "myGlobalList", list );

     ルールでのグローバルリストの定義

     global java.util.List myGlobalList;
     
     rule "Using a global"
       when
         // Empty
       then
         myGlobalList.add( "My global list" );
     end

     警告

     グローバル変数に定数イミュータブル値がない場合は、ルールの条件設定にグローバル変数を使用しないでください。グローバル変数はデシジョンエンジンのワーキングメモリーに挿入されないため、デシジョンエンジンでは変数の値の変更を追跡できません。

     グローバル変数を使用してルール間でデータを共有しないでください。ルールは常に、ワーキングメモリーの状態に関して推論し、これに対応するため、ルールからルールにデータを渡す必要がある場合は、データをファクトとしてデシジョンエンジンのワーキングメモリーにアサートしてください。

   • rule: DRL ファイルで各ルールを定義します。ルールは、rule "name" 形式のルール名、ルールの動作 (salience、no-loop など) を定義する任意の属性、when および then 定義が続きます。ルールごとに、ルールパッケージ内で一意の名前を指定する必要があります。ルールの when 部分には、アクションを実行するのに必要な条件が含まれます。たとえば、銀行が、ローンの申し込みを 21 歳以上に限定した場合、"Underage" ルールの when 条件は Applicant( age < 21 ) になります。ルールの then 部分には、ルールの条件部分に一致したときに実行するアクションが含まれます。たとえば、ローンの申込者が 21 歳に満たない場合は、then アクションが setApproved( false ) になり、申込者の年齢条件を満たしていないためにローンの申し込みは承認されません。

     申込者の年齢制限に関するルール

     rule "Underage"
       salience 15
       when
         $application : LoanApplication()
         Applicant( age < 21 )
       then
         $application.setApproved( false );
         $application.setExplanation( "Underage" );
     end

     少なくても、各 DRL ファイルは package コンポーネント、import コンポーネント、rule コンポーネントを指定する必要があります。他のすべてのコンポーネントは任意です。

     以下は、ローン申し込みのデシジョンサービスの DRL ファイルの例です。

     ローン申し込みの DRL ファイルの例

     package org.mortgages;
     
     import org.mortgages.LoanApplication;
     import org.mortgages.Bankruptcy;
     import org.mortgages.Applicant;
     
     rule "Bankruptcy history"
     	salience 10
     	when
     		$a : LoanApplication()
     		exists (Bankruptcy( yearOfOccurrence > 1990 || amountOwed > 10000 ))
     	then
     		$a.setApproved( false );
     		$a.setExplanation( "has been bankrupt" );
     		delete( $a );
     end
     
     rule "Underage"
     	salience 15
     	when
     		$application : LoanApplication()
     		Applicant( age < 21 )
     	then
     		$application.setApproved( false );
     		$application.setExplanation( "Underage" );
     		delete( $application );
     end

     図18.1 Business Central のロール申し込み用の DRL ファイルの例

     
7. ルールのコンポーネントをすべて定義したら、DRL デザイナーの右上ツールバーで Validate をクリックし、DRL ファイルの妥当性を確認します。ファイルの妥当性確認に失敗したら、エラーメッセージに記載された問題に対応し、DRL ファイルの構文およびコンポーネントをすべて見直し、エラーが表示されなくなるまで再度、ファイルを検証します。
8. DRL デザイナーで Save をクリックして、設定した内容を保存します。