IDE を使用した Red Hat Business Optimizer 向け従業員勤務表スターターアプリケーションの実行および変更
ガイド
概要
はじめに
ビジネスルールの作成者は、IDE を使用して Red Hat Business Optimizer 機能を使用する optaweb-employee-rostering スターターアプリケーションのビルド、実行、および変更が可能です。
前提条件
- Red Hat CodeReady Studio、IntelliJ IDEA などの統合開発環境を使用すること。
- Java 言語を理解していること。
- React および TypeScript を理解していること。この要件は、OptaWeb UI を開発するために必要です。
第1章 従業員勤務表スターターアプリケーションの概要
従業員勤務表スターターアプリケーションは、組織内のさまざまな場所に従業員を割り当てます。たとえば、アプリケーションを使用して、病院での看護師のシフト、さまざまな場所での警備勤務シフト、作業者の組み立てラインのシフトを割り当てます。
従業員勤務表を最適化するには、多くの変数を考慮する必要があります。たとえば、業務が異なれば、求められるスキルが異なります。また、従業員の中には、特定の時間帯に勤務できない場合や、特定の時間帯での勤務を希望する場合があります。さらに、従業員によっては、1 回に就業できる時間に制限がある契約を交わしている可能性があります。
このスターターアプリケーションの Red Hat Business Optimizer ルールは、ハード制約およびソフト制約を使用します。最適化時に、従業員が勤務できない (または病欠の) 場合や、ある 1 つのシフト内の 2 つのスポットで働くことができない場合など、プランニングエンジンはハード制約に違反することができません。プランニングエンジンは、ソフト制約 (特定のシフトで勤務しないという従業員の希望など) に順守しようとしますが、最適なソリューションには違反が必要だと判断した場合は、違反することができます。
第2章 従業員勤務表スターターアプリケーションの構築と実行
ソースコードから従業員勤務表スターターアプリケーションを構築して、JAR ファイルとして実行します。
または、Eclipse (Red Hat JBoss CodeReady Studio を含む) などの IDE を使用して、アプリケーションを構築し、実行します。
2.1. デプロイメントファイルの準備
デプロイメントファイルをダウンロードし、準備してから、アプリケーションの構築、デプロイを行う必要があります。
手順
-
Red Hat Decision Manager 7.8 の Software Downloads ページから
rhdm-7.8.0-reference-implementation.zipファイルをダウンロードします。 - ダウンロードしたアーカイブを展開します。
-
jboss-rhba-7.8.0.GA-maven-repository/maven-repositoryサブディレクトリーの内容を~/.m2/repositoryディレクトリーにコピーします。 アドオンアーカイブから展開した
rhdm-7.8.0-employee-rostering.zipファイルを展開します。optaweb-employee-rostering-distribution-7.39.0.Final-redhat-00005ディレクトリーが作成されます。このディレクトリーは、後述する例でベースとなるディレクトリーです。注記ファイルおよびディレクトリーの名前で使用されるバージョン番号は、本書で使用するバージョンよりも新しい場合があります。
2.2. 従業員勤務表スターターアプリケーションの JAR ファイル実行
参照実装ダウンロードに含まれる JAR ファイルから、従業員勤務表スターターアプリケーションを実行します。
前提条件
-
「デプロイメントファイルの準備」 の記載どおりに、
rhdm-7.8.0-reference-implementation.zipファイルをダウンロードして展開している。 - Java 開発キットがインストールされている。
- Maven がインストールされている。
- ホストからインターネットにアクセスできる。ビルドプロセスは、インターネットを使用して、外部のリポジトリーから Maven パッケージをダウンロードします。
手順
-
端末で、
sourcesディレクトリーに移動します。 以下のコマンドを入力します。
mvn clean install -DskipTests
- ビルドプロセスが完了するまで待ちます。
-
optaweb-employee-rostering-distribution-7.39.0.Final-redhat-00005/sources/optaweb-employee-rostering-standalone/targetディレクトリーに移動します。 以下のコマンドを実行して、従業員勤務 JAR ファイルを実行します。
java -jar optaweb-employee-rostering-standalone-*-exec.jar
注記このコマンドで、非実稼働データベースを使用する従業員勤務表アプリケーションを起動します。実稼働データベースを使用する従業員勤務表を起動するには、上記のコマンドに
--spring.profiles.active=productionの引数を指定してください。-
アプリケーションにアクセスするには、Web ブラウザーで
http://localhost:8080/と入力します。
2.3. Maven を使用した従業員勤務表スターターアプリケーションの構築と実行
コマンドラインを使用して、従業員勤務表スターターアプリケーションを構築し、実行することができます。
この手順を使用する場合は、データはメモリーに保存されるため、サーバーが停止するとデータが失われます。データベースサーバーを使用してアプリケーションを構築し、実行して永続的に保存する方法は、「コマンドラインからの永続データストレージを使用した従業員勤務表スターターアプリケーションの構築と実行」 を参照してください。
前提条件
- 「デプロイメントファイルの準備」 の説明に従ってデプロイメントファイルを準備しておく。
- Java 開発キットがインストールされている。
- Maven がインストールされている。
- ホストからインターネットにアクセスできる。ビルドプロセスは、インターネットを使用して、外部のリポジトリーから Maven パッケージをダウンロードします。
手順
-
optaweb-employee-rostering-backendディレクトリーに移動します。 以下のコマンドを入力します。
mvn spring-boot:run
-
optaweb-employee-rostering-frontendディレクトリーに移動します。 以下のコマンドを入力します。
npm start
注記npmを使用してサーバーを起動すると、npmによりコードの変更が監視されます。-
アプリケーションにアクセスするには、Web ブラウザーで
http://localhost:3000/と入力します。
2.4. コマンドラインからの永続データストレージを使用した従業員勤務表スターターアプリケーションの構築と実行
コマンドラインで従業員勤務表スターターアプリケーションを構築し、実行する場合には、データベースサーバーを指定して、永続的にデータを保存することができます。
前提条件
- 「デプロイメントファイルの準備」 の説明に従ってデプロイメントファイルを準備しておく。
- Java 開発キットがインストールされている。
- Maven がインストールされている。
- ホストからインターネットにアクセスできる。ビルドプロセスは、インターネットを使用して、外部のリポジトリーから Maven パッケージをダウンロードします。
- MySQL または PostrgeSQL データベースサーバーがデプロイされている。
手順
-
端末で、
optaweb-employee-rostering-standalone/targetディレクトリーに移動します。 以下のコマンドを実行して、従業員勤務 JAR ファイルを実行します。
java -jar optaweb-employee-rostering-standalone-*-exec.jar --spring.profiles.active=production spring.datasource.url=<DATABASE_URL> --spring.datasource.username=<DATABASE_USER> --spring.datasource.password=<DATABASE_PASSWORD>
上記の例で、以下のプレースホルダーを置き換えてください。
-
<DATABASE_URL>:jdbc:postgresql://postgresql:5432/MY_DATABASEなどのデータベースに接続する URL -
<DATABASE_USER>: データベースに接続するユーザー -
<DATABASE_PASSWORD>:<DATABASE_USER>のパスワード
-
2.5. IntelliJ IDEA を使用した従業員勤務表スターターアプリケーションの構築および実行
IntelliJ IDEA を使用して、従業員勤務表スターターアプリケーションを構築し、実行することができます。
前提条件
- Employee Rostering GitHub ページから従業員勤務表のソースコードをダウンロードしている。
- IntelliJ IDEA、Maven、および Node.js がインストールされている。
- ホストからインターネットにアクセスできる。ビルドプロセスは、インターネットを使用して、外部のリポジトリーから Maven パッケージをダウンロードします。
手順
- IntelliJ IDEA を起動します。
- IntelliJ IDEA メインメニューから File → Open を選択します。
- アプリケーションソースの root ディレクトリーを選択し、OK をクリックします。
- メインメニューから Run → Edit Configurations を選択します。
- 表示されるウインドウで Templates を展開し、Maven を選択します。Maven サイドバーが表示されます。
-
Maven サイドバーの Working Directory メニューから
optaweb-employee-rostering-backendを選択します。 -
コマンドライン で
spring-boot:runと入力します。 - バックエンドを起動するには、OK をクリックします。
-
端末で、
optaweb-employee-rostering-frontendディレクトリーに移動します。 以下のコマンドを入力して、フロントエンドを起動します。
npm start
-
アプリケーションにアクセスするには、Web ブラウザーで
http://localhost:3000/と入力します。
第3章 従業員勤務表スターターアプリケーションのソースコードに関する概要
従業員勤務表スターターアプリケーションは、以下の主要コンポーネントで設定されています。
-
Red Hat Business Optimizer を使用して勤務表のロジックを実装し、REST API を提供する
backend -
React を使用してユーザーインターフェイスを実装し、REST API で
backendモジュールと対話するfrontendモジュール
上記のコンポーネントを個別にビルドして使用することができます。特に、異なるユーザーインターフェイスを実装して、REST API でサーバーを呼び出すことができます。
主なコンポーネント 2 つに加え、従業員勤務表テンプレートには、ランダムなソースデータのジェネレーター (デモやテスト目的で便利) やベンチマークアプリケーションが含まれます。
モジュールおよび主要なクラス
従業員勤務表テンプレートの Java ソースコードには複数の Maven モジュールが含まれます。これらのモジュールごとに、個別の Maven プロジェクトファイル (pom.xml) が含まれていますが、これは共通のプロジェクトで構築するために設計されています。
モジュールには、Java クラスなど複数のファイルが含まれます。このドキュメントでは、全モジュールと、従業員勤務表計算の主な情報を含むその他のファイルとクラスをリストします。
-
optawebpemployee-rostering-benchmarkモジュール: 乱数データを生成し、ソリューションをベンチマーク化する追加のアプリケーションが含まれます。 -
optaweb-employee-rostering-distributionモジュール: README ファイルが含まれます。 -
optaweb-employee-rostering-docsモジュール: ドキュメントファイルが含まれます。 -
optaweb-employee-rostering-frontendモジュール: React で開発したユーザーインターフェイスを使用するクライアントアプリケーションが含まれます。 optaweb-employee-rostering-backendモジュール: Red Hat Business Optimizer を使用して勤務表の計算を行うサーバーアプリケーションが含まれます。-
src/main/java/org.optaweb.employeerostering.service.roster/rosterGenerator.java: デモおよびテスト目的でランダムな入力データを生成します。必要な入力データを変更する場合には、ジェネレーターも合わせて変更してください。 -
src/main/java/org.optaweb.employeerostering.domain.employee/EmployeeAvailability.java: 従業員の空き情報を定義します。時間枠ごとに、従業員の空き状況と、従業員の希望する時間枠を指定できます。 -
src/main/java/org.optaweb.employeerostering.domain.employee/Employee.java: 従業員を定義します。従業員には名前とスキル一覧があり、契約に従って仕事に従事します。スキルは、スキルオブジェクトで表現します。 -
src/main/java/org.optaweb.employeerostering.domain.roster/Roster.java: 計算済みの勤務表情報を定義します。 -
src/main/java/org.optaweb.employeerostering.domain.shift/Shift.java: 従業員を割り当て可能なシフトを定義します。シフトは、時間枠とスポットで定義します。たとえば、レストランでは、Kitchen のスポットで、2 月 20 日 8AM ~ 4PM の時間枠のシフトなどがあります。複数のシフトを、特定のスポットと時間枠に定義できます。今回の例では、このスポットと時間枠には複数の従業員が必要です。 -
src/main/java/org.optaweb.employeerostering.domain.skill/Skill.java: 従業員に割り当て可能なスキルを定義します。 -
src/main/java/org.optaweb.employeerostering.domain.spot/Spot.java: 従業員を配置可能なスポットを定義します。たとえば、Kitchenをスポットとして指定できます。 -
src/main/java/org.optaweb.employeerostering.domain.contract/Contract.java: さまざまな期間の従業員の労働時間を制限する契約を定義します。 -
src/main/java/org.optaweb.employeerostering.domain.tenant/Tenant.java: テナントを定義します。テナントごとに、独立したデータセットを表します。あるテナントのデータが変更されても、他のテナントには影響がありません。 -
*View.java: ドメインオブジェクト関連のクラス。他の情報から計算する値のセットを定義します。クライアントアプリケーションは、REST API 経由でこれらの値を読み取りますが、書き込みはできません。 -
*Service.java: サービスパッケージに配置されるインターフェイスで REST API を定義します。サーバーとクライアントアプリケーションのいずれも、これらのインターフェイスの実装を個別に定義します。
-
第4章 従業員勤務表スターターアプリケーションの変更
従業員勤務表スターターアプリケーションをニーズに合わせて変更するには、最適化プロセスを統括するルールを変更する必要があります。また、データ構造に必要なデータを含み、ルールに必要な計算が提供されるようにする必要があります。必要なデータがユーザーインターフェイスに存在しない場合は、ユーザーインターフェイスも変更する必要があります。
以下の手順では、従業員勤務表スターターアプリケーションの変更に関する一般的なアプローチを説明しています。
前提条件
- アプリケーションを正常にビルドするビルド環境がある。
- Java コードの読み取りと変更ができる。
手順
必要な変更をプランニングします。以下の質問に答えてください。
- 回避する 必要 がある追加のシナリオは何ですか。これらのシナリオは ハード制約 です。
- 可能な場合は、Optimizer が 回避しなければ ならない追加のシナリオは何ですか。これらのシナリオは ソフト制約 です。
- それぞれのシナリオがソリューションで実行されるかどうかを計算するのに必要なデータは何ですか。
- 既存のバージョンで入力した情報から取得可能なデータはどれですか。
- ハードコードが可能なデータはどれですか。
- ユーザー入力が必要なデータと、現在のバージョンで入力されていないデータはどれですか。
- 必須データを現在のデータから計算するか、ハードコード化できる場合は、計算か、ハードコードを既存のビューまたはユーティリティークラスに追加します。データをサーバー側で計算する必要がある場合は、REST API エンドポイントを追加して読み込みます。
-
ユーザーが必須データを入力する必要がある場合は、データのエントリーを表現するクラスにそのデータを追加 (例:
Employeeクラス) し、データの読み取り、および書き込み用に REST API エンドポイントを追加して、データ入力用にユーザーインターフェイスを変更してください。 全データが利用できる場合は、ルールを変更します。変更の大半は、新規ルールを追加する必要があります。これらのルールは、
optaweb-employee-rostering-backendモジュールのsrc/main/resources/org/optaweb/employeerostering/service/solver/employeeRosteringScoreRules.drlファイルに配置されます。ルールには、Drools 言語を使用します。Drools ルール言語に関する参考情報は、DRL ルールを使用したデシジョンサービスの作成 を参照してください。
optaweb-employee-rostering-backendモジュールで定義したクラスは、デシジョンエンジンで利用できます。- アプリケーションの変更後に、ビルドして実行します。
付録A バージョン情報
本書の最終更新日: 2022 年 3 月 8 日 (火)
