アップロードしたデシジョンテーブルを使用したデシジョンサービスの作成
概要
前書き
ビジネス分析者またはビジネスルールの開発者は、デシジョンテーブルのスレッドシートをアップロードして、テーブル形式でビジネスルールを定義できます。このルールは Drools Rule Language (DRL) に組み込まれ、プロジェクトのデシジョンサービスの中心となります。
前提条件
デシジョンテーブルのチームおよびプロジェクトが Decision Central に作成されており、各アセットが、チームに割り当てられたプロジェクトに関連付けられています。詳細は『デシジョンサービスの使用ガイド』を参照してください。
第1章 Red Hat Decision Manager におけるルール作成アセット
Red Hat Decision Manager は、デシジョンサービスにビジネスルールを作成するのに使用するアセットを提供します。ルール作成アセットはそれぞれ長所が異なるため、ゴールおよびニーズに適したアセットを 1 つ、または複数を組み合わせて使用できます。
デシジョンサービスでルールを作成する最適な方法を選択できるように、以下の表で、Decision Central のルール作成アセットを紹介します。
表1.1 Decision Central におけるルール作成アセット
| アセット | 主な特徴 | ドキュメンテーション |
|---|---|---|
|
ガイド付きデシジョンテーブル |
| |
|
アップロードしたデシジョンテーブル |
| |
|
ガイド付きルール |
| |
|
ガイド付きルールテンプレート |
| |
|
DRL ルール |
|
第2章 デシジョンテーブル
デシジョンテーブルは、テーブル形式でビジネスルールを定義し、Decision Central にプロジェクトをアップロードするのに使用できる XLS または XLSX のスプレッドシートです。スプレッドシートの各行がルールになり、各列が条件、アクション、または別のルール属性になります。最初にデシジョンテーブルを作成してアップロードします。次に、その他のすべてのルールアセットと同じように、定義したルールを Drools Rule Language (DRL) ルールにコンパイルします。
アップロードしたデシジョンテーブルに関連するデータオブジェクトはすべて、アップロードしたデシジョンテーブルと同じプロジェクトパッケージに置く必要があります。同じパッケージのアセットはデフォルトでインポートされます。その他のパッケージの既存アセットは、デシジョンテーブルを使用してインポートできます。
第3章 データオブジェクト
データオブジェクトは、作成するルールアセットの構成要素です。データオブジェクトは、プロジェクトで指定したパッケージに Java オブジェクトとして実装されているカスタムのデータタイプです。たとえば、データフィールド Name、Address、および Date of Birth を使用して Person オブジェクトを作成し、ローン申し込みルールに詳細な個人情報を指定できます。このカスタムのデータタイプは、アセットとデシジョンサービスがどのデータに基づいているかを指定します。
3.1. データオブジェクトの作成
定義するデータオブジェクトは、プロジェクトのルールアセットの構成要素で、アセットとデシジョンサービスがどのデータに基づいているかを指定します。
手順
- Menu → Design → Projects に移動して、プロジェクト名をクリックします。
- Create New Asset → データオブジェクト をクリックします。
一意の データオブジェクト 名を入力し、パッケージ を選択します。これにより、その他のルールアセットでもデータオブジェクトを利用できるようになります。同じパッケージに、同じ名前のデータオブジェクトを複数作成することはできません。指定するパッケージは、そのデータオブジェクトを必要とするルールアセットが割り当てられている、もしくはこれから割り当てるパッケージにする必要があります。
別のパッケージからのデータオブジェクトのインポートルールアセットのパッケージに、別のパッケージから既存のデータオブジェクトをインポートすることもできます。インポートするオブジェクトを選択するには、Project Explorer から (ガイド付きデシジョンテーブル、ガイド付きルールなどの) アセットパネルを展開し、特定のアセットを選択し、アセットデザイナーで Data Objects → New item に移動します。
- データオブジェクトを永続化するには、Persistable チェックボックスを選択します。永続型データオブジェクトは、JPA 仕様に準じてデータベースに保存できます。デフォルトの JPA は Hibernate です。
- OK をクリックします。
データオブジェクトデザイナーで add field をクリックして、Id 属性、Label 属性、Type 属性を使用するオブジェクトにフィールドを追加します。必須属性にはアスタリスク (*) マークが付いています。
- Id: フィールドの一意の ID を入力します。
- Label: (任意) フィールドのラベルを入力します。
- Type: フィールドのデータ型を入力します。
List: このチェックボックスを選択すると、このフィールドで、指定したタイプのアイテムを複数保持できるようになります。
図3.1 データオブジェクトへのデータフィールドの追加
Create をクリックして、新しいフィールドを追加します。Create and continue をクリックすると、新しいフィールドが追加され、別のフィールドを引き続き作成できます。
注記フィールドを編集するには、フィールド行を選択し、画面右側の general properties を使用します。
第4章 デシジョンテーブルのユースケース
オンラインショッピングのサイトでは、注文したアイテムの配送料金が一覧表示されます。このサイトでは、以下の条件で配送料金が無料となります。
- 注文したアイテム数が 4 点以上、合計金額が 300 ドル以上。
- 配送の種類で「標準」が選択されている (購入日から 4 - 5 営業日に配送)。
この条件を適用した配送料金は以下のようになります。
表4.1 注文金額が 300 ドル未満の場合
| アイテム数 | 配送日 | 配送料金 (米ドル) (N はアイテム数) |
|---|---|---|
|
3 点以下 |
翌日
2 日後
標準 |
35 15 10 |
|
4 点以上 |
翌日
2 日後
標準 |
N*7.50 N*3.50 N*2.50 |
表4.2 注文金額が 300 ドルを超える場合
| アイテム数 | 配送日 | 配送料金 (米ドル) (N はアイテム数) |
|---|---|---|
|
3 点以下 |
翌日 2 日後 標準 |
25 10 N*1.50 |
|
4 点以上 |
翌日 2 日後 標準 |
N*5 N*2 無料 |
この条件と料金は、以下のデシジョンテーブルのサンプルスプレッドシートで指定しています。
図4.1 配送料金のデシジョンテーブル
この例が示すように、デシジョンテーブルを Decision Central にアップロードするには、テーブルが XLS 形式または XLSX 形式のスプレッドシートで、構造と構文の要件に準拠する必要があります。詳細は「5章デシジョンテーブルの定義」を参照してください。
第5章 デシジョンテーブルの定義
デシジョンテーブルのスプレッドシート (XLS または XLSX) には、ルールデータを定義する 2 つの重要な領域、RuleSet 領域と RuleTable 領域が必要です。スプレッドシートの RuleSet 領域には、ルールセット名、ユニバーサルルール属性など、(このスプレッドシートだけでなく) すべてのルールをパッケージ全体に、グローバルに適用する要素を定義します。RuleTable 領域には、実際のルール (行) と、指定したルールセットのルールテーブルを構成する条件、アクション、その他のルール属性 (列) を定義します。デシジョンテーブルのスプレッドシートには RuleTable 領域を複数追加できますが、RuleSet 領域は 1 つだけとなります。
通常、デシジョンテーブルのスプレッドシートは 1 つだけ作成する必要があり、Decision Central の 1 つのルールパッケージに必要なすべての RuleTable 定義がそこに含まれます。複数のパッケージに複数のデシジョンテーブルスプレッドシートを作成することはできますが、同じパッケージに複数のデシジョンテーブルを作成すると、RuleSet 属性または RuleTable 属性が競合するコンパイルエラーが発生する可能性があるため、推奨はされません。
デシジョンテーブルを定義する際は、以下のサンプルスプレッドシートを参照してください。
図5.1 配送料金のデシジョンテーブルのサンプルスプレッドシート
手順
-
新しいスプレッドシート (XLS または XLSX) の 2 列目または 3 列目 (サンプルの行 1) のセルに、
RuleSetとラベルを付けます。左の列は、(任意で) 記述的メタデータに使用します。 -
右隣のセルに、
RuleSetの名前を入力します。このルールセットには、ルールパッケージに定義するRuleTableルールがすべて含まれます。 -
RuleSetセルの下に、そのパッケージ内のすべてのルールテーブルにグローバルに適用するルール属性 (セルごとに 1 つ) を定義します。右のセルに属性値を指定します。たとえば、ラベルをImportにして、その右隣のセルに、その他のパッケージからデシジョンテーブルのパッケージにインポートするデータオブジェクトを指定します (形式はpackage.name.object.name)。サポートされるセルのラベルと値については、「RuleSet の定義」 を参照してください。 -
RuleSetセルと同じ列で、RuleSet領域の何行か下の新しいセルに、ラベルRuleTableを入力し (サンプルの行 7 )、テーブル名も同じセルに入力します。この名前は、区別のために追加したルールの番号とともに、このルールテーブルに指定した全ルールの名前の最初の部分として使用されます。この自動命名ルールは、NAME属性列を追加すると上書きできます。 その下の 4 行には、必要に応じて以下の要素を定義します (サンプルの行 8-11)。
- ルール属性: 条件、アクション、またはその他の属性。サポートされるセルのラベルと値については 「RuleTable の定義」 を参照してください。
- オブジェクトタイプ: ルール属性が適用されるデータオブジェクト。同じオブジェクトタイプを複数の列に適用したい場合は、(サンプルのデシジョンテーブルに示されるように) 複数のオブジェクトセルを 1 つのセルに結合します。オブジェクトタイプを結合すると、結合範囲の下にあるすべての列が、1 つのパターンに指定する一連の制約になり、一度に一つのファクトに一致するようになります。同じオブジェクトを別の列で繰り返し使用すると、列ごとに別のパターンを作成できます。一致させるファクトは、同一にすることも別にすることもできます。
- 制約: オブジェクトタイプの制約。
列ラベル: (任意) 見やすくするために説明を入力する列のラベル。使用しない場合は空白にします。
注記オブジェクトタイプと制約セルの両方を追加する代わりに、オブジェクトタイプのセルを空にし、対応する制約セルに完全式を追加します。たとえば、オブジェクトタイプに
Order、制約にitemsCount > $1を (別々に) 追加する代わりに、オブジェクトタイプセルを空にして、制約セルにOrder( itemsCount > $1)と入力できます。その他の制約セルでも同じです。
必要なルール属性 (列) をすべて定義したら、必要に応じて各列の各行に値を入力してルールを生成します (サンプルの行 12-17)。データのないセルは無視されます (条件やアクションなどが適用されません)。
デシジョンテーブルのスプレッドシートにさらにルールテーブルを追加する場合がある場合は、前のテーブルの最後の行の後に 1 行空け、前のテーブルの
RuleTableセルとRuleSetセルと同じ列のセルに、別のRuleTableのラベルを付け、このセクションの手順を繰り返して新しいテーブルを作成します (サンプルの行 19-29)。- XLS または XLSX のスプレッドシートを保存して終了します。
Decision Central にスプレッドシートをアップロードすると、スプレッドシートワークブックの最初のワークシートだけがデシジョンテーブルとして処理されます。RuleTable とともに使用する各 RuleSet の名前は、同じパッケージの全デシジョンテーブルファイルで一意にする必要があります。
Decision Central でデシジョンテーブルをアップロードすると、以下の例のように、サンプルスプレッドシートのルールが DRL ルールとして表示されます。
//row 12
rule "Basic_12"
salience 10
when
$order : Order(itemsCount > 0, itemsCount <= 3, deliverInDays == 1)
then
insert(new Charge(35));
end5.1. RuleSet の定義
デシジョンテーブルの RuleSet 領域のエントリーは、(そのスプレッドシートだけでなく) パッケージのすべてのルールに適用される DRL 制約およびルール属性を定義します。 エントリーは、セルのペア (最初のセルにラベル、その右隣のセルに値) が縦方向に積み上げられます。デシジョンテーブルのスプレッドシートには、RuleSet 領域が 1 つだけあります。
以下の表は、RuleSet 定義でサポートされるラベルと値を示しています。
表5.1 サポートされる RuleSet の定義
| ラベル | 値 | 使用方法 |
|---|---|---|
|
|
生成した DRL ファイルのパッケージ名。任意。デフォルトは |
最初のエントリーになります。 |
|
|
|
任意。1 つまで指定可能。省略すると、適用順は指定されません。 |
|
|
整数値 |
任意。1 つまで指定可能。順次モードでこのオプションを使用して、優先順位の開始値を設定します。省略した場合のデフォルト値は 65535 です。 |
|
|
整数値 |
任意。1 つまで指定可能。順次モードでこのオプションを使用して、優先順位の最低値に違反していないかどうかを確認します。省略した場合のデフォルト値は 0 です。 |
|
|
|
任意。1 回まで指定可能。省略すると、引用符がエスケープされます。 |
|
|
別のパッケージからインポートする、コンマ区切りの Java クラスのリスト。 |
任意。繰り返して使用可能。 |
|
|
DRL グローバルの宣言 (型に変数名が続く)。グローバル定義が複数になる場合は、コンマで区切る必要があります。 |
任意。繰り返して使用可能。 |
|
|
DRL 構文に準拠している 1 つまたは複数の関数定義。 |
任意。繰り返して使用可能。 |
|
|
DRL 構文に準拠している 1 つまたは複数のクエリー定義。 |
任意。繰り返して使用可能。 |
|
|
DRL 構文に準拠している 1 つまたは複数の宣言型。 |
任意。繰り返して使用可能。 |
Microsoft Office、LibreOffice、および OpenOffice で二重引用符のエンコード方法が異なり、コンパイルエラーが発生する場合があります。たとえば、“A” は失敗しますが、"A" は成功します。
5.2. RuleTable の定義
デシジョンテーブルの RuleTable 領域のエントリーは、そのルールテーブルのルールに対する条件、アクション、その他のルール属性を定義します。デシジョンテーブルのスプレッドシートには、RuleTable 領域を複数追加できます。
以下の表は、RuleTable 定義でサポートされるラベル (列ヘッダー) および値を示しています。列ヘッダーには、指定のラベル、またはこの表に記載されている文字で始まるカスタムラベルのいずれかを使用できます。
表5.2 サポートされる RuleTable の定義
| ラベル | またはカスタムラベルの頭文字 | 値 | 使用方法 |
|---|---|---|---|
|
|
N |
その行で生成したルールの名前を提供します。デフォルトは、 |
最大 1 列。 |
|
|
I |
生成したルールのコメントになります。 |
最大 1 列。 |
|
|
C |
条件内のパターンに制約を構築するコードスニペットおよび補間値。 |
ルールテーブルごとに最低 1 つ。 |
|
|
A |
ルールの結果に対するアクションを構築するコードスニペットおよび補間値。 |
ルールテーブルごとに最低 1 つ。 |
|
|
@ |
ルールに対するメタデータエントリーを構築するコードスニペットおよび補間値。 |
任意。列の数。 |
以下のセクションでは、条件、アクション、メタデータのセルデータがどのように使用されるかについて説明します。
- 条件
CONDITIONヘッダーの列では、連続した行のセルが、条件要素になります。1 つ下のセル:
CONDITIONのすぐ下のセルのテキストは、ルール条件のパターンを進化させ、次の行のスニペットを制約として使用します。そのセルを、隣接した 1 つ以上のセルと結合した場合は、複数の制約を持った 1 つのパターンが作成されます。すべての制約が結合して括弧で囲まれ、このセルのテキストに追加されます。このセルを空にすると、以下のセルのコードスニペットが自動的に有効な条件要素となります。たとえば、オブジェクトタイプに
Order、制約にitemsCount > $1を (別々に) 追加する代わりに、オブジェクトタイプセルを空にして、制約セルにOrder( itemsCount > $1)と入力できます。その他の制約セルでも同じです。パターンのテキストの前に別のパターンを記述すれば、制約を使用しないパターンを追加できます。中が空の括弧は追加することも省くこともできます。パターンに
from句を追加することもできます。パターンを
evalで終了すると、コードスニペットが、evalの後の括弧の中にブール表現を生成します。2 つ下のセル:
CONDITIONの 2 つ下のセルのテキストは、1 つ下のセルのオブジェクト参照の制約として処理されます。このセルのコードスニペットは、その列のさらに下にあるセルから値が補間されます。下のセルからの値と==を使用した比較で構成される制約を作成する場合は、フィールドセレクターだけで十分です。その他の比較演算子は、スニペットの最後に指定する必要があり、値は下のセルから追加されます。その他のすべての制約形式については、$paramシンボルを使用して、セルの内容を追加する場所を指定する必要があります。$1、$2などのシンボルを使用し、下のセルにコンマで区切った値を指定すれば、複数の値を挿入することもできます。ただし、$1、$2などをコンマで区切らないでください。テーブルの処理に失敗します。パターン
forall($delimiter){$snippet}に従ってテキストを展開する場合は、その下の各セルで、コンマ区切りの値に対して$snippetがそれぞれ 1 回ずつ使用されます。$シンボルの場所に値が挿入され、指定した$delimiterで結合します。forall構文は、他のテキストで囲むことができるのに注意してください。1 つ下のセルにオブジェクトが含まれている場合は、そのセルから条件要素に完全なコードスニペットが追加されます。括弧のペアと、(結合したセルのパターンに複数の制約が追加されている場合は) 区切り文字のコンマが自動的に提供されます。1 つ下のセルが空の場合は、このセルのコードスニペットが自動的に有効な条件要素となります。たとえば、オブジェクトタイプに
Order、制約にitemsCount > $1を (別々に) 追加する代わりに、オブジェクトタイプのセルを空にして、制約セルにOrder( itemsCount > $1)と入力できます。その他の制約セルでも同じです。-
3 つ下のセル:
CONDITIONの 3 つ下のセルのテキストは、見やすくするためにその列の説明を入力するラベルです。 - 4 つ下のセル: 4 行目以降の、空セル以外のエントリーは補間データとして提供されます。セルが空の場合は、このルールで制約や条件が省略されます。
- アクション
ACTIONヘッダーの列では、連続した行のセルが、アクション命令文になります。-
1 つ下のセル:
ACTIONヘッダーの 1 つ下のセルのテキストは任意です。テキストがある場合は、オブジェクト参照として解釈されます。 2 つ下のセル:
ACTIONの 2 つ下のセルのテキストは、その列のさらに下にあるセルの値が補完されるコードスニペットです。挿入が 1 つの場合は、$paramシンボルを使用して、セルの内容を追加する場所を指定します。$1、$2などのシンボルを使用し、下のセルにコンマで区切った値を指定すれば、複数の値を挿入することもできます。$1、$2などをコンマで区切らないでください。テーブルの処理に失敗します。テキストにマーカーシンボルがない場合は、補完なしでメソッドが呼び出されます。このとき、下の行で空セル以外のエントリーを使用して、命令文を追加します。
forall構文がサポートされます。1 つ下のセルにオブジェクトが含まれている場合は、そのセルのテキスト、ピリオド、2 つ下のセルのテキスト、終わりを示すセミコロンが 1 列に並べられ、アクション命令文として追加されるメソッドコールとなります。1 つ下のセルが空の場合は、このセルのコードスニペットが自動的に有効なアクション要素となります。
-
3 つ下のセル:
ACTIONの 3 つ下のセルのテキストは、見やすくするためにその列の説明を入力するラベルです。 - 4 つ下のセル: 4 行目以降の、空セル以外のエントリーは補間データとして提供されます。セルが空の場合は、このルールで制約や条件が省略されます。
-
1 つ下のセル:
- メタデータ
ヘッダーが
METADATAの列では、連続した行のセルが、生成されるルールのメタデータアノテーションになります。-
1 つ下のセル:
METADATAの 1 つ下のセルのテキストは無視されます。 -
2 つ下のセル:
METADATAの 2 つ下のセルのテキストは、ルール行のセルの値を使用して補完されます。メタデータのマーカー文字@が接頭辞として自動的に追加されるため、このセルのテキストに追加する必要はありません。 -
3 つ下のセル:
METADATAの 3 つ下のセルのテキストは、見やすくするためにその列の説明を入力するラベルです。 - 4 つ下のセル: 4 行目以降の、空セル以外のエントリーは補完データとして提供されます。セルが空の場合は、このルールでメタデータアノテーションが省略されます。
-
1 つ下のセル:
5.3. RuleSet 定義または RuleTable 定義におけるその他のルール属性
RuleSet 領域および RuleTable 領域は、PRIORITY、NO-LOOP などのラベルおよび値もサポートします。RuleSet 領域に指定したルール属性は、(そのスプレッドシートだけでなく) 同じパッケージにあるすべてのルールアセットに影響します。RuleTable 領域に指定したルール属性は、そのルールテーブル内のルールにのみ影響します。各ルール属性は、RuleSet 領域で一度、RuleTable 領域で一度使用できます。同じ属性を、スプレッドシートの RuleSet 領域および RuleTable 領域の両方で使用した場合は、RuleTable が優先され、RuleSet 領域の属性が上書きされます。
以下の表は、その他の RuleSet 定義または RuleTable 定義でサポートされるラベル (列ヘッダー) および値を示します。列ヘッダーには、指定のラベル、またはこの表に記載されている文字で始まるカスタムラベルのいずれかを使用できます。
表5.3 RuleSet 定義または RuleTable 定義におけるその他のルール属性
| ラベル | またはカスタムラベルの頭文字 | 値 |
|---|---|---|
|
|
P |
ルールの優先順位 (
例: |
|
|
V |
日付定義および時間定義を含む文字列。現在の日時が
例: |
|
|
Z |
日時定義を含む文字列。現在日時が
例: |
|
|
U |
ブール値。このオプションを
例: |
|
|
G |
ルールを割り当てるアジェンダグループを指定する文字列。アジェンダグループを使用すると、アジェンダをパーティションで区切り、ルールのグループに対する実行をさらに制御できます。フォーカスを取得したアジェンダグループのルールだけがアクティブになります。
例: |
|
|
Ｘ |
ルールを割り当てるアクティベーション (または XOR) グループを指定する文字列。アクティベーショングループでは、ルールを 1 つだけアクティブにできます。発生する最初のルールが、アクティベーショングループの中で、アクティベーションが保留されているルールをすべてキャンセルします。
例: |
|
|
D |
ルールの条件が一致している場合に、ルールがアクティブになってからの時間をミリ秒で定義する長整数値。
例: |
|
|
T |
ルールのスケジュールに対する
例: |
|
|
E |
ルールのスケジュールを指定する Quartz カレンダーの定義。
例: |
|
|
F |
アジェンダグループ内のルールにのみ適用可能なブール値。このオプションが
例: |
|
|
L |
ルールフローグループまたはアジェンダグループ内のルールにのみ適用可能なブール値。このオプションを
例: |
|
|
R |
ルールフローグループを指定する文字列。ルールフローグループで、関連するルールフローによってそのグループがアクティブになった場合に限りルールを発行できます。
例: |
図5.2 属性列が含まれるデシジョンテーブルのサンプルスプレッドシート
第6章 デシジョンテーブルのアップロード
外部の XLS ファイルまたは XLSX ファイルにルールを定義したら、Decision Central のプロジェクトに、そのファイルをデシジョンテーブルとしてアップロードします。
通常は、デシジョンテーブルのスプレッドシートを 1 つだけアップロードする必要があります。これには、Decision Central の 1 つのルールパッケージに必要なすべての RuleTable 定義が含まれます。複数のパッケージに複数のデシジョンテーブルのスプレッドシートをアップロードすることはできますが、同じパッケージに複数のデシジョンテーブルのスプレッドシートをアップロードすると、RuleSet 属性または RuleTable 属性を競合するコンパイルエラーが発生する可能性があるため、これは推奨されません。
手順
- Menu → Design → Projects に移動して、プロジェクト名をクリックします。
- Create New Asset → Decision Table (Spreadsheet) をクリックします。
- 参考となる デシジョンテーブル 名を入力し、適切な パッケージ を選択します。
- ファイルタイプ (xls または xlsx) を選択し、ファイルの選択 アイコンをクリックし、スプレッドシートを選択します。OK をクリックしてアップロードします。
- デシジョンテーブルデザイナーの右上のツールバーで Validate をクリックして、テーブルを検証します。テーブル検証に失敗した場合は、XLS ファイルまたは XLSX ファイルを開いて、構文エラーに対処します。構文のヘルプは「5章デシジョンテーブルの定義」を参照してください。
アップロードしたデシジョンテーブルスプレッドシートを、ガイド付きデシジョンテーブルに変換するには、デシジョンテーブルデザイナーの右上のツールバーで Convert をクリックします。このスプレッドシートを、ガイド付きデシジョンテーブルに変換すると、Decision Central でテーブルデータを直接編集できるようになります。ガイド付きデシジョンテーブルの詳細は『ガイド付きデシジョンテーブルを使用したデシジョンサービスの作成』を参照してください。
第7章 次のステップ
付録A バージョン情報
本ドキュメントの最終更新日: 2018 年 7 月 3 日