Red Hat Business Optimizer のインストールおよび設定

Red Hat Decision Manager 7.0

Red Hat Customer Content Services

brms-docs@redhat.com

法律上の通知

概要

本書では、Red Hat Decision Manager 7.0 に Red Hat Business Optimizer をインストールして設定する方法について説明します。

前書き

ビジネスルールの作成者として、Red Hat Business Optimizer を使用して、限られたリソースや個別の制約の中でプランニングの問題に対する最適解を見つけ出すことができます。

本書を使用して、Red Hat Business Optimizer をセットアップしてその機能を設定します。

前提条件

Business Optimizer 機能のデモとして、Decision Central に 従業員勤務表 サンプルプロジェクトを作成している。このプロジェクトを表示するには、Red Hat Decision Manager がインストールされている必要があります。Red Hat Decision Manager および Decision Central のインストールおよびセットアップの詳細は『デシジョンサービスの使用ガイド』を参照してください。

パート I. Business Optimizer を使用したプランニングの問題の解決

第1章 Red Hat Business Optimizer とは

Red Hat Business Optimizer は組み込み可能な軽量プランニングエンジンで、プランニングの問題を最適化します。最適化のためのヒューリスティック法およびメタヒューリスティック法を、非常に効率的なスコア計算と組み合わせ、一般的な Java プログラマーがプランニングの問題を効率的に解決できるようにします。

Red Hat Business Optimizer は、さまざまなユースケースの解決に役立ちます。以下にその例を示します。

従業員勤務表/患者一覧: 看護師の勤務シフト作成を容易にし、病床管理を追跡します。
教育機関の時間割: 授業、コース、試験、および会議の計画を容易にします。
工場の計画: 自動車の組み立てライン、機械の操業計画、および作業員のタスク計画を追跡します。
在庫の削減: 紙や金属などの資源の消費を削減し、無駄を最小限に抑えます。

どの組織も、制約のある限定されたリソース (従業員、資産、時間、資金) を使用して製品やサービスを提供するといった、プランニングの問題に直面しています。

Red Hat Business Optimizer は、Apache Software License 2.0 を使用するオープンソースソフトウェアです。100% Pure Java に認定されており、ほとんどの Java 仮想マシンで稼働します。

1.1. プランニングの問題は NP 完全または NP 困難

例に挙げたユースケースは通常 NP 完全または NP 困難であり、以下のことが言えます。

問題に対する解を実用的な時間内に検証することが容易である。
問題に対する最適解を実用的な時間内に見つけ出す確実な方法がない。

この場合、一般的な 2 つの手法では不十分なので、問題を解くのが予想より困難だと考えられます。

力まかせアルゴリズムでは (より高度な類似アルゴリズムであっても)、時間がかかり過ぎる。
(ビンパッキング問題において) 容量が最大のビンから順に詰めてゆく クイックアルゴリズムでは、最適解からは程遠い解しか得られない。

高度な最適化アルゴリズムを用いる Business Optimizer であれば、このようなプランニングの問題に対する適切な解を、実用的な時間内に見つけ出すことができます。

第2章プランニングの問題とは

プランニングの問題では、限られたリソースや個別の制約の中で最適なゴールを見つけ出します。最適なゴールは、以下に示すように何らかの物の数となります。

最大の利益: 最適なゴールにより、可能な限り高い利益が得られます。
経済活動の最小フットプリント: 最適なゴールでは、環境負荷が最小となります。
スタッフ/顧客の最大満足: 最適なゴールでは、スタッフ/顧客のニーズが優先されます。

これらのゴールに到達できるかどうかは、利用できるリソースの数に依存します。たとえば、以下のようなリソースには制限があります。

要員の人数
時間
予算
装置、車両、コンピューター、施設などの物理資産

これらのリソースに関連する個別の制約についても考慮する必要があります。たとえば、要員が働くことのできる時間数、特定の装置を使用することのできる技能、または機器同士の互換性などです。

Business Optimizer は、最適化のためのヒューリスティック法およびメタヒューリスティック法を効率的なスコア計算と組み合わせ、Java プログラマーが制約充足問題を効率的に解くことができるようにします。

2.1. プランニングの問題では検索する領域が膨大に

プランニングの問題には、多数の解が存在します。

以下に示すように、解は複数のカテゴリーに分類されます。

可能解: 可能解とは、制約に違反するかどうかは問わず、あらゆる解を指します。通常、プランニングの問題には膨大な数の可能解が存在します。ただし、それらの解の多くは、無価値なものです。
実行可能解: 実行可能解とは、いずれの (負の) ハード制約にも違反しない解を指します。実行可能解の数は、可能解の数に比例する傾向にあります。実行可能解が存在しないケースもあります。実行可能解は、可能解の部分集合です。
最適解: 最適解とは、最高のスコアを持つ解を指します。通常、プランニングの問題には数個の最適解が存在します。実行可能解が存在せず、最適解が現実的ではない場合でも、プランニングの問題には少なくとも 1 つの最適解が必ず存在します。
見つかった最善解: 見つかった最善解とは、与えられた時間内に実施した検索で見つかった最高スコアの解を指します。通常、見つかった最善解は現実的で、十分な時間があれば最適解を見つけることができます。

直観には反していますが、小規模なデータセットの場合であっても、膨大な数の可能解が存在します (正しく計算された場合)。

planner-engine ディストリビューションフォルダーのサンプルでも、ほとんどのインスタンスには膨大な数の可能解が存在します。最適解を確実に見つけ出すことのできる方法は存在しないため、いかなる実行方法も、これらすべての可能解の部分集合を評価することしかできません。

膨大な数の可能解全体を効率的に網羅するために、Business Optimizer はさまざまな最適化アルゴリズムをサポートしています。

ユースケースによっては、ある最適化アルゴリズムが他のアルゴリズムより優れることがあります。ただし、それを事前に予測することは不可能です。Business Optimizer では、XML またはコード中のソルバー設定を数行変更するだけで、最適化アルゴリズムを切り替えることができます。

2.2. プランニングの問題における制約

通常、プランニングの問題には、少なくとも 2 つの制約レベルがあります。

(負の) ハード制約 は、絶対に違反してはならない。
例: 1 人の教師は同時に 2 つの講義を受け持つことはできない。
(負の) ソフト制約 は、避けることが可能であれば違反してはならない。
例: 教師 A は金曜日の午後に講義を受け持ちたくない。

正の制約を持つ問題もあります。

正のソフト制約 (ボーナス) は、可能であれば満たす必要がある。
例: 教師 B は月曜日の午前中に講義を受け持つことを希望している。

基本的な問題の中には、ハード制約しか持たないものや、3 つ以上の制約レベル (例: ハード、ミディアム、およびソフト制約) を持つものもあります。

これらの制約により、プランニングの問題における スコア計算方法 (または 適合度関数) が定義されます。プランニングの問題の解は、それぞれスコアで等級付けすることができます。Business Optimizer のスコア制約は、Java コード等のオブジェクト指向言語または Drools ルールで記述されます。

このタイプのコードは柔軟で、スケーラビリティーに優れます。

パート II. Business Optimizer のダウンロードおよびインストール

第3章 Red Hat Business Optimizer のダウンロード

Red Hat Business Optimizer を使用して、Decision Central、ご自分の IDE、または OpenShift でビジネス上のソリューションを最適化することができます。

手順

Red Hat カスタマーポータルから Red Hat Decision Manager をダウンロードしてインストールします。Red Hat Decision Manager のインストールの詳細は『Red Hat Decision Manager のオンプレミスインストール』を参照してください。
Red Hat カスタマーポータルの Red Hat Decision Manager セクションから rhdm-7.0.0.GA-add-ons.zip ファイルをダウンロードします。
rhdm-7.0.0.GA-planner-engine.zip ファイルから Red Hat Business Optimizer エンジンを展開し、Red Hat Business Optimizer エンジンの JAR ファイルセットにアクセスします。
サンプルを実行します。

以前のバージョンの Red Hat Business Optimizer からの移行については、『Red Hat JBoss BRMS 6.4 から Red Hat Decision Manager 7.0 への移行』を参照してください。

第4章アプリケーションへの Red Hat Business Optimizer エンジンのインストール

Maven またはその他のアプリケーション (Gradle、Ivy、または Buildr 等) を使用して、Red Hat Business Optimizer をインストールすることができます。

前提条件

Red Hat カスタマーポータルから Red Hat Decision Manager をダウンロードしてインストールしている。Red Hat Decision Manager のインストールの詳細は『デシジョンサービスの使用ガイド』を参照してください。

手順

Red Hat JBoss Maven リポジトリーから Red Hat Business Optimizer の optaplanner-core JAR を取得します。
Red Hat JBoss Maven リポジトリーを確認して最新のバージョンを探します。

お使いのプロジェクトの pom.xml に optaplanner-core への依存関係を追加します。

  <dependency>
      <groupId>org.optaplanner</groupId>
      <artifactId>optaplanner-core</artifactId>
      <version>{MAVEN_ARTIFACT_VERSION}</version>
  </dependency>

[このステップは必須ではありません] その他の必要な Red Hat Business Optimizer エンジンモジュール (optaplanner-persistence-jpa または optaplanner-persistence-xstream 統合モジュール等) をすべて追加します。他の Java テクノロジーと共に Red Hat Business Optimizer を使用するための設定方法については、Optaplanner のドキュメントを参照してください。

注記

optaplanner-benchmark モジュールはエンジンの一部として含まれていますが、Employee Rostering モジュールで説明するように、独立したモジュールとして使用することを推奨します。これは、.war ファイルが不必要な optaplanner-benchmark の依存関係を取得するのを防ぐためです。

あるいは、Ant (Ivy なし) を使用している場合は、ダウンロードした ZIP ファイルの binaries ディレクトリーからすべての JAR をコピーして、エンジンをインストールすることもできます。クラスパスに重複した JAR が含まれていないことを手作業で確認してください。

注記

ダウンロードした .zip ファイルの binaries ディレクトリーには、実際に optaplanner-core が使用する以外の JAR が多数含まれています。ここには、optaplanner-benchmark 等の他のモジュールが使用する JAR も含まれています。

Maven リポジトリーの pom.xml ファイルを確認して、特定モジュールの特定バージョンで最低限必要な依存関係のセットを判断します。

パート III. サンプルの実行

第5章 Business Optimizer サンプルの実行

Red Hat Business Optimizer には、さまざまなユースケースのデモとして多数のサンプルが含まれています。

前提条件

Red Hat カスタマーポータルから Red Hat Decision Manager をダウンロードしてインストールしている。

手順

Red Hat カスタマーポータルの Red Hat Decision Manager セクションから rhdm-7.0.0.GA-add-ons.zip ファイルをダウンロードします。
rhdm-7.0.0.GA-planner-engine.zip ファイルから Red Hat Business Optimizer エンジンを展開します。
rhdm-7.0.0.GA-planner-engine フォルダーで examples ディレクトリーを開き、適切なスクリプトを使用してサンプルを実行します。
Linux または Mac の場合:
```
$ cd examples
$ ./runExamples.sh
```
Windows の場合:
```
$ cd examples
$ runExamples.bat
```

GUI アプリケーションウィンドウからサンプルを選択して実行します。

注記

Red Hat Business Optimizer 自体は GUI に依存していません。サーバーまたはモバイル JVM 上でも、デスクトップとまったく同じように動作します。

5.1. IDE (IntelliJ、Eclipse、または Netbeans) での Red Hat Business Optimizer サンプルの実行

IntelliJ または Netbeans で Red Hat Business Optimizer のサンプルを実行するには、以下の手順を使用します。

手順

examples/sources/pom.xml ファイルを新規プロジェクトとして開きます。
Maven の統合が残りのインストール作業を処理します。

Eclipse で Red Hat Business Optimizer のサンプルを実行するには、以下の手順を使用します。

手順

examples/sources ディレクトリーで新規プロジェクトを開きます。
binaries ディレクトリーおよび examples/binaries ディレクトリーにあるすべての JAR を、クラスパスに追加します (ファイル examples/binaries/optaplanner-examples-*.jar を除く)。
Java のソースディレクトリー src/main/java と Java のリソースディレクトリー src/main/resources を追加します。
実行設定を作成します。
- メインクラス: org.optaplanner.examples.app.OptaPlannerExamplesApp
- VM パラメーター (任意): -Xmx512M -server
- 作業ディレクトリー: examples/sources
実行設定を実行します。

パート IV. Decision Server の設定

第6章 Decision Server

Decision Server はスタンドアロンのビルドインコンポーネントです。これにより、REST、JMS、または Java クライアント側のアプリケーションで利用可能なインターフェース、およびソルバーを通じた Red Hat Business Optimizer 機能を使用して、ルールのインスタンスを作成して実行できます。Web でデプロイ可能な WAR ファイルとして作成することで、このサーバーは Web コンテナーであればどこにでもデプロイできます。Decision Server の現在のバージョンは、Red Hat Decision Manager および Red Hat Business Automation の両方にデフォルトの拡張機能として含まれます。

このサーバーはメモリー消費が最小限でフットプリントが小さいため、クラウドインスタンスに簡単にデプロイできます。このサーバーの各インスタンスでは、複数の KIE コンテナーを開いてインスタンスを作成できるので、並行して複数のルールサービスを実行できます。

Decision Central を通じて Decision Server インスタンスをプロビジョニングできます。

第7章 Decision Server のデプロイ

Decision Server は、Web アプリケーションアーカイブ (WAR) ファイル kie-server.war として配布されます。Red Hat Decision Manager をインストールする際に、kie-server.war ファイルをデプロイしてすべての機能を有効にします。Decision Server のデプロイ方法については、『Red Hat Decision Manager のオンプレミスインストール』を参照してください。

前提条件

Red Hat Decision Manager をダウンロードし、kie-server.war ファイルと共にデプロイしている。

手順

Web コンテナーに kie-server ロールを持つユーザーを作成します。
デシジョンエンジンにアクセスできることを確認します。
1. Web ブラウザーで http://SERVER:PORT/kie-server/services/rest/server/ にアクセスします。
2. 前のステップで指定したユーザー名とパスワードを入力します。

認証が済むと、XML の応答がエンジンステータスの形式で表示されます。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response type="SUCCESS" msg="Kie Server info">
  <kie-server-info>
      <capabilities>KieServer</capabilities>
      <capabilities>BRM</capabilities>
      <capabilities>BPM</capabilities>
      <location>http://localhost:8230/kie-server/services/rest/server</location>
      <name>first-kie-server</name>
      <id>first-kie-server</id>
      <version>7.5.1.Final-redhat-1</version>
  </kie-server-info>
</response>

7.1. ブートストラップスイッチ

Decision Server では、サーバーの動作を設定するためのさまざまなブートストラップスイッチ (システムプロパティー) を使用することができます。

表7.1 Decision Server の拡張機能を無効にするブートストラップスイッチ

プロパティー	値	デフォルト	説明
`org.drools.server.ext.disabled`	`true`、`false`	`false`	`true` に設定した場合には、(ルールのサポートなど) Decision Manager のサポートが無効になります。
`org.jbpm.server.ext.disabled`	`true`、`false`	`false`	`true` に設定した場合には、(プロセスのサポートなど) Business Automation のサポートが無効になります。
`org.optaplanner.server.ext.disabled`	`true`、`false`	`false`	`true` に設定した場合には、Business Optimizer のサポートが無効になります。
`org.jbpm.ui.server.ext.disabled`	`true`、`false`	`false`	`true` に設定した場合には、Decision Server の UI 拡張が無効になります。
`org.kie.executor.disabled`	`true`、`false`	`false`	Red Hat Decision Manager エグゼキューターが無効になります。

注記

以下に示すコントローラープロパティーの一部は必須と識別されています。Decision Central で Decision Server コンテナーの作成や削除を処理する場合には、これらのプロパティーを設定します。Decision Central との対話なしに独立して Decision Server を使用する場合には、これらのプロパティーを設定する必要はありません。

表7.2 コントローラーの使用に必要なブートストラップスイッチ

プロパティー	値	デフォルト	説明
`org.kie.server.id`	文字列	該当なし	サーバーに割り当てられる任意の ID。リモートコントローラーが設定されている場合、サーバーはこの ID でコントローラーに接続して KIE コンテナー設定を取得します。指定されていない場合には、ID が自動で生成されます。
`org.kie.server.user`	文字列	`kieserver`	コントローラーから Decision Server に接続するのに使用するユーザー名。管理モードで実行する場合には必要です。Decision Central システムプロパティーでこのプロパティーを設定します。コントローラーを使用する場合には、このプロパティーを設定します。
`org.kie.server.pwd`	文字列	`kieserver1!`	コントローラーから Decision Server に接続するのに使用するパスワード。管理モードで実行する場合には必要です。Decision Central システムプロパティーでこのプロパティーを設定します。コントローラーを使用する場合には、このプロパティーを設定します。
`org.kie.server.token`	文字列	該当なし	このプロパティーにより、コントローラーと Decision Server 間の認証に、ユーザー名/パスワードを使用する基本認証ではなく、トークンベースの認証を使用できます。コントローラーは、リクエストヘッダーのパラメーターとしてトークンを送信します。トークンは更新されないため、サーバーには有効期限の長いアクセストークンが必要です。
`org.kie.server.location`	URL	該当なし	コントローラーが Decision Server インスタンスをコールバックするのに使用する URL (例: `http://localhost:8230/kie-server/services/rest/server`)。コントローラーを使用する場合には、このプロパティーの設定が必須です。
`org.kie.server.controller`	コンマ区切りのリスト	該当なし	コントローラー REST エンドポイントへの URL のコンマ区切りリスト(例: `http://localhost:8080/decision-central/rest/controller`)。コントローラーを使用する場合には、このプロパティーの設定が必須です。
`org.kie.server.controller.user`	文字列	`kieserver`	コントローラー REST API に接続するためのユーザー名。コントローラーを使用する場合には、このプロパティーの設定が必須です。
`org.kie.server.controller.pwd`	文字列	`kieserver1!`	コントローラー REST API に接続するためのパスワード。コントローラーを使用する場合には、このプロパティーの設定が必須です。
`org.kie.server.controller.token`	文字列	該当なし	このプロパティーにより、Decision Server とコントローラー間の認証に、ユーザー名/パスワードを使用する基本認証ではなく、トークンベースの認証を使用できます。サーバーは、リクエストヘッダーのパラメーターとしてトークンを送信します。トークンは更新されないため、有効期限の長いアクセストークンが必要な点に注意してください。
`org.kie.server.controller.connect`	Long	`10000`	サーバーの起動時に Decision Server をコントローラーに接続することを試み、次に試みるまでの待機時間 (ミリ秒)。

表7.3 エグゼキュータープロパティーのブートストラップスイッチ

プロパティー	値	デフォルト	説明
`org.kie.executor.interval`	整数	`3`	Red Hat Decision Manager エグゼキューターがジョブを完了してから、新しいジョブを開始するまでの時間。時間の単位は `org.kie.executor.timeunit` プロパティーで指定します。
`org.kie.executor.timeunit`	`java.util.concurrent.TimeUnit` 定数	`SECONDS`	`org.kie.executor.interval` プロパティーで指定する時間の単位。
`org.kie.executor.pool.size`	整数	`1`	Red Hat Decision Manager エグゼキューターで使用するスレッド数。
`org.kie.executor.retry.count`	整数	`3`	Red Hat Decision Manager エグゼキューターが失敗したジョブをリトライする回数。

表7.4 その他のブートストラップスイッチ

プロパティー	値	デフォルト	説明
`kie.maven.settings.custom`	パス	該当なし	Maven 設定のカスタム `settings.xml` ファイルの場所。
`kie.server.jms.queues.response`	文字列	`queue/KIE.SERVER.RESPONSE`	JMS に対する応答キューの JNDI 名。
`org.drools.server.filter.classes`	`true`、`false`	`false`	`true` に設定した場合、Drools Decision Server の拡張機能が受け入れるのは `XmlRootElement` または `Remotable` のアノテーションが付いたカスタムクラスのみです。
`org.kie.server.domain`	文字列	該当なし	JMS を使用する場合にユーザーの認証に使う JAAS `LoginContext` ドメイン。
`org.kie.server.repo`	パス	`.`	Decision Server の状態ファイルが保存される場所。
`org.kie.server.sync.deploy`	`true`、`false`	`false`	Decision Server に対して、コントローラーがコンテナーのデプロイメント設定を提供するまでデプロイメントを保持するように指示します。このプロパティーは、管理モードで実行するサーバーのみが対象です。このプロパティーのオプションは以下のとおりです。 `false`: コントローラーへの接続は非同期です。アプリケーションが起動してコントローラーへの接続に成功すると、コンテナーをデプロイします。アプリケーションはコンテナーが利用可能になる前でもリクエストを受け付けます。 `true`: メインのサーバーアプリケーションのデプロイメントとコントローラーへの接続スレットを結び付け、その完了を待ちます。同じサーバーインスタンス上に他のアプリケーションがあると、このオプションによりデッドロックが生じる可能性があります。サーバーインスタンス 1 台に対し、アプリケーション (サーバー) は 1 つのみを使用することを推奨します。

第8章管理対象 Decision Server

管理対象インスタンスには、Decision Server を起動するために利用可能なコントローラーが必要です。

コントローラーは、Decision Server の設定を一元的に管理します。各コントローラーは複数の設定を一度に管理でき、環境内に複数のコントローラーを配置することができます。管理対象 Decision Server に複数のコントローラーを設定できますが、一度に接続することができるのは 1 台だけです。

重要

どのコントローラーに接続されても同じ設定セットがサーバーに提供されるように、コントローラーは同期する必要があります。

Decision Server に複数のコントローラーが設定されている場合には、いずれかのコントローラーとの接続が正常に確立されるまで、起動時に各コントローラーに対して接続を試みます。接続を確立できない場合には、設定でローカルのストレージが利用可能な場合でもサーバーは起動しません。こうすることで、整合性を保ち、冗長設定でサーバーが実行されるのを回避します。

注記

コントローラーに接続せずにスタンドアロンモードで Decision Server を実行する方法については、「非管理対象 Decision Server」を参照してください。

8.1. Decision Central により管理される Decision Server の設定

警告

このセクションでは、テスト目的で使用可能なサンプルの設定を紹介します。一部の値は、実稼働環境には適しておらず、その旨を記載しています。

以下の手順を使用して、Decision Server インスタンスを管理するように Decision Central を設定します。

前提条件

以下のロールを持つユーザーが存在している

Decision Central: rest-all ロールを持つユーザー
Decision Server: kie-server ロールを持つユーザー

注記

実稼働環境では、2 人の異なるユーザーを使用し、それぞれロールを 1 つ割り当ててください。このサンプルでは、rest-all と kie-server の両ロールを持つ controllerUser という名前のユーザー 1 人のみを使用します。

手順

以下の JVM プロパティーを設定します。

Decision Central と Decision Server の場所は異なる可能性があります。このような場合には、正しいサーバーインスタンスのプロパティーを設定するようにしてください。

Red Hat JBoss EAP で、以下のファイルの <system-properties> セクションを変更します。
- スタンドアロンモードの場合: EAP_HOME/standalone/configuration/standalone*.xml
- ドメインモードの場合: EAP_HOME/domain/configuration/domain.xml

表8.1 管理対象 Decision Server インスタンスの JVM プロパティー

プロパティー	値	注記
`org.kie.server.id`	`default-kie-server`	Decision Server の ID
`org.kie.server.controller`	`http://localhost:8080/decision-central/rest/controller`	Decision Central の場所
`org.kie.server.controller.user`	`controllerUser`	前のステップで説明した `rest-all` ロールを持つユーザーの名前
`org.kie.server.controller.pwd`	`controllerUser1234;`	前のステップで説明したユーザーのパスワード
`org.kie.server.location`	`http://localhost:8080/kie-server/services/rest/server`	Decision Server の場所

表8.2 Decision Central インスタンスの JVM プロパティー

プロパティー	値	注記
`org.kie.server.user`	`controllerUser`	前のステップで説明した `kie-server` ロールを持つユーザーの名前
`org.kie.server.pwd`	`controllerUser1234;`	前のステップで説明したユーザーのパスワード

http://SERVER:PORT/kie-server/services/rest/server/ に GET リクエストを送信して Decision Server が正常に起動したことを確認します。認証が終わると、以下のような XML 応答が返されます。

<response type="SUCCESS" msg="Kie Server info">
    <kie-server-info>
        <capabilities>KieServer</capabilities>
        <capabilities>BRM</capabilities>
        <capabilities>BPM</capabilities>
        <capabilities>CaseMgmt</capabilities>
        <capabilities>BPM-UI</capabilities>
        <capabilities>BRP</capabilities>
        <capabilities>DMN</capabilities>
        <capabilities>Swagger</capabilities>
        <location>http://localhost:8230/kie-server/services/rest/server</location>
        <messages>
            <content>Server KieServerInfo{serverId='first-kie-server', version='7.5.1.Final-redhat-1', location='http://localhost:8230/kie-server/services/rest/server', capabilities=[KieServer, BRM, BPM, CaseMgmt, BPM-UI, BRP, DMN, Swagger]}started successfully at Mon Feb 05 15:44:35 AEST 2018</content>
            <severity>INFO</severity>
            <timestamp>2018-02-05T15:44:35.355+10:00</timestamp>
        </messages>
        <name>first-kie-server</name>
        <id>first-kie-server</id>
        <version>7.5.1.Final-redhat-1</version>
    </kie-server-info>
</response>

登録が正常に完了したことを確認します。
1. Decision Central にログインします。
2. Menu → Deploy → Execution Servers の順にクリックします。
  正常に登録されている場合には、登録されたサーバーの ID が表示されます。

8.2. 非管理対象 Decision Server

非管理対象 Decision Server はスタンドアロンインスタンスであるため、Decision Server 自体から REST/JMS API を使用して個別に設定する必要があります。コントローラーは使用しません。再起動時には、サーバーが自動的に設定をファイルに永続化し、そのファイルが内部のサーバーの状態として使用されます。

以下の操作を実行中に、設定が更新されます。

KIE コンテナーのデプロイ
KIE コンテナーのデプロイ解除
KIE コンテナーの起動
KIE コンテナーの停止

注記

Decision Server が再起動すると、シャットダウン前に永続化された状態を再度確立しようと試みます。そのため、実行していた KIE コンテナーは起動しますが、停止していたコンテナーは起動しません。

第9章コンテナーの作成

コンテナーとは、パッケージングおよびデプロイされたルールインスタンスを保持するためにプロビジョニングされた独立型の環境です。

前提条件

Decision Server を登録し、コンテナーの追加を開始できるようにしている。

手順

Decision Central にログインします。
メインメニューで、Menu → Deploy → Execution Servers の順にクリックします。
SERVER TEMPLATES → + New Server Template をクリックします。
New Server Template ウィンドウで、Container をクリックします。
手作業で Group Name、Artifact Id、および Version を入力します。
あるいは、コンテナーの名前を入力して、コンテナーにデプロイするプロジェクトを検索します。
プロジェクトの詳細を自動的に入力するには、プロジェクトの横にある Select をクリックします。
警告
コンテナーのバージョン番号を入力するときに、LATEST または RELEASE のキーワードを使用 しないでください。この機能は非推奨になっており、デプロイメント時に問題が発生する可能性があります。
コンテナーを自動的にデプロイするには、Start Container? チェックボックスを選択します。
Finish をクリックします。

コンテナーが正常に作成されたら、リストからコンテナーを選択し、右上隅の Start をクリックして起動します。

コンテナーが実行されていることを確認するには、エンドポイントに [GET] リクエストを送信します。

例9.1 サーバーの応答

<response type="SUCCESS" msg="Info for container myContainer">
  <kie-container container-id="myContainer" status="STARTED">
    <messages>
      <content>Container myContainer successfully created with module org.jbpm:CustomersRelationship:1.0.</content>
      <severity>INFO</severity>
      <timestamp>TIMESTAMP</timestamp>
    </messages>
    <release-id>
      <artifact-id>CustomersRelationship</artifact-id>
      <group-id>org.jbpm</group-id>
      <version>1.0</version>
    </release-id>
    <resolved-release-id>
      <artifact-id>CustomersRelationship</artifact-id>
      <group-id>org.jbpm</group-id>
      <version>1.0</version>
    </resolved-release-id>
    <scanner status="DISPOSED"/>
  </kie-container>
</response>

第10章 Decision Central でのコンテナー管理

Decision Server 内のコンテナーは、Decision Central から起動、停止、更新できます。

10.1. Decision Central でのコンテナー起動、停止、および削除

Decision Central で作成されたコンテナーは、デフォルトでは停止しています。

コンテナーを起動するには、以下の手順を使用します。

前提条件

Decision Central でコンテナーが作成および設定されている。

手順

Decision Central にログインします。
メインメニューで、Menu → Deploy → Execution Servers の順にクリックします。
ページの左側の SERVER TEMPLATES セクションからサーバーを選択します。
左側の KIE CONTAINERS セクションで、起動するコンテナーを選択します。
右上隅の Start をクリックします。
また、実行中のコンテナーを停止するには、Stop をクリックします。コンテナーが停止したら、Remove をクリックして削除できます。

10.2. Decision Central でのコンテナー更新

Decision Server を再起動せずにデプロイしたコンテナーを更新できます。ビジネスルールの変更により新バージョンのパッケージがプロビジョニングされる場合に、この機能が必要となります。同じパッケージの複数バージョンをプロビジョニングしてデプロイすることができます。

コンテナーをアップグレードするには、以下の手順を使用します。

前提条件

Decision Server に Decision Central で実行中のコンテナーが設定されている。

手順

Decision Central にログインします。
メインメニューで、Menu → Deploy → Execution Servers の順にクリックします。
ページの左側の SERVER TEMPLATES セクションからサーバーを選択します。
左側の KIE CONTAINERS セクションで、アップグレードするコンテナーを選択します。
上部の Version Configuration タブをクリックします。
新しいバージョンを入力して Upgrade をクリックします。
[このステップは必須ではありません] 手動での編集を行わずに、デプロイしたコンテナーに対して常に最新版のデプロイメントが適用されるようにする場合は、Version の値を LATEST に設定して、Scan Now をクリックします。
スキャン中にリポジトリーでより新しいバージョンのコンテナーデプロイメントが見つかったは場合、コンテナーをこの新しいバージョンに自動的にアップグレードします。バックグラウンドでスキャナーを起動するには、Start Scanner をクリックし、ミリ秒単位でスキャンの間隔を指定します。
デプロイメントを初めて作成する場合には、Version の値を LATEST に設定することができます。

10.3. 複数コンテナーの管理

Decision Server では、複数のコンテナーを作成してプロビジョニングすることができます。複数のコンテナーを作成してそれらの操作を行うには、以下の手順を使用します。

前提条件

Decision Server が登録され、Decision Central にログインしている。

手順

メインメニューで、Menu → Deploy → Execution Servers の順にクリックします。
ページの左側の SERVER TEMPLATES セクションからサーバーを選択します。
REMOTE SERVERS セクションでサーバーを選択して、すべてのコンテナーとその状態を表示します。

パート V. Red Hat Business Optimizer REST API の設定

注記

すべての REST API コールには、エンドポイントベース URL となる以下の URL が使用されます。http://SERVER:PORT/decision-central/rest/REQUEST_BODY

第11章ナレッジストア REST API

ナレッジストア REST API に対する REST API コールにより、組織単位、リポジトリー、およびプロジェクトを管理することができます。

すべての POST および DELETE コールは、リクエストの詳細およびジョブ ID を返します。この ID を使用して、ジョブのステータスを要求してジョブが正常に完了したかどうかを確認できます。GET コールは、リポジトリー、プロジェクト、および組織単位に関する情報を返します。

これらのコールのパラメーターおよび結果は、JSON エンティティーの形式で提供されます。さまざまなエンティティーの Java クラスが org.guvnor.rest.client パッケージから利用可能です。詳細については、以降のセクションで説明します。

11.1. ジョブコール

ほとんどのナレッジストア REST コールは、発行後にジョブ ID を返します。コールは同期されていないため、後でジョブを参照してライフサイクルの進行に応じてそのステータスを確認する際に、この ID が必要になります。

ライフサイクルの進行に応じて、ジョブは以下のステータスをとります。

表11.1 ジョブのステータス

ステータス	説明
`ACCEPTED`	ジョブが受け入れられ、処理中である。
`BAD_REQUEST`	無効な内容が含まれるため、リクエストが受け入れられなかった。
`RESOURCE_NOT_EXIST`	要求されたリソース (パス) が存在しない。
`DUPLICATE_RESOURCE`	リソースがすでに存在する。
`SERVER_ERROR`	サーバー側のエラーが発生した。
`SUCCESS`	ジョブが正常に完了した。
`FAIL`	ジョブが失敗した。
`APPROVED`	ジョブが承認された。
`DENIED`	ジョブが許否された。
`GONE`	ジョブ ID が見つからなかった。以下の場合にジョブのステータスが `GONE` となります。ジョブが意図的に削除された。ジョブが完了してステータスキャッシュから削除されている。キャッシュが最大容量に達すると、ジョブはステータスキャッシュから削除されます。ジョブが存在しなかった。

以下のジョブコールを利用することができます。

[GET] /jobs/JOB_ID

指定した JOB_ID のステータスを返します。

例11.1 リポジトリーのクローン作成を要求する GET ジョブコールに対するフォーマット済み応答

{
  "status" : "SUCCESS",
  "jobId" : "1377770574783-27",
  "result" : "Alias: testInstallAndDeployProject, Scheme: git, Uri: git://testInstallAndDeployProject",
  "lastModified" : 1377770578194,
  "detailedResult" : null
}

[DELETE] /jobs/JOB_ID

指定した JOB_ID のジョブを削除します。ジョブがまだ処理中でなければ、コールによりジョブキューからジョブが削除されます。ただし、このコールでは、処理中のジョブはキャンセルまたは停止されません。

これらのジョブコールは、共に JobResult インスタンスを返します。

11.2. 組織単位コール

ナレッジストアに対する組織単位コールにより、部署や部門をモデル化する際に役立つ組織単位を管理することができます。組織単位は複数のリポジトリーを持つことができます。

以下の組織単位コールを利用することができます。

[GET] /organizationalunits/

すべての組織単位の一覧を返します。

例11.2 JSON 形式の組織単位一覧

[ {
  "name" : "EmployeeWage",
  "description" : null,
  "owner" : "Employee",
  "defaultGroupId" : "org.bpms",
  "repositories" : [ "EmployeeRepo", "OtherRepo" ]
}, {
  "name" : "OrgUnitName",
  "description" : null,
  "owner" : "OrgUnitOwner",
  "defaultGroupId" : "org.group.id",
  "repositories" : [ "repository-name-1", "repository-name-2" ]
} ]

[GET] /organizationalunits/ORGANIZATIONAL_UNIT_NAME

特定の組織単位に関する情報を返します。

[POST] /organizationalunits/

ナレッジストアに組織単位を作成します。組織単位は JSON エンティティーとして定義されます。コールには OrganizationalUnit インスタンスが必要で、CreateOrganizationalUnitRequest インスタンスを返します。

例11.3 JSON 形式の組織単位

{
  "name" : "testgroup",
  "description" : "",
  "owner" : "tester",
  "repositories" : ["testGroupRepository"]
}

[POST] /organizationalunits/ORGANIZATIONAL_UNIT_NAME

既存組織単位の詳細を更新します。

要求した UpdateOrganizationalUnit インスタンスの name および owner フィールドは、共に空欄のままにすることができます。この操作により、description フィールドやリポジトリーの関連性を更新することはできません。

例11.4 JSON 形式の組織単位更新用インプット

{
  "owner" : "NewOwner",
  "defaultGroupId" : "org.new.default.group.id"
}

[DELETE] /organizationalunits/ORGANIZATIONAL_UNIT_NAME

指定した組織単位を削除します。

[POST] /organizationalunits/ORGANIZATIONAL_UNIT_NAME/repositories/REPOSITORY_NAME

組織単位にリポジトリーを追加します。

[DELETE] /organizationalunits/ORGANIZATIONAL_UNIT_NAME/repositories/REPOSITORY_NAME

組織単位からリポジトリーを削除します。

11.3. リポジトリーコール

ナレッジストアに対するリポジトリーコールにより、Git リポジトリーおよびそのプロジェクトを管理することができます。

以下のリポジトリーコールを利用することができます。

[GET] /repositories

ナレッジストア内のリポジトリー一覧を返します。

例11.5 リポジトリーコールの応答

[
  {
    "name": "bpms-assets",
    "description": "generic assets",
    "userName": null,
    "password": null,
    "requestType": null,
    "gitURL": "git://brms-assets"
  },
  {
    "name": "loanProject",
    "description": "Loan processes and rules",
    "userName": null,
    "password": null,
    "requestType": null,
    "gitURL": "git://loansProject"
  }
]

[GET] /repositories/REPOSITORY_NAME

特定のリポジトリーに関する情報を返します。

[DELETE] /repositories/REPOSITORY_NAME

リポジトリーを削除します。

[POST] /repositories/

JSON エンティティーで定義したリポジトリーを作成、またはリポジトリーのクローンを作成します。

例11.6 クローンを作成するリポジトリーの詳細を定義した JSON エンティティー

{
  "name": "myClonedRepository",
  "organizationalUnitName": "example",
  "description": "",
  "userName": "",
  "password": "",
  "requestType": "clone",
  "gitURL": "git://localhost/example-repository"
}

例11.7 作成するリポジトリーの詳細を定義した JSON エンティティー

{
  "name": "myCreatedRepository",
  "organizationalUnitName": "example",
  "description": "",
  "userName": "",
  "password": "",
  "requestType": "create",
  "gitURL": "git://localhost/example-repository"
}

重要

リポジトリーを作成、またはリポジトリーのクローンを作成する前に、クエリーに organizationalUnitName key-value ペアが含まれていること、および指定した組織単位が存在することを確認してください。

[GET] /repositories/REPOSITORY_NAME/projects/

特定リポジトリー内のプロジェクト一覧を JSON エンティティーとして返します。

例11.8 既存のプロジェクトに関する詳細が含まれる JSON エンティティー

[ {
  "name" : "my-project-name",
  "description" : "A project to illustrate a REST output.",
  "groupId" : "com.acme",
  "version" : "1.0"
}, {
  "name" : "yet-another-project-name",
  "description" : "Yet another project to illustrate a REST output.",
  "groupId" : "com.acme",
  "version" : "2.2.1"
} ]

[POST] /repositories/REPOSITORY_NAME/projects/

リポジトリーにプロジェクトを作成します。

例11.9 作成するプロジェクトを定義したリクエストボディー

{
  "name" : "NewProject",
  "description" : "Description of the new project.",
  "groupId" : "org.redhat.test",
  "version" : "1.0.0"
}

[DELETE] /repositories/REPOSITORY_NAME/projects/PROJECT_NAME

リポジトリー内のプロジェクトを削除します。

パート VI. Decision Server を実行するための REST API

第12章 Decision Server 用 REST API

REST API を使用して Decision Server と通信することができます。

リクエストを送信するためのベース URL は、上で定義したエンドポイントです (例: http://SERVER:PORT/kie-server/services/rest/server/)。
すべてのリクエストには、kie-server ロールに対する HTTP 基本認証またはトークンベースの認証が必要です。

以下のメソッドでは、3 種類のリクエストフォーマット (JSON、JAXB、および XSTREAM) がサポートされます。以下の HTTP ヘッダーを指定する必要があります。

Accept: application/json または application/xml に設定します。
Accept ヘッダーで複数の受け入れ可能コンテンツタイプを指定する場合は、優先修飾子 (HTML 1.1 規格で定義される qvalue) を含める必要があります。これを含めないと、予期せぬ挙動を示す場合があります。複数の受け入れ可能コンテンツタイプを指定した、適切なヘッダーフォーマットの例を以下に示します。
```
Accept: application/xml; q=0.5, application/json; q=0.9
```
X-KIE-ContentType: XSTREAM マーシャラーを使用する際に必要です。この場合、ヘッダーを XSTREAM に設定します。値に JSON および JAXB を指定することができますが、必須ではありません。Content-type を application/xml に設定すると、デフォルトでは値に JAXB が使用されます。
Content-type: application/json または application/xml に設定します。このヘッダーは、お使いのペイロードのフォーマットに対応します。
--data: お使いのペイロードです。ペイロードがファイルにある場合は、名前の始めに @ 記号を付けます。以下に例を示します。
```
--data @commandsRequest.json
```

リクエストと応答が共に同じフォーマットになるように、アプリケーションのリクエストには必ず Content-Type HTTP ヘッダーと Accept HTTP ヘッダーの両方を指定します。指定しないと、サーバーからマーシャリングに関するエラーが送付されます。

例では Curl ユーティリティーが使われていますが、任意の REST クライアントを使用することができます。Curl コマンドには以下のパラメーターが使われます。

-u: Decision Server の認証に username:password を指定します。
-H: HTTP ヘッダーを指定します。
-X: リクエストの HTTP メソッドを指定します。メソッドは [GET]、[POST]、[PUT]、または [DELETE] のいずれかです。

注記

Red Hat Decision Manager コマンドは、Decision Server が Red Hat Decision Manager 機能を持つ場合に限り有効です。その他のエンドポイントは、Decision Server が Red Hat Business Automation 機能を持つ場合に限り有効です。http://SERVER:PORT/kie-server/services/rest/server の URI にアクセスして、お使いの Decision Server の機能を確認してください。

12.1. Red Hat Decision Manager コマンド

[POST] /containers/instances/CONTAINER_ID

リクエストのタイプ: 単一の org.kie.api.command.Command コマンド、または BatchExecutionCommand ラッパーの複数コマンド。
応答のタイプ: org.kie.server.api.model.ServiceResponse<String>
説明: 指定した CONTAINER_ID に送られたコマンドを実行し、コマンドの実行結果を返します。詳細は、以下に示すサポートされるコマンドを参照してください。

サポートされるコマンド一覧:

AgendaGroupSetFocusCommand
ClearActivationGroupCommand
ClearAgendaCommand
ClearAgendaGroupCommand
ClearRuleFlowGroupCommand
DeleteCommand
InsertObjectCommand
ModifyCommand
GetObjectCommand
InsertElementsCommand
FireAllRulesCommand
QueryCommand
SetGlobalCommand
GetGlobalCommand
GetObjectsCommand
BatchExecutionCommand
DisposeCommand

コマンドの詳細は、org.drools.core.command.runtime パッケージを参照してください。

[POST] Drools コマンドの実行

任意のディレクトリーに移動し、commandsRequest.json を作成します。

{
      "lookup" : null,
      "commands" : [ {
        "insert" : {
          "object" : "testing",
          "disconnected" : false,
          "out-identifier" : null,
          "return-object" : true,
          "entry-point" : "DEFAULT"
        }

      }, {
        "fire-all-rules" : { }
      } ]
    }

以下のコマンドを実行します。
```
$ curl -X POST -H 'X-KIE-ContentType: JSON' -H 'Content-type: application/json' -u 'kieserver:kieserver1!' --data @commandsRequest.json http://localhost:8080/kie-server/services/rest/server/containers/instances/myContainer
```
このコマンドによりリクエストが生成され、このリクエストがサーバーに Insert Object および Fire All Rules コマンドを送信します。Lookup により kjar で設定される ksession が指定されます。lookup 値に null を指定した場合は、デフォルトの KIE セッションが使用されます。

応答の例:

    {
      "type" : "SUCCESS",
      "msg" : "Container hello successfully called.",
      "result" : "{\n  \"results\" : [ ],\n  \"facts\" : [ ]\n}"
    }

第13章 Red Hat Business Optimizer REST API の設定

Decision Server は、以下の Red Hat Business Optimizer REST API をサポートします。これらの API は、JMS および Java クライアント API から利用することもできます。

前提条件

Red Hat Decision Manager がインストールされ、kie-server ロールに HTTP 基本認証が設定されている。サーバーエンドポイントのベース URL が識別されている (例: http://SERVER:PORT/CONTEXT/services/rest/server/)。

特定のマーシャリングフォーマットが必要な場合は、以下のように、HTTP ヘッダー Content-Type と、任意で X-KIE-ContentType を HTTP リクエストに追加します。

Content-Type: application/xml
X-KIE-ContentType: xstream

注記

X-KIE-ContentType の値には、xstream、xml、json を設定することができます。

以下の例に示すリクエストおよび応答は、KIE コンテナーが Decision Central の従業員勤務表サンプルを使用してビルドされる前提です (/services/rest/server/containers/employee-rostering に PUT リクエストを呼び出すと、以下の応答が返されます)。

<kie-container container-id="employee-rostering">
  <release-id>
    <group-id>employeerostering</group-id>
    <artifact-id>employeerostering</artifact-id>
    <version>1.0.0-SNAPSHOT</version>
  </release-id>
</kie-container>

13.1. [GET] /containers

作成されたコンテナーの一覧を返します。

例13.1 サーバー応答の例 (XStream)

<response type="SUCCESS" msg="List of created containers">
  <result class="kie-containers">
    <kie-container>
      <container-id>employee-rostering</container-id>
        <release-id>
          <group-id>employeerostering</group-id>
          <artifact-id>employeerostering</artifact-id>
          <version>1.0.0-SNAPSHOT</version>
        </release-id>
        <resolved-release-id>
          <group-id>employeerostering</group-id>
          <artifact-id>employeerostering</artifact-id>
          <version>1.0.0-SNAPSHOT</version>
        </resolved-release-id>
        <status>STARTED</status>
        <scanner>
          <status>DISPOSED</status>
        </scanner>
    </kie-container>
  </result>
</response>

13.2. [PUT] /containers/{containerId}/solvers/{solverId}

コンテナー {containerId} に、指定の {solverId} で新しいソルバーを作成します。リクエストボディーはマーシャリングされた SolverInstance エンティティーになり、ソルバーの設定ファイルを指定する必要があります。

リクエストとそれに対応する応答の例を以下に示します。

例13.2 サーバーリクエストの例 (XStream)

<solver-instance>
  <solver-config-file>employeerostering/employeerostering/EmployeeRosteringSolverConfig.solver.xml</solver-config-file>
</solver-instance>

例13.3 サーバー応答の例 (XStream)

<solver-instance>
  <container-id>employee-rostering</container-id>
  <solver-id>solver1</solver-id>
  <solver-config-file>employeerostering/employeerostering/EmployeeRosteringSolverConfig.solver.xml</solver-config-file>
  <status>NOT_SOLVING</status>
  <score/>
</solver-instance>

13.3. [GET] /containers/{containerId}/solvers

コンテナーで作成したソルバーの一覧を返します。

例13.4 サーバー応答の例 (XStream)

<org.kie.server.api.model.instance.SolverInstanceList>
  <solvers>
    <solver-instance>
      <container-id>employee-rostering</container-id>
      <solver-id>solver1</solver-id>
      <solver-config-file>employeerostering/employeerostering/EmployeeRosteringSolverConfig.solver.xml</solver-config-file>
      <status>NOT_SOLVING</status>
      <score/>
    </solver-instance>
  </solvers>
</org.kie.server.api.model.instance.SolverInstanceList>

13.4. [GET] /containers/{containerId}/solvers/{solverId}

コンテナー {containerId} のソルバー {solverId} に関する現在の状態を返します。

例13.5 サーバー応答の例 (XStream)

<solver-instance>
  <container-id>employee-rostering</container-id>
  <solver-id>solver1</solver-id>
  <solver-config-file>employeerostering/employeerostering/EmployeeRosteringSolverConfig.solver.xml</solver-config-file>
  <status>NOT_SOLVING</status>
  <score/>
</solver-instance>

13.5. [POST] /containers/{containerId}/solvers/{solverId}/state/solving

コンテナー {containerId} のソルバー {solverId} がまだ実行中でなければ、そのソルバーを起動します。リクエストボディーは最適化する PlanningSolution をマーシャリングしたものです。

以下は、2 台のコンピューターと 6 つのプロセスに関する OptaCloud の問題を解決する例です。ソルバーは同期せずに実行されます。最善解を取得するために、bestsolution URL にリクエストを送信します。

例13.6 サーバーリクエストの例 (XStream)

<employeerostering.employeerostering.EmployeeRoster>
  <employeeList>
    <employeerostering.employeerostering.Employee>
      <name>John</name>
      <skills>
        <employeerostering.employeerostering.Skill>
          <name>reading</name>
        </employeerostering.employeerostering.Skill>
      </skills>
    </employeerostering.employeerostering.Employee>
    <employeerostering.employeerostering.Employee>
      <name>Mary</name>
      <skills>
        <employeerostering.employeerostering.Skill>
          <name>writing</name>
        </employeerostering.employeerostering.Skill>
      </skills>
    </employeerostering.employeerostering.Employee>
    <employeerostering.employeerostering.Employee>
      <name>Petr</name>
      <skills>
        <employeerostering.employeerostering.Skill>
          <name>speaking</name>
        </employeerostering.employeerostering.Skill>
      </skills>
    </employeerostering.employeerostering.Employee>
  </employeeList>
  <shiftList>
    <employeerostering.employeerostering.Shift>
      <timeslot>
        <startTime>2017-01-01T00:00:00</startTime>
        <endTime>2017-01-01T01:00:00</endTime>
      </timeslot>
      <requiredSkill reference="../../../employeeList/employeerostering.employeerostering.Employee/skills/employeerostering.employeerostering.Skill"/>
    </employeerostering.employeerostering.Shift>
    <employeerostering.employeerostering.Shift>
      <timeslot reference="../../employeerostering.employeerostering.Shift/timeslot"/>
      <requiredSkill reference="../../../employeeList/employeerostering.employeerostering.Employee[3]/skills/employeerostering.employeerostering.Skill"/>
    </employeerostering.employeerostering.Shift>
    <employeerostering.employeerostering.Shift>
      <timeslot reference="../../employeerostering.employeerostering.Shift/timeslot"/>
      <requiredSkill reference="../../../employeeList/employeerostering.employeerostering.Employee[2]/skills/employeerostering.employeerostering.Skill"/>
    </employeerostering.employeerostering.Shift>
  </shiftList>
  <skillList>
    <employeerostering.employeerostering.Skill reference="../../employeeList/employeerostering.employeerostering.Employee/skills/employeerostering.employeerostering.Skill"/>
    <employeerostering.employeerostering.Skill reference="../../employeeList/employeerostering.employeerostering.Employee[3]/skills/employeerostering.employeerostering.Skill"/>
    <employeerostering.employeerostering.Skill reference="../../employeeList/employeerostering.employeerostering.Employee[2]/skills/employeerostering.employeerostering.Skill"/>
  </skillList>
  <timeslotList>
    <employeerostering.employeerostering.Timeslot reference="../../shiftList/employeerostering.employeerostering.Shift/timeslot"/>
  </timeslotList>
  <dayOffRequestList/>
  <shiftAssignmentList/>
</employeerostering.employeerostering.EmployeeRoster>

13.6. [POST] /containers/{containerId}/solvers/{solverId}/state/terminating-early

ソルバーが実行中の場合は、ソルバーに早期の終了をリクエストします。ソルバーは削除されないため、引き続き最善解を取得することができます。

13.7. [GET] /containers/{containerId}/solvers/{solverId}/bestsolution

リクエストの作成時に見つかった最善解を返します。ソルバーがまだ終了していない (つまり status フィールドは SOLVING のまま) 場合は、その時点での最善解を返しますが、後のコールでより良い解が返される可能性もあります。

例13.7 サーバー応答の例 (XStream)

<solver-instance>
  <container-id>employee-rostering</container-id>
  <solver-id>solver1</solver-id>
  <solver-config-file>employeerostering/employeerostering/EmployeeRosteringSolverConfig.solver.xml</solver-config-file>
  <status>NOT_SOLVING</status>
  <score scoreClass="org.optaplanner.core.api.score.buildin.hardsoft.HardSoftScore">0hard/0soft</score>
  <best-solution class="employeerostering.employeerostering.EmployeeRoster">
    <employeeList>
      <employeerostering.employeerostering.Employee>
        <name>John</name>
        <skills>
          <employeerostering.employeerostering.Skill>
            <name>reading</name>
          </employeerostering.employeerostering.Skill>
        </skills>
      </employeerostering.employeerostering.Employee>
      <employeerostering.employeerostering.Employee>
        <name>Mary</name>
        <skills>
          <employeerostering.employeerostering.Skill>
            <name>writing</name>
          </employeerostering.employeerostering.Skill>
        </skills>
      </employeerostering.employeerostering.Employee>
      <employeerostering.employeerostering.Employee>
        <name>Petr</name>
        <skills>
          <employeerostering.employeerostering.Skill>
            <name>speaking</name>
          </employeerostering.employeerostering.Skill>
        </skills>
      </employeerostering.employeerostering.Employee>
    </employeeList>
    <shiftList>
      <employeerostering.employeerostering.Shift>
        <timeslot>
          <startTime>2017-01-01T00:00:00</startTime>
          <endTime>2017-01-01T01:00:00</endTime>
        </timeslot>
        <requiredSkill reference="../../../employeeList/employeerostering.employeerostering.Employee/skills/employeerostering.employeerostering.Skill"/>
      </employeerostering.employeerostering.Shift>
      <employeerostering.employeerostering.Shift>
        <timeslot reference="../../employeerostering.employeerostering.Shift/timeslot"/>
        <requiredSkill reference="../../../employeeList/employeerostering.employeerostering.Employee[3]/skills/employeerostering.employeerostering.Skill"/>
      </employeerostering.employeerostering.Shift>
      <employeerostering.employeerostering.Shift>
        <timeslot reference="../../employeerostering.employeerostering.Shift/timeslot"/>
        <requiredSkill reference="../../../employeeList/employeerostering.employeerostering.Employee[2]/skills/employeerostering.employeerostering.Skill"/>
      </employeerostering.employeerostering.Shift>
    </shiftList>
    <skillList>
      <employeerostering.employeerostering.Skill reference="../../employeeList/employeerostering.employeerostering.Employee/skills/employeerostering.employeerostering.Skill"/>
      <employeerostering.employeerostering.Skill reference="../../employeeList/employeerostering.employeerostering.Employee[3]/skills/employeerostering.employeerostering.Skill"/>
      <employeerostering.employeerostering.Skill reference="../../employeeList/employeerostering.employeerostering.Employee[2]/skills/employeerostering.employeerostering.Skill"/>
    </skillList>
    <timeslotList>
      <employeerostering.employeerostering.Timeslot reference="../../shiftList/employeerostering.employeerostering.Shift/timeslot"/>
    </timeslotList>
    <dayOffRequestList/>
    <shiftAssignmentList/>
    <score>0hard/0soft</score>
  </best-solution>
</solver-instance>

13.8. [POST] /containers/{containerId}/solvers/{solverId}/problemfactchanges

リアルタイムプランニング機能。1 つまたは複数の ProblemFactChanges を送信して、現在ソルバーが最適化中のデータセットを更新します。

13.9. [GET] /containers/{containerId}/solvers/{solverId}/problemfactchanges/processed

リアルタイムプランニング機能。ソルバーが送信されているすべての ProblemFactChanges を処理したら、true を返します。そうでない場合は、false を返します。

13.10. [DELETE] /containers/{containerId}/solvers/{solverId}

コンテナー {containerId} のソルバー {solverId} を破棄します。ソルバーがまだ終了していない場合は、終了してから破棄を行います。

パート VII. オーサープランニング用アセットおよびソルバーの作成

第14章 Decision Central でのソルバー作成

ソルバーエディターによりソルバー設定を作成し、KJAR のデプロイ後に Execution Solver またはプレーンな Java コードでその設定を実行します。

Decision Central でソルバー設定を編集および作成することができます。

前提条件

Red Hat Decision Manager をダウンロードしてインストールしている。プロジェクトが作成され、すべての関連アセットが設定された状態でデプロイされている。

この例では、ソルバー機能のデモとして同梱された従業員勤務表のサンプルプロジェクトを使用しています。

手順

Decision Central で Menu → Projects をクリックし、使用するプロジェクトをクリックして開きます。
Assets パースペクティブで、Create New Asset → Solver configuration をクリックします。
Create new Solver configuration ウィンドウでソルバーの名前を入力し、Ok をクリックします。
これにより、Solver configuration エディターが表示されます。
Score Director Factory 設定セクションで、スコアリングルール定義を含むナレッジベースを定義します。
1. ナレッジベースに定義したナレッジセッションのいずれかを選択します。
  セッションは、Decision Central の Project パースペクティブで管理できます (Menu → Projects をクリックします)。
  注記
  ナレッジセッションを指定しないと、Red Hat Business Optimizer ではデフォルトのセッションが使用されます。
Validate ボタンをクリックして、ソルバー設定を検証します。この操作で実際にソルバーがビルドされ、デプロイして実行することなくプロジェクトのほとんどの問題を把握することができます。

デフォルトでは、ソルバー設定は自動的にすべてのプランニングエンティティーおよびプランニングソリューションクラスを探します。何も見つからない (または多すぎる) と、検証は失敗します。

14.1. ソルバー終了の設定

デフォルトでは、プランニングエンジンが問題のインスタンスを解決する時間に制限はありません。

シナリオによっては (たとえはリアルタイムプランニング)、このデフォルト設定を適用する必要があります。ただし、解決プロセスの総時間をコントロールするメカニズムを用意しておくことが有効です。

サポートされる終了タイプの詳細については、OptaPlanner のドキュメントを参照してください。

注記

Decision Server REST API を使用して、ソルバーを手動で終了することができます。

前提条件

プロジェクトをデプロイし、Decision Central でソルバーを作成している。

手順

Solver editor を開きます。
Termination セクションで Add をクリックして、選択した論理グループに新しい終了要素を作成します。
ドロップダウンリストから終了タイプを選択します。これが、終了設定の入力フィールドとして追加されます。
終了要素は、ツリー構造で整理されます。

エディターでは、論理グループ (終了タイプ Nested termination と表示) を定義することができます。複数の終了要素は、論理演算子 (And/Or) で結合します。演算子が適用される範囲は、演算子を定義する論理グループに限定されます。

終了のツリー構造から終了要素を削除するには、Remove をクリックします。

注記

論理グループの親要素を削除すると、その子要素も削除されます。

第15章 Red Hat Business Optimizer ドメインエディターおよびオーサープランニングアセット

Red Hat Business Optimizer では、データモデラーを活用して制約充足問題のドメインモデルを作成します。

基本機能 (データオブジェクトおよびそのプロパティーの作成) に加えて、Decision Central の Data Objects エディターパースペクティブを使用して、Red Hat Business Optimizer 固有のデータオブジェクトロールによりデータのモデリングを強化することもできます。Data Objects パースペクティブ右側のをクリックして Red Hat Business Optimizer ドックを表示し、Planning Entity および Planning Solution ロールを利用することができます。

これらのオプションは、Red Hat Business Optimizer ドメインエディターから利用することができます。

ドメインエディターの内容は、その時の選択の状態により異なります。

データオブジェクトを選択すると、データオブジェクトレベルで定義した設定が表示されます (Planning Solution、Planning Entity)。
データオブジェクトのプロパティーを選択すると、データオブジェクトのプロパティーレベルで定義した設定が表示されます。

Red Hat Business Optimizer ドメインエディター機能の概要については、以下のセクションに説明があります。

データオブジェクトレベル

プロパティーレベル

第16章プランニングエンティティー難易度比較子の設定

Planning Entity レベルで指定した難易度比較子を用いて、どのプランニングエンティティーの計画がより困難かを設定することができます。これにより、最適化アルゴリズムを効率的に実行することができます。詳細については、OptaPlanner のドキュメントを参照してください。

前提条件

Data Object エディターのデータオブジェクトで Planning Entity を選択しており、Data Object パースペクティブの Red Hat Business Optimizer ドメインエディターで難易度比較子定義ツールが利用可能である。

手順

Add condition をクリックして、指定したプランニングエンティティーに、新しい並べ替え条件を追加します。
条件を追加したら、Add field をクリックして難易度比較に使用するフィールドを選択します。
フィールドには以下の 2 つのタイプがあります。
- Basic: 値タイプ (例: 数値、文字列)
- Data object: 入れ子属性を持つ複合タイプ
  Data object タイプでは、basic タイプに達するまでオブジェクトの階層をネスティングすることができます。basic タイプに達すると、Add field ボタンは表示されなくなります。
  並べ替え条件が配列されます。Red Hat Business Optimizer エンジンがプランニングエンティティーの難易度を解決する際、定義された順に条件が優先されます。
並べ替え条件からフィールドを削除するには、ラベル内の x アイコンをクリックします。フィールドのタイプが Data object の場合は、フィールドを削除するとその子フィールドもすべて削除されます。
- 条件の優先順位を変更するには、上向き矢印、下向き矢印 をクリックして条件を上下に移動します。
- プランニングエンティティーの条件の並べ替えを昇順または降順に設定するには、Sort order アイコンをクリックします。

第17章ガイド付きルールデザイナーを使用したスコア制約の定義

最適化の問題を解決するには、解を評価するためのスコア制約を定義する必要があります。Red Hat Business Optimizer にはガイド付きルールデザイナーが組み込まれ、スコア修飾子を利用することができます。エンジンは、解決プロセス時にこの修飾子を使用します。

プロジェクトにプランニングソリューションが定義されている場合には、ルールの THEN セクションの右側にあるアクションセレクター ( 5686 ) から、スコア修飾子を利用することができます。

ガイド付きルールデザイナーを使用して新たなスコア制約を作成するには、以下の手順を使用します。

前提条件

ドメインエディターでクラスを作成して Planning Solution を選択し、プランニングソリューションを定義している。詳細については、「15章Red Hat Business Optimizer ドメインエディターおよびオーサープランニングアセット」を参照してください。

手順

Menu → Projects をクリックし、該当するプロジェクトをクリックしてプロジェクトの Assets 画面を開きます。
右上隅の Create New Asset をクリックします。
ドロップダウンメニューから Guided Rule を選択します。
Create new Guided Rule ウィンドウでルールの名前を入力し、Ok をクリックします。
すでに作成済みのスコア制約を拡張する場合は、EXTEND の横のドロップダウンボックスをクリックして、リストからルールを選択します。
WHEN セクションの右側にあるプラスアイコン ( ) をクリックし、条件を追加します。
アクションを選択すると、ルールの THEN セクションの右側に Business Optimizer のスコアインプットが表示されます。
ガイド付きルールデザイナーでは、以下の Red Hat Business Optimizer アクションを使用することができます。
- Modify a single score level: 1 つのスコアコンポーネントだけを変更する場合に、このアクションを使用します (例: ハードスコア)
- Modify multiple score levels: 同時に複数のスコアコンポーネントを変更する場合に、このアクションを使用します (例: ハードスコアおよびソフトスコア)
テキストの入力フィールドに制約の値を入力します。
Validate をクリックし、入力した値が正しいことを確認します。

ガイド付きルールデザイナー使用の詳細については、『ガイド付きルールを使用したデシジョンサービスの作成』を参照してください。

付録A バージョン情報

本ドキュメントの最終更新日: 2018 年 7 月 3 日

法律上の通知

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Red Hat Business Optimizer のインストールおよび設定

Red Hat Customer Content Services

前書き

パート I. Business Optimizer を使用したプランニングの問題の解決

第1章 Red Hat Business Optimizer とは

1.1. プランニングの問題は NP 完全または NP 困難

第2章 プランニングの問題とは

2.1. プランニングの問題では検索する領域が膨大に

2.2. プランニングの問題における制約

パート II. Business Optimizer のダウンロードおよびインストール

第3章 Red Hat Business Optimizer のダウンロード

第4章 アプリケーションへの Red Hat Business Optimizer エンジンのインストール

パート III. サンプルの実行

第5章 Business Optimizer サンプルの実行

5.1. IDE (IntelliJ、Eclipse、または Netbeans) での Red Hat Business Optimizer サンプルの実行

パート IV. Decision Server の設定

第6章 Decision Server

第7章 Decision Server のデプロイ

7.1. ブートストラップスイッチ

第8章 管理対象 Decision Server

8.1. Decision Central により管理される Decision Server の設定

8.2. 非管理対象 Decision Server

第9章 コンテナーの作成

第10章 Decision Central でのコンテナー管理

10.1. Decision Central でのコンテナー起動、停止、および削除

10.2. Decision Central でのコンテナー更新

10.3. 複数コンテナーの管理

パート V. Red Hat Business Optimizer REST API の設定

第11章 ナレッジストア REST API

11.1. ジョブコール

11.2. 組織単位コール

11.3. リポジトリーコール

パート VI. Decision Server を実行するための REST API

第12章 Decision Server 用 REST API

12.1. Red Hat Decision Manager コマンド

第13章 Red Hat Business Optimizer REST API の設定

13.1. [GET] /containers

13.2. [PUT] /containers/{containerId}/solvers/{solverId}

13.3. [GET] /containers/{containerId}/solvers

13.4. [GET] /containers/{containerId}/solvers/{solverId}

13.5. [POST] /containers/{containerId}/solvers/{solverId}/state/solving

13.6. [POST] /containers/{containerId}/solvers/{solverId}/state/terminating-early

13.7. [GET] /containers/{containerId}/solvers/{solverId}/bestsolution

13.8. [POST] /containers/{containerId}/solvers/{solverId}/problemfactchanges

13.9. [GET] /containers/{containerId}/solvers/{solverId}/problemfactchanges/processed

13.10. [DELETE] /containers/{containerId}/solvers/{solverId}

パート VII. オーサープランニング用アセットおよびソルバーの作成

第14章 Decision Central でのソルバー作成

14.1. ソルバー終了の設定

第15章 Red Hat Business Optimizer ドメインエディターおよびオーサープランニングアセット

第16章 プランニングエンティティー難易度比較子の設定

第17章 ガイド付きルールデザイナーを使用したスコア制約の定義

付録A バージョン情報

法律上の通知

第2章プランニングの問題とは

第4章アプリケーションへの Red Hat Business Optimizer エンジンのインストール

第8章管理対象 Decision Server

第9章コンテナーの作成

第11章ナレッジストア REST API

第16章プランニングエンティティー難易度比較子の設定

第17章ガイド付きルールデザイナーを使用したスコア制約の定義