手順

1. Business Central で、Menu → Design → Projects に移動して、プロジェクト名をクリックします。
2. プロジェクトの Settings タブをクリックし、Validation をクリックしてリポジトリーの一覧を開きます。

3. 一覧表示したリポジトリーオプションの中から選択するか選択を解除して、重複した GAV の検出を有効または無効にします。

   今後、重複した GAV の報告は、検証を有効にしたリポジトリーに対してのみ行われます。

   注記

   この機能を無効にするには、システムの起動時に Business Central の org.guvnor.project.gav.check.disabled システムプロパティーを true に設定します。

   $ ~/EAP_HOME/bin/standalone.sh -c standalone-full.xml
   -Dorg.guvnor.project.gav.check.disabled=true

手順

1. 1 台目のコンピューターで、インタラクティブモードまたは CLI モードでインストーラーを実行します。詳細は Red Hat JBoss EAP 7.3 への Red Hat Process Automation Manager のインストールおよび設定 を参照してください。
2. Component Selection ページで、KIE Server チェックボックスを外します。
3. Business Central インストールを完了します。
4. 2 台目のコンピューターで、インタラクティブモードまたは CLI モードでインストーラーを実行します。
5. Component Selection ページで Business Central チェックボックスを外します。
6. Configure Runtime Environment ページで Perform Advanced Configuration を選択します。
7. Customize KIE Server properties を選択し、Next をクリックします。

8. Business Central のコントローラー URL を入力し、KIE Server に追加のプロパティーを設定します。コントローラー URL は、以下の形式を取ります。<HOST:PORT> は、2 台目のコンピューターの Business Central のアドレスに置き換えます。

   <HOST:PORT>/business-central/rest/controller

9. インストールを完了します。
10. Process Automation Manager コントローラーが Business Central と統合されていることを確認するには、Business Central の Execution Servers ページに移動して、設定した KIE Server が REMOTE SERVERS に表示されていることを確認します。

手順

1. Red Hat カスタマーポータルの Software Downloads ページに移動し (ログインが必要)、ドロップダウンオプションから製品およびバージョンを選択します。

   • 製品: Process Automation Manager
   • バージョン: 7.10
2. Red Hat Process Automation Manager 7.10.0 Add Ons (rhpam-7.10.0-add-ons.zip ファイル) をダウンロードします。
3. rhpam-7.10.0-add-ons.zip ファイルを展開します。rhpam-7.10.0-controller-ee7.zip ファイルは展開したディレクトリーにあります。
4. rhpam-7.10.0-controller-ee7 アーカイブを一時ディレクトリーに展開します。以下の例では、この名前を TEMP_DIR とします。

5. TEMP_DIR/rhpam-7.10.0-controller-ee7/controller.war ディレクトリーを EAP_HOME/standalone/deployments/ にコピーします。

   警告

   コピーするヘッドレス Process Automation Manager コントローラーデプロイメントの名前が、Red Hat JBoss EAP インスタンスの既存デプロイメントと競合しないことを確認します。

6. TEMP_DIR/rhpam-7.10.0-controller-ee7/SecurityPolicy/ ディレクトリーの内容を EAP_HOME/bin にコピーします。
7. ファイルの上書きを求めるプロンプトが出されたら、Yes を選択します。
8. EAP_HOME/standalone/deployments/ ディレクトリーに、controller.war.dodeploy という名前で空のファイルを作成します。このファイルにより、サーバーが起動するとヘッドレス Process Automation Manager コントローラーが自動的にデプロイされます。

手順

1. ターミナルアプリケーションで EAP_HOME/bin に移動します。

2. ヘッドレス Process Automation Manager コントローラーを、KIE Server をインストールした Red Hat JBoss EAP インスタンスと同じ Red Hat JBoss EAP インスタンスにインストールしている場合は、以下のいずれかのコマンドを実行します。

   • Linux または UNIX ベースのシステムの場合:

     $ ./standalone.sh -c standalone-full.xml

   • Windows の場合:

     standalone.bat -c standalone-full.xml

3. ヘッドレス Process Automation Manager コントローラーを、KIE Server をインストールした Red Hat JBoss EAP インスタンスとは別の Red Hat JBoss EAP インスタンスにインストールしている場合は、standalone.sh スクリプトで Process Automation Manager コントローラーを開始します。

   注記

   この場合は、standalone.xml ファイルに必要な設定変更を加えます。

   • Linux または UNIX ベースのシステムの場合:

     $ ./standalone.sh

   • Windows の場合:

     standalone.bat

4. ヘッドレス Process Automation Manager コントローラーが Red Hat JBoss EAP 上で動作していることを確認するには、以下のコマンドを入力します。<CONTROLLER> はユーザー名で、<CONTROLLER_PWD> はパスワードになります。このコマンドにより、KIE Server インスタンスに関する情報が出力されます。

   curl -X GET "http://<HOST>:<PORT>/controller/rest/controller/management/servers" -H  "accept: application/xml" -u '<CONTROLLER>:<CONTROLLER_PWD>'

手順

1. Red Hat カスタマーポータルの Software Downloads ページに移動し (ログインが必要)、ドロップダウンオプションから製品およびバージョンを選択します。

   • Product: Process Automation Manager
   • Version: 7.10
2. Red Hat Process Automation Manager 7.10.0 Add Ons (rhpam-7.10.0-add-ons.zip ファイル) をダウンロードします。
3. rhpam-7.10.0-add-ons.zip ファイルを展開します。rhpam-7.10.0-controller-ee7.zip ファイルは展開したディレクトリーにあります。
4. rhpam-7.10.0-controller-ee7 アーカイブを一時ディレクトリーに展開します。以下の例では、この名前を TEMP_DIR とします。

5. TEMP_DIR/rhpam-7.10.0-controller-ee7/controller.war ディレクトリーを EAP_HOME/standalone/deployments/ にコピーします。

   警告

   コピーするヘッドレス Process Automation Manager コントローラーデプロイメントの名前が、Red Hat JBoss EAP インスタンスの既存デプロイメントと競合しないことを確認します。

6. TEMP_DIR/rhpam-7.10.0-controller-ee7/SecurityPolicy/ ディレクトリーの内容を EAP_HOME/bin にコピーします。
7. ファイルの上書きを求めるプロンプトが出されたら、Yes をクリックします。
8. EAP_HOME/standalone/deployments/ ディレクトリーに、controller.war.dodeploy という名前で空のファイルを作成します。このファイルにより、サーバーが起動するとヘッドレス Process Automation Manager コントローラーが自動的にデプロイされます。
9. テキストエディターで EAP_HOME/standalone/configuration/standalone.xml ファイルを開きます。

10. 以下のプロパティーを <system-properties> 要素に追加し、<NFS_STORAGE> を、テンプレート設定が保存されている NFS ストレージへの絶対パスに置き換えます。

    <system-properties>
      <property name="org.kie.server.controller.templatefile.watcher.enabled" value="true"/>
      <property name="org.kie.server.controller.templatefile" value="<NFS_STORAGE>"/>
    </system-properties>

    テンプレートファイルには、特定のデプロイメントシナリオのデフォルト設定が含まれます。

    org.kie.server.controller.templatefile.watcher.enabled プロパティーの値を true に設定すると、別のスレッドが開始してテンプレートファイルの修正を監視します。この確認の間隔はデフォルトで 30000 ミリ秒になり、org.kie.server.controller.templatefile.watcher.interval システムプロパティーで制御できます。このプロパティーの値を false に設定すると、テンプレートファイルへの変更の検出が、サーバーの再起動時に制限されます。

11. ヘッドレス Process Automation Manager コントローラーを開始するには、EAP_HOME/bin に移動して、以下のコマンドを実行します。

    • Linux または UNIX ベースのシステムの場合:

      $ ./standalone.sh

    • Windows の場合:

      standalone.bat

手順

1. プロジェクトのデプロイメント記述子設定を開くには、Business Central で Menu → Design → $PROJECT_NAME → Settings → Deployments の順に選択します。
2. 設定一覧から、Required Roles をクリックし、次に Add Required Role をクリックします。
3. Add Required Role ウィンドウで、このデプロイメントにアクセスをするパーミッションのロール名を入力し、Add をクリックします。
4. デプロイメントにアクセスする権限を持つロールをさらに追加するには、前の手順を繰り返します。
5. すべてのロールを追加したら、Save をクリックします。

手順

1. Business Central で、Menu → Manage → Execution Errors の順に移動します。
2. 一覧からエラーを選択し、Details タブを開きます。これにより、エラーに関する情報が表示されます。

3. Acknowledge ボタンをクリックして、エラーを承認して削除します。Manage Execution Errors ページの Acknowledged フィルターで Yes を選択すれば、後からそのエラーを表示できます。

   エラーがタスクに関連する場合は、Go to Task ボタンが表示されます。

4. 該当する場合は、Go to Task ボタンをクリックして、Manage Tasks ページに、関連するジョブ情報を表示します。

   Manage Tasks ページでは、対応するタスクの再起動、再スケジュール、または再試行を行うことができます。

1. タスク
2. Process
3. Job
4. DB

手順

1. Business Central で、Menu → Manage → Jobs の順にクリックします。
2. 画面右上の New Job をクリックします。
3. Business Key フィールドにプロセス相関キーを入力します。
4. Type フィールドに上記のリストから自動承認ジョブタイプを追加します。

5. Due On でジョブの完了時間を選択します。

   1. ジョブをすぐに実行する場合は、Run now オプションを選択します。

   2. 特定の時間にジョブを実行する場合は、Run later を選択します。Run later オプションの横に日時フィールドが表示されます。フィールドをクリックしてカレンダーを開き、ジョブの特定の日時をスケジュールします。

      
6. Create をクリックしてジョブを作成し、Manage Jobs ページに戻ります。

1. Advanced タブをクリックします。
2. Add Parameter ボタンをクリックします。

3. ジョブに適用する設定パラメーターを入力します。

   1. SingleRun: true または false
   2. NextRun: 2h、5d、1m などの時間表示。

   3. EmfName: カスタムのエンティティーマネージャーファクトリーの名前。

      

手順

1. KIE Server インスタンスで、org.kie.prometheus.server.ext.disabled システムプロパティーを false に設定して、Prometheus 拡張機能を有効にします。このプロパティーは、KIE Server の起動時、または Red Hat Process Automation Manager ディストリビューションの standalone.xml ファイルまたは standalone-full.xml ファイルで定義できます。

2. Spring Boot で Red Hat Process Automation Manager を実行する場合は、application.properties システムプロパティーで必要なキーを設定します。

   Red Hat Process Automation Manager および Prometheus の Spring Boot application.properties キー

   kieserver.jbpm.enabled=true
   kieserver.drools.enabled=true
   kieserver.dmn.enabled=true
   kieserver.prometheus.enabled=true

3. Prometheus ディストリビューションの prometheus.yaml ファイルで、scrape_configs セクションに以下の設定を追加して、Prometheus が KIE Server からメトリクスを収集 (scrape) するように設定します。

   prometheus.yaml ファイルの Scrape 設定

   scrape_configs:
     - job_name: 'kie-server'
       metrics_path: /SERVER_PATH/services/rest/metrics
       basicAuth:
         username: USER_NAME
         password: PASSWORD
       static_configs:
         - targets: ["HOST:PORT"]

   Spring Boot の prometheus.yaml ファイルでの Scrape 設定 (該当する場合)

   scrape_configs:
     - job_name: 'kie'
       metrics_path: /rest/metrics
       static_configs:
         - targets: ["HOST:PORT"]

   KIE Server の場所と設定に合わせて、値を置き換えます。

4. KIE Server インスタンスを起動します。

   Red Hat JBoss EAP での Red Hat Process Automation Manager の起動コマンド例

   $ cd ~/EAP_HOME/bin
   $ ./standalone.sh --c standalone-full.xml

   設定済みの KIE Server インスタンスを起動すると、Prometheus はメトリクスの収集を開始し、KIE Server はメトリクスを REST API エンドポイント http://HOST:PORT/SERVER/services/rest/metrics (または Spring Boot では http://HOST:PORT/rest/metrics) に公開します。

5. REST クライアントまたは curl ユーティリティーで、以下のコンポーネントを含む REST API 要求を送信し、KIE Server がメトリクスを公開していることを確認します。

   REST クライアントの場合:

   • Authentication: kie-server ロールを持つ KIE Server ユーザーのユーザー名とパスワードを入力します。

   • HTTP Headers: 以下のヘッダーを設定します。

     • Accept: application/json
   • HTTP method: GET に設定します。
   • URL: KIE Server REST API ベース URL とメトリクスエンドポイントを入力します。たとえば、http://localhost:8080/kie-server/services/rest/metrics (または Spring Boot では http://localhost:8080/rest/metrics) となります。

   curl ユーティリティーの場合:

   • -u: kie-server ロールを持つ KIE Server ユーザーのユーザー名とパスワードを入力します。

   • -H: 以下のヘッダーを設定します。

     • accept: application/json
   • -X: GET に設定します。
   • URL: KIE Server REST API ベース URL とメトリクスエンドポイントを入力します。たとえば、http://localhost:8080/kie-server/services/rest/metrics (または Spring Boot では http://localhost:8080/rest/metrics) となります。

   Red Hat JBoss EAP での Red Hat Process Automation Manager の curl コマンド例

   curl -u 'baAdmin:password@1' -X GET "http://localhost:8080/kie-server/services/rest/metrics"

   Spring Boot での Red Hat Process Automation Manager の curl コマンド例

   curl -u 'baAdmin:password@1' -X GET "http://localhost:8080/rest/metrics"

   サーバーの応答例

   # HELP kie_server_container_started_total Kie Server Started Containers
   # TYPE kie_server_container_started_total counter
   kie_server_container_started_total{container_id="task-assignment-kjar-1.0",} 1.0
   # HELP solvers_running Number of solvers currently running
   # TYPE solvers_running gauge
   solvers_running 0.0
   # HELP dmn_evaluate_decision_nanosecond DMN Evaluation Time
   # TYPE dmn_evaluate_decision_nanosecond histogram
   # HELP solver_duration_seconds Time in seconds it took solver to solve the constraint problem
   # TYPE solver_duration_seconds summary
   solver_duration_seconds_count{solver_id="100tasks-5employees.xml",} 1.0
   solver_duration_seconds_sum{solver_id="100tasks-5employees.xml",} 179.828255925
   solver_duration_seconds_count{solver_id="24tasks-8employees.xml",} 1.0
   solver_duration_seconds_sum{solver_id="24tasks-8employees.xml",} 179.995759653
   # HELP drl_match_fired_nanosecond Drools Firing Time
   # TYPE drl_match_fired_nanosecond histogram
   # HELP dmn_evaluate_failed_count DMN Evaluation Failed
   # TYPE dmn_evaluate_failed_count counter
   # HELP kie_server_start_time Kie Server Start Time
   # TYPE kie_server_start_time gauge
   kie_server_start_time{name="myapp-kieserver",server_id="myapp-kieserver",location="http://myapp-kieserver-demo-monitoring.127.0.0.1.nip.io:80/services/rest/server",version="7.4.0.redhat-20190428",} 1.557221271502E12
   # HELP kie_server_container_running_total Kie Server Running Containers
   # TYPE kie_server_container_running_total gauge
   kie_server_container_running_total{container_id="task-assignment-kjar-1.0",} 1.0
   # HELP solver_score_calculation_speed Number of moves per second for a particular solver solving the constraint problem
   # TYPE solver_score_calculation_speed summary
   solver_score_calculation_speed_count{solver_id="100tasks-5employees.xml",} 1.0
   solver_score_calculation_speed_sum{solver_id="100tasks-5employees.xml",} 6997.0
   solver_score_calculation_speed_count{solver_id="24tasks-8employees.xml",} 1.0
   solver_score_calculation_speed_sum{solver_id="24tasks-8employees.xml",} 19772.0
   # HELP kie_server_case_started_total Kie Server Started Cases
   # TYPE kie_server_case_started_total counter
   kie_server_case_started_total{case_definition_id="itorders.orderhardware",} 1.0
   # HELP kie_server_case_running_total Kie Server Running Cases
   # TYPE kie_server_case_running_total gauge
   kie_server_case_running_total{case_definition_id="itorders.orderhardware",} 2.0
   # HELP kie_server_data_set_registered_total Kie Server Data Set Registered
   # TYPE kie_server_data_set_registered_total gauge
   kie_server_data_set_registered_total{name="jbpmProcessInstanceLogs::CUSTOM",uuid="jbpmProcessInstanceLogs",} 1.0
   kie_server_data_set_registered_total{name="jbpmRequestList::CUSTOM",uuid="jbpmRequestList",} 1.0
   kie_server_data_set_registered_total{name="tasksMonitoring::CUSTOM",uuid="tasksMonitoring",} 1.0
   kie_server_data_set_registered_total{name="jbpmHumanTasks::CUSTOM",uuid="jbpmHumanTasks",} 1.0
   kie_server_data_set_registered_total{name="jbpmHumanTasksWithUser::FILTERED_PO_TASK",uuid="jbpmHumanTasksWithUser",} 1.0
   kie_server_data_set_registered_total{name="jbpmHumanTasksWithVariables::CUSTOM",uuid="jbpmHumanTasksWithVariables",} 1.0
   kie_server_data_set_registered_total{name="jbpmProcessInstancesWithVariables::CUSTOM",uuid="jbpmProcessInstancesWithVariables",} 1.0
   kie_server_data_set_registered_total{name="jbpmProcessInstances::CUSTOM",uuid="jbpmProcessInstances",} 1.0
   kie_server_data_set_registered_total{name="jbpmExecutionErrorList::CUSTOM",uuid="jbpmExecutionErrorList",} 1.0
   kie_server_data_set_registered_total{name="processesMonitoring::CUSTOM",uuid="processesMonitoring",} 1.0
   kie_server_data_set_registered_total{name="jbpmHumanTasksWithAdmin::FILTERED_BA_TASK",uuid="jbpmHumanTasksWithAdmin",} 1.0
   # HELP kie_server_execution_error_total Kie Server Execution Errors
   # TYPE kie_server_execution_error_total counter
   # HELP kie_server_task_completed_total Kie Server Completed Tasks
   # TYPE kie_server_task_completed_total counter
   # HELP kie_server_container_running_total Kie Server Running Containers
   # TYPE kie_server_container_running_total gauge
   kie_server_container_running_total{container_id="itorders_1.0.0-SNAPSHOT",} 1.0
   # HELP kie_server_job_cancelled_total Kie Server Cancelled Jobs
   # TYPE kie_server_job_cancelled_total counter
   # HELP kie_server_process_instance_started_total Kie Server Started Process Instances
   # TYPE kie_server_process_instance_started_total counter
   kie_server_process_instance_started_total{container_id="itorders_1.0.0-SNAPSHOT",process_id="itorders.orderhardware",} 1.0
   # HELP solver_duration_seconds Time in seconds it took solver to solve the constraint problem
   # TYPE solver_duration_seconds summary
   # HELP kie_server_task_skipped_total Kie Server Skipped Tasks
   # TYPE kie_server_task_skipped_total counter
   # HELP kie_server_data_set_execution_time_seconds Kie Server Data Set Execution Time
   # TYPE kie_server_data_set_execution_time_seconds summary
   kie_server_data_set_execution_time_seconds_count{uuid="jbpmProcessInstances",} 8.0
   kie_server_data_set_execution_time_seconds_sum{uuid="jbpmProcessInstances",} 0.05600000000000001
   # HELP kie_server_job_scheduled_total Kie Server Started Jobs
   # TYPE kie_server_job_scheduled_total counter
   # HELP kie_server_data_set_execution_total Kie Server Data Set Execution
   # TYPE kie_server_data_set_execution_total counter
   kie_server_data_set_execution_total{uuid="jbpmProcessInstances",} 8.0
   # HELP kie_server_process_instance_completed_total Kie Server Completed Process Instances
   # TYPE kie_server_process_instance_completed_total counter
   # HELP kie_server_job_running_total Kie Server Running Jobs
   # TYPE kie_server_job_running_total gauge
   # HELP kie_server_task_failed_total Kie Server Failed Tasks
   # TYPE kie_server_task_failed_total counter
   # HELP kie_server_task_exited_total Kie Server Exited Tasks
   # TYPE kie_server_task_exited_total counter
   # HELP dmn_evaluate_decision_nanosecond DMN Evaluation Time
   # TYPE dmn_evaluate_decision_nanosecond histogram
   # HELP kie_server_data_set_lookups_total Kie Server Data Set Running Lookups
   # TYPE kie_server_data_set_lookups_total gauge
   kie_server_data_set_lookups_total{uuid="jbpmProcessInstances",} 0.0
   # HELP kie_server_process_instance_duration_seconds Kie Server Process Instances Duration
   # TYPE kie_server_process_instance_duration_seconds summary
   # HELP kie_server_case_duration_seconds Kie Server Case Duration
   # TYPE kie_server_case_duration_seconds summary
   # HELP dmn_evaluate_failed_count DMN Evaluation Failed
   # TYPE dmn_evaluate_failed_count counter
   # HELP kie_server_task_added_total Kie Server Added Tasks
   # TYPE kie_server_task_added_total counter
   kie_server_task_added_total{deployment_id="itorders_1.0.0-SNAPSHOT",process_id="itorders.orderhardware",task_name="Prepare hardware spec",} 1.0
   # HELP drl_match_fired_nanosecond Drools Firing Time
   # TYPE drl_match_fired_nanosecond histogram
   # HELP kie_server_container_started_total Kie Server Started Containers
   # TYPE kie_server_container_started_total counter
   kie_server_container_started_total{container_id="itorders_1.0.0-SNAPSHOT",} 1.0
   # HELP kie_server_process_instance_sla_violated_total Kie Server Process Instances SLA Violated
   # TYPE kie_server_process_instance_sla_violated_total counter
   # HELP kie_server_task_duration_seconds Kie Server Task Duration
   # TYPE kie_server_task_duration_seconds summary
   # HELP kie_server_job_executed_total Kie Server Executed Jobs
   # TYPE kie_server_job_executed_total counter
   # HELP kie_server_deployments_active_total Kie Server Active Deployments
   # TYPE kie_server_deployments_active_total gauge
   kie_server_deployments_active_total{deployment_id="itorders_1.0.0-SNAPSHOT",} 1.0
   # HELP kie_server_process_instance_running_total Kie Server Running Process Instances
   # TYPE kie_server_process_instance_running_total gauge
   kie_server_process_instance_running_total{container_id="itorders_1.0.0-SNAPSHOT",process_id="itorders.orderhardware",} 2.0
   # HELP solvers_running Number of solvers currently running
   # TYPE solvers_running gauge
   solvers_running 0.0
   # HELP kie_server_work_item_duration_seconds Kie Server Work Items Duration
   # TYPE kie_server_work_item_duration_seconds summary
   # HELP kie_server_job_duration_seconds Kie Server Job Duration
   # TYPE kie_server_job_duration_seconds summary
   # HELP solver_score_calculation_speed Number of moves per second for a particular solver solving the constraint problem
   # TYPE solver_score_calculation_speed summary
   # HELP kie_server_start_time Kie Server Start Time
   # TYPE kie_server_start_time gauge
   kie_server_start_time{name="sample-server",server_id="sample-server",location="http://localhost:8080/kie-server/services/rest/server",version="7.48.1-SNAPSHOT",} 1.557285486469E12

   KIE Server でメトリクスが利用できない場合は、このセクションで説明されている KIE Server および Prometheus の設定を確認します。

   また、http://HOST:PORT/graph の Prometheus の expression browser で収集したメトリクスと対話したり、Prometheus データソースを Grafana などのデータグラフ作成ツールと統合したりすることもできます。

   図16.1 Prometheus expression browser と KIE Server メトリクス

   

   図16.2 Prometheus expression browser と KIE Server ターゲット

   

   図16.3 Grafana ダッシュボードと DMN モデルの KIE Server メトリクス

   

   図16.4 Grafana ダッシュボードとソルバーの KIE Server メトリクス

   

   図16.5 Grafana ダッシュボードとプロセス、ケースおよびタスクの KIE Server メトリクス

   

手順

1. OpenShift 上の KIE Server デプロイメントの DeploymentConfig オブジェクトで、PROMETHEUS_SERVER_EXT_DISABLED 環境変数を false に設定して、Prometheus 拡張機能を有効にします。この変数は、OpenShift Web コンソールを使用するか、コマンド端末で oc コマンドを使用してこの変数を設定してください。

   oc set env dc/<dc_name> PROMETHEUS_SERVER_EXT_DISABLED=false -n <namespace>

   OpenShift に KIE Server をデプロイしていない場合は、OpenShift デプロイメントに使用予定の OpenShift テンプレート (例: rhpam710-prod-immutable-kieserver.yaml) で、PROMETHEUS_SERVER_EXT_DISABLED テンプレートパラメーターを false に設定して、Prometheus 拡張機能を有効にします。

   OpenShift Operator を使用して KIE Server を OpenShift にデプロイする場合は、KIE Server の設定で、PROMETHEUS_SERVER_EXT_DISABLED 環境変数を false に設定して、Prometheus 拡張機能を有効にします。

   apiVersion: app.kiegroup.org/v1
   kind: KieApp
   metadata:
     name: enable-prometheus
   spec:
     environment: rhpam-trial
     objects:
       servers:
       - env:
         - name: PROMETHEUS_SERVER_EXT_DISABLED
           value: "false"

2. service-metrics.yaml ファイルを作成して、KIE Server から Prometheus にメトリクスを公開するサービスを追加します。

   apiVersion: v1
   kind: Service
   metadata:
     annotations:
       description: RHPAM Prometheus metrics exposed
     labels:
       app: myapp-kieserver
       application: myapp-kieserver
       template: myapp-kieserver
       metrics: rhpam
     name: rhpam-app-metrics
   spec:
     ports:
       - name: web
         port: 8080
         protocol: TCP
         targetPort: 8080
     selector:
       deploymentConfig: myapp-kieserver
     sessionAffinity: None
     type: ClusterIP

3. コマンドターミナルで、oc コマンドを使用して、service-metrics.yaml ファイルを OpenShift デプロイメントに適用します。

   oc apply -f service-metrics.yaml

4. metrics-secret など、OpenShift シークレットを作成して、KIE Server の Prometheus メトリクスにアクセスします。シークレットには username 要素および password 要素と、KIE Server ユーザー資格情報が含まれている必要があります。OpenShift シークレットの詳細は、OpenShift 開発者ガイドの シークレット の章を参照してください。

5. ServiceMonitor オブジェクトを定義する service-monitor.yaml ファイルを作成します。サービスモニターにより Prometheus を KIE Server メトリクスサービスに接続できます。

   apiVersion: monitoring.coreos.com/v1
   kind: ServiceMonitor
   metadata:
     name: rhpam-service-monitor
     labels:
       team: frontend
   spec:
     selector:
       matchLabels:
         metrics: rhpam
     endpoints:
       - port: web
         path: /services/rest/metrics
         basicAuth:
           password:
             name: metrics-secret
             key: password
           username:
             name: metrics-secret
             key: username

6. コマンド端末で、oc コマンドを使用して、service-monitor.yaml ファイルを OpenShift デプロイメントに適用します。

   oc apply -f service-monitor.yaml

   上記の設定を完了すると、Prometheus はメトリクスの収集を開始し、KIE Server は REST API エンドポイント http://HOST:PORT/kie-server/services/rest/metrics にメトリクスを公開します。

   http://HOST:PORT/graph の Prometheus expression browser で収集したメトリクスと対話したり、Prometheus データソースを Grafana などのデータグラフ作成ツールと統合したりすることができます。

   Prometheus expression browser の場所のホストとポートである http://HOST:PORT/graph は、Prometheus Operator をインストールしたときに Prometheus Web コンソールを公開したルートで定義されています。OpenShift ルートの詳細は、OpenShift アーキテクチャードキュメントの ルート の章を参照してください。

   図16.6 Prometheus expression browser と KIE Server メトリクス

   

   図16.7 Prometheus expression browser と KIE Server ターゲット

   

   図16.8 Grafana ダッシュボードと DMN モデルの KIE Server メトリクス

   

   図16.9 Grafana ダッシュボードとソルバーの KIE Server メトリクス

   

   図16.10 Grafana ダッシュボードとプロセス、ケースおよびタスクの KIE Server メトリクス

   

手順

1. 空の Maven プロジェクトを作成して、以下のパッケージタイプと依存関係を、プロジェクトの pom.xml ファイルに定義します。

   サンプルプロジェクトの pom.xml ファイルの例

   <packaging>jar</packaging>
   
   <properties>
     <version.org.kie>7.48.0.Final-redhat-00004</version.org.kie>
   </properties>
   
   <dependencies>
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-api</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-api</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-services-common</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-services-drools</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-services-prometheus</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-dmn-api</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-dmn-core</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-services-api</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-executor</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.optaplanner</groupId>
       <artifactId>optaplanner-core</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>io.prometheus</groupId>
       <artifactId>simpleclient</artifactId>
       <version>0.5.0</version>
     </dependency>
   </dependencies>

2. 以下の例にあるように、カスタムの Prometheus メトリクスを定義する、カスタムのリスナークラスの一部として、org.kie.server.services.prometheus.PrometheusMetricsProvider インターフェイスを実装します。

   カスタムのリスナークラス内の DMNRuntimeEventListener リスナーの実装例

   package org.kie.server.ext.prometheus;
   
   import io.prometheus.client.Gauge;
   import org.kie.dmn.api.core.ast.DecisionNode;
   import org.kie.dmn.api.core.event.AfterEvaluateBKMEvent;
   import org.kie.dmn.api.core.event.AfterEvaluateContextEntryEvent;
   import org.kie.dmn.api.core.event.AfterEvaluateDecisionEvent;
   import org.kie.dmn.api.core.event.AfterEvaluateDecisionServiceEvent;
   import org.kie.dmn.api.core.event.AfterEvaluateDecisionTableEvent;
   import org.kie.dmn.api.core.event.BeforeEvaluateBKMEvent;
   import org.kie.dmn.api.core.event.BeforeEvaluateContextEntryEvent;
   import org.kie.dmn.api.core.event.BeforeEvaluateDecisionEvent;
   import org.kie.dmn.api.core.event.BeforeEvaluateDecisionServiceEvent;
   import org.kie.dmn.api.core.event.BeforeEvaluateDecisionTableEvent;
   import org.kie.dmn.api.core.event.DMNRuntimeEventListener;
   import org.kie.server.api.model.ReleaseId;
   import org.kie.server.services.api.KieContainerInstance;
   
   public class ExampleCustomPrometheusMetricListener implements DMNRuntimeEventListener {
   
       private final KieContainerInstance kieContainer;
   
       private final Gauge randomGauge = Gauge.build()
               .name("random_gauge_nanosecond")
               .help("Random gauge as an example of custom KIE Prometheus metric")
               .labelNames("container_id", "group_id", "artifact_id", "version", "decision_namespace", "decision_name")
               .register();
   
       public ExampleCustomPrometheusMetricListener(KieContainerInstance containerInstance) {
           kieContainer = containerInstance;
       }
   
       public void beforeEvaluateDecision(BeforeEvaluateDecisionEvent e) {
       }
   
       public void afterEvaluateDecision(AfterEvaluateDecisionEvent e) {
           DecisionNode decisionNode = e.getDecision();
           ReleaseId releaseId = kieContainer.getResource().getReleaseId();
           randomGauge.labels(kieContainer.getContainerId(), releaseId.getGroupId(),
                              releaseId.getArtifactId(), releaseId.getVersion(),
                              decisionNode.getModelName(), decisionNode.getModelNamespace())
                   .set((int) (Math.random() * 100));
       }
   
       public void beforeEvaluateBKM(BeforeEvaluateBKMEvent event) {
       }
   
       public void afterEvaluateBKM(AfterEvaluateBKMEvent event) {
       }
   
       public void beforeEvaluateContextEntry(BeforeEvaluateContextEntryEvent event) {
       }
   
       public void afterEvaluateContextEntry(AfterEvaluateContextEntryEvent event) {
       }
   
       public void beforeEvaluateDecisionTable(BeforeEvaluateDecisionTableEvent event) {
       }
   
       public void afterEvaluateDecisionTable(AfterEvaluateDecisionTableEvent event) {
       }
   
       public void beforeEvaluateDecisionService(BeforeEvaluateDecisionServiceEvent event) {
       }
   
       public void afterEvaluateDecisionService(AfterEvaluateDecisionServiceEvent event) {
       }
   }

   PrometheusMetricsProvider インターフェイスには、Prometheus メトリクス収集に必要なリスナーが含まれます。このインターフェイスは、プロジェクトの pom.xml ファイルで宣言した kie-server-services-prometheus 依存関係に組み込まれます。

   以下の例では、ExampleCustomPrometheusMetricListener クラスは、(PrometheusMetricsProvider インターフェイスからの) DMNRuntimeEventListener リスナーを実装し、Prometheus で収集、保存するカスタムの DMN メトリクスを定義します。

3. 以下の例にあるように、PrometheusMetricsProvider インターフェイスとカスタムのリスナーを関連付ける、カスタムのメトリクスプロバイダーの一部として PrometheusMetricsProvider インターフェイスを実装します。

   カスタムメトリクスプロバイダークラスの PrometheusMetricsProvider インターフェイスの実装例

   package org.kie.server.ext.prometheus;
   
   import org.jbpm.executor.AsynchronousJobListener;
   import org.jbpm.services.api.DeploymentEventListener;
   import org.kie.api.event.rule.AgendaEventListener;
   import org.kie.api.event.rule.DefaultAgendaEventListener;
   import org.kie.dmn.api.core.event.DMNRuntimeEventListener;
   import org.kie.server.services.api.KieContainerInstance;
   import org.kie.server.services.prometheus.PrometheusMetricsProvider;
   import org.optaplanner.core.impl.phase.event.PhaseLifecycleListener;
   import org.optaplanner.core.impl.phase.event.PhaseLifecycleListenerAdapter;
   
   public class MyPrometheusMetricsProvider implements PrometheusMetricsProvider {
   
       public DMNRuntimeEventListener createDMNRuntimeEventListener(KieContainerInstance kContainer) {
           return new ExampleCustomPrometheusMetricListener(kContainer);
       }
   
       public AgendaEventListener createAgendaEventListener(String kieSessionId, KieContainerInstance kContainer) {
           return new DefaultAgendaEventListener();
       }
   
       public PhaseLifecycleListener createPhaseLifecycleListener(String solverId) {
           return new PhaseLifecycleListenerAdapter() {
           };
       }
   
       public AsynchronousJobListener createAsynchronousJobListener() {
           return null;
       }
   
       public DeploymentEventListener createDeploymentEventListener() {
           return null;
       }
   }

   以下の例では、MyPrometheusMetricsProvider クラスは PrometheusMetricsProvider インターフェイスを実装し、このクラスには、カスタムの ExampleCustomPrometheusMetricListener リスナークラスが含まれます。

4. 新規メトリクスプロバイダーを KIE Server で検出できるようにするには、Maven プロジェクトに META-INF/services/org.kie.server.services.prometheus.PrometheusMetricsProvider ファイルを作成して、このファイル内に PrometheusMetricsProvider 実装クラスの完全修飾クラス名を追加します。以下の例では、このファイルに org.kie.server.ext.prometheus.MyPrometheusMetricsProvider の 1 行が含まれています。

5. プロジェクトを構築して、作成された JAR ファイルをプロジェクトの ~/kie-server.war/WEB-INF/lib ディレクトリーにコピーします。たとえば、Red Hat JBoss EAP ではこのディレクトリーへのパスは EAP_HOME/standalone/deployments/kie-server.war/WEB-INF/lib です。

   Red Hat OpenShift Container Platform に Red Hat Process Automation Manager をデプロイする場合は、カスタム KIE Server イメージを作成し、この JAR ファイルをイメージに追加します。追加の JAR ファイルを含むカスタム KIE Server イメージの作成に関する詳細は、Operator を使用した Red Hat OpenShift Container Platform 4 への Red Hat Process Automation Manager 環境のデプロイメント を参照してください。

6. KIE Server を起動して、実行中の KIE Server に構築したプロジェクトをデプロイします。プロジェクトは、Business Central インターフェイスまたは KIE Server REST API (http://SERVER:PORT/kie-server/services/rest/server/containers/{containerId} への PUT 要求) を使用してデプロイできます。

   実行中の KIE Server にプロジェクトをデプロイした後に、Prometheus はメトリクスの収集を開始し、KIE Server はメトリクスを REST API エンドポイント http://HOST:PORT/SERVER/services/rest/metrics (または Spring Boot では http://HOST:PORT/rest/metrics) に公開します。

手順

1. KIE Server の永続性を設定するには、以下のタスクのいずれかを実行します。

   Red Hat JBoss EAP 設定ファイルを使用して KIE Server の永続性を設定する場合は、以下のタスクを実行します。

   1. Red Hat Process Automation Manager インストールディレクトリーで、standalone-full.xml ファイルに移動します。たとえば、Red Hat Process Automation Manager に Red Hat JBoss EAP インストールを使用する場合は $EAP_HOME/standalone/configuration/standalone-full.xml に移動します。

   2. standalone-full.xml ファイルを開き、<system-properties> タグの下に、システムプロパティーとして、Hibernate または JPA パラメーターを設定します。

      Hibernate パラメーターを使用して KIE サーバーの永続性を設定する例

      <system-properties>
          ...
              <property name="hibernate.hbm2ddl.auto" value="create-drop"/>
          ...
      <system-properties>

      JPA パラメーターを使用して KIE サーバーの永続性を設定する例

      <system-properties>
          ...
              <property name="javax.persistence.jdbc.url" value="jdbc:mysql://mysql.db.server:3306/my_database?useSSL=false&serverTimezone=UTC"/>
          ...
      <system-properties>

   コマンドラインを使用して KIE Server の永続性を設定する場合は、以下のタスクを実行します。

   1. 以下のように -Dkey=value を使用してコマンドラインからパラメーターを直接渡します。

      Hibernate パラメーターを使用して KIE サーバーの永続性を設定する例:

      $EAP_HOME/bin/standalone.sh -Dhibernate.hbm2ddl.auto=create-drop

      JPA パラメーターを使用して KIE サーバーの永続性を設定する例:

      $EAP_HOME/bin/standalone.sh -Djavax.persistence.jdbc.url=jdbc:mysql://mysql.db.server:3306/my_database?useSSL=false&serverTimezone=UTC

手順

1. プロセス変数として使用するデータオブジェクトファイルで、以下の要素を追加して変数の永続性を設定します。

   変数を永続化するように設定した Person.java オブジェクトの例

   @javax.persistence.Entity  1
   @javax.persistence.Table(name = "Person")  2
   public class Person extends org.drools.persistence.jpa.marshaller.VariableEntity  3
   implements java.io.Serializable {  4
   
   	static final long serialVersionUID = 1L;
   
   	@javax.persistence.GeneratedValue(strategy = javax.persistence.GenerationType.AUTO, generator = "PERSON_ID_GENERATOR")
   	@javax.persistence.Id  5
   	@javax.persistence.SequenceGenerator(name = "PERSON_ID_GENERATOR", sequenceName = "PERSON_ID_SEQ")
   	private java.lang.Long id;
   
   	private java.lang.String name;
   
   	private java.lang.Integer age;
   
   	public Person() {
   	}
   
   	public java.lang.Long getId() {
   		return this.id;
   	}
   
   	public void setId(java.lang.Long id) {
   		this.id = id;
   	}
   
   	public java.lang.String getName() {
   		return this.name;
   	}
   
   	public void setName(java.lang.String name) {
   		this.name = name;
   	}
   
   	public java.lang.Integer getAge() {
   		return this.age;
   	}
   
   	public void setAge(java.lang.Integer age) {
   		this.age = age;
   	}
   
   	public Person(java.lang.Long id, java.lang.String name,
   			java.lang.Integer age) {
   		this.id = id;
   		this.name = name;
   		this.age = age;
   	}
   
   }

   1

   データオブジェクトを永続エンティティーとして設定します。

   2

   データオブジェクトに使用するデータベーステーブル名を定義します。

   3

   このデータオブジェクトと関連のあるプロセスインスタンスの関係を管理する MappedVariable マッピングテーブルを別に作成します。関係の管理が必要ない場合は、VariableEntity クラスを継承する必要はありません。この継承がない場合、データオブジェクトは永続化されますが、追加のデータは含まれません。

   4

   並列化可能なオブジェクトとしてデータオブジェクトを設定します。

   5

   オブジェクトの永続 ID を設定します。

   Business Central を使用して、データオブジェクトを永続化するには、プロジェクトのデータオブジェクトファイルに移動し、ウィンドウの右上隅の Persistence アイコンをクリックして、永続性の動作を設定します。

   図18.1 Business Central での永続性設定

   

2. プロジェクトの pom.xml ファイルで、永続性のサポートを提供するために、以下の依存関係を追加します。この依存関係には、データオブジェクトで設定した VariableEntity クラスが含まれます。

   永続性のプロジェクトの依存関係

   <dependency>
     <groupId>org.drools</groupId>
     <artifactId>drools-persistence-jpa</artifactId>
     <version>${rhpam.version}</version>
     <scope>provided</scope>
   </dependency>

3. プロジェクトの ~/META-INF/kie-deployment-descriptor.xml ファイルで、JPA マーシャリングストラテジーと、マーシャラーで使用する永続ユニットを設定します。オブジェクトをエンティティーとして定義するには、JPA マーシャリングストラテジーと永続ユニットが必要です。

   kie-deployment-descriptor.xml ファイルで設定する JPA マーシャラーと永続ユニット

   <marshalling-strategy>
     <resolver>mvel</resolver>
     <identifier>new org.drools.persistence.jpa.marshaller.JPAPlaceholderResolverStrategy("myPersistenceUnit", classLoader)</identifier>
     <parameters/>
   </marshalling-strategy>

4. プロジェクトの ~/META-INF ディレクトリーで、persistence.xml ファイルを作成し、プロセス変数を永続化するデータソースを指定します。

   データソース設定を含む persistence.xml ファイルの例

   <persistence xmlns="http://java.sun.com/xml/ns/persistence" xmlns:orm="http://java.sun.com/xml/ns/persistence/orm" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0" xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd http://java.sun.com/xml/ns/persistence/orm http://java.sun.com/xml/ns/persistence/orm_2_0.xsd">
       <persistence-unit name="myPersistenceUnit" transaction-type="JTA">
           <provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>
           <jta-data-source>java:jboss/datasources/ExampleDS</jta-data-source>  1
           <class>org.space.example.Person</class>
           <exclude-unlisted-classes>true</exclude-unlisted-classes>
           <properties>
               <property name="hibernate.dialect" value="org.hibernate.dialect.PostgreSQLDialect"/>
               <property name="hibernate.max_fetch_depth" value="3"/>
               <property name="hibernate.hbm2ddl.auto" value="update"/>
               <property name="hibernate.show_sql" value="true"/>
               <property name="hibernate.id.new_generator_mappings" value="false"/>
               <property name="hibernate.transaction.jta.platform" value="org.hibernate.service.jta.platform.internal.JBossAppServerJtaPlatform"/>
           </properties>
       </persistence-unit>
   </persistence>

   1

   データソースを設定して、プロセス変数を永続化します。

   Business Central を使用してマーシャリングストラテジー、永続ユニット、データソースを設定するには、プロジェクトの Settings → Deployments → Marshalling Strategies に移動し、プロジェクトの Settings → Persistence に移動します。

   図18.2 Business Central での JPA マーシャラー設定

   

   図18.3 Business Central での永続ユニットとデータソース設定

   

手順

1. 空の Maven プロジェクトを作成して、以下のパッケージタイプと依存関係を、プロジェクトの pom.xml ファイルに定義します。

   サンプルプロジェクトの pom.xml ファイルの例

   <packaging>jar</packaging>
   
   <properties>
     <version.org.kie>7.48.0.Final-redhat-00004</version.org.kie>
   </properties>
   
   <dependencies>
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-api</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-internal</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-api</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-services-common</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-services-drools</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-rest-common</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-core</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-compiler</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
       <version>1.7.25</version>
     </dependency>
   </dependencies>

2. 以下の例のように、プロジェクトの Java クラスに org.kie.server.services.api.KieServerApplicationComponentsService インターフェイスを実装します。

   KieServerApplicationComponentsService インターフェイスの実装例

   public class CusomtDroolsKieServerApplicationComponentsService implements KieServerApplicationComponentsService {  1
   
       private static final String OWNER_EXTENSION = "Drools";  2
   
       public Collection<Object> getAppComponents(String extension, SupportedTransports type, Object... services) {  3
           // Do not accept calls from extensions other than the owner extension:
           if ( !OWNER_EXTENSION.equals(extension) ) {
               return Collections.emptyList();
           }
   
           RulesExecutionService rulesExecutionService = null;  4
           KieServerRegistry context = null;
   
           for( Object object : services ) {
               if( RulesExecutionService.class.isAssignableFrom(object.getClass()) ) {
                   rulesExecutionService = (RulesExecutionService) object;
                   continue;
               } else if( KieServerRegistry.class.isAssignableFrom(object.getClass()) ) {
                   context = (KieServerRegistry) object;
                   continue;
               }
           }
   
           List<Object> components = new ArrayList<Object>(1);
           if( SupportedTransports.REST.equals(type) ) {
               components.add(new CustomResource(rulesExecutionService, context));  5
           }
   
           return components;
       }
   
   }

   1

   アプリケーションの起動時にデプロイされる KIE Server インフラストラクチャーに REST エンドポイントを提供します。

   2

   この例の Drools 拡張など、拡張する機能を指定します。

   3

   REST コンテナーがデプロイする必要のある全リソースを返します。KIE Server インスタンスで有効化した各拡張で、getAppComponents メソッドを呼び出して、指定した OWNER_EXTENSION 以外の拡張の空のコレクションを、if ( !OWNER_EXTENSION.equals(extension) ) の呼び出しで返します。

   4

   この例の Drools 拡張の RulesExecutionService や KieServerRegistry サービスなど、指定の拡張から使用するサービスを表示します。

   5

   components リストの一部としてリソースを返す CustomResource クラスと、拡張のトランスポートタイプを REST または JMS に指定します (この例では REST)。

3. 以下の例のように、KIE Server を使用して新規の REST リソースの機能を追加する CustomResource クラスを実装します。

   CustomResource クラスの実装例

   // Custom base endpoint:
   @Path("server/containers/instances/{containerId}/ksession")
   public class CustomResource {
   
       private static final Logger logger = LoggerFactory.getLogger(CustomResource.class);
   
       private KieCommands commandsFactory = KieServices.Factory.get().getCommands();
   
       private RulesExecutionService rulesExecutionService;
       private KieServerRegistry registry;
   
       public CustomResource() {
   
       }
   
       public CustomResource(RulesExecutionService rulesExecutionService, KieServerRegistry registry) {
           this.rulesExecutionService = rulesExecutionService;
           this.registry = registry;
       }
   
       // Supported HTTP method, path parameters, and data formats:
       @POST
       @Path("/{ksessionId}")
       @Consumes({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
       @Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
       public Response insertFireReturn(@Context HttpHeaders headers,
               @PathParam("containerId") String id,
               @PathParam("ksessionId") String ksessionId,
               String cmdPayload) {
   
           Variant v = getVariant(headers);
           String contentType = getContentType(headers);
   
           // Marshalling behavior and supported actions:
           MarshallingFormat format = MarshallingFormat.fromType(contentType);
           if (format == null) {
               format = MarshallingFormat.valueOf(contentType);
           }
           try {
               KieContainerInstance kci = registry.getContainer(id);
   
               Marshaller marshaller = kci.getMarshaller(format);
   
               List<?> listOfFacts = marshaller.unmarshall(cmdPayload, List.class);
   
               List<Command<?>> commands = new ArrayList<Command<?>>();
               BatchExecutionCommand executionCommand = commandsFactory.newBatchExecution(commands, ksessionId);
   
               for (Object fact : listOfFacts) {
                   commands.add(commandsFactory.newInsert(fact, fact.toString()));
               }
               commands.add(commandsFactory.newFireAllRules());
               commands.add(commandsFactory.newGetObjects());
   
               ExecutionResults results = rulesExecutionService.call(kci, executionCommand);
   
               String result = marshaller.marshall(results);
   
   
               logger.debug("Returning OK response with content '{}'", result);
               return createResponse(result, v, Response.Status.OK);
           } catch (Exception e) {
               // If marshalling fails, return the `call-container` response to maintain backward compatibility:
               String response = "Execution failed with error : " + e.getMessage();
               logger.debug("Returning Failure response with content '{}'", response);
               return createResponse(response, v, Response.Status.INTERNAL_SERVER_ERROR);
           }
   
       }
   }

   この例では、カスタムエンドポイントの CustomResource クラスで、以下のデータと動作を指定します。

   • server/containers/instances/{containerId}/ksession のベースポイントを使用します。
   • POST HTTP メソッドを使用します。

   • REST 要求で以下のデータを指定する必要があります。

     • パスの引数として containerId
     • パスの引数として ksessionId
     • メッセージペイロードとしてファクトの一覧

   • 全 KIE Server データ形式をサポートします。

     • XML (JAXB、XStream)
     • JSON
   • List<?> コレクションにペイロードをアンマーシャリングして、リスト内のアイテムごとに、InsertCommand インスタンスを作成し、その後に FireAllRules と GetObject コマンドを追加します。
   • デシジョンエンジンを呼び出す BatchExecutionCommand インスタンスに全コマンドを追加します。
4. 新規エンドポイントを KIE Server で検出できるようにするには、Maven プロジェクト内に META-INF/services/org.kie.server.services.api.KieServerApplicationComponentsService ファイルを作成して、このファイルに KieServerApplicationComponentsService 実装クラスの完全修飾名を追加します。たとえば、このファイルには、org.kie.server.ext.drools.rest.CusomtDroolsKieServerApplicationComponentsService の 1 行が含まれます。
5. プロジェクトを構築して、作成された JAR ファイルをプロジェクトの ~/kie-server.war/WEB-INF/lib ディレクトリーにコピーします。たとえば、Red Hat JBoss EAP ではこのディレクトリーへのパスは EAP_HOME/standalone/deployments/kie-server.war/WEB-INF/lib です。

6. KIE Server を起動して、実行中の KIE Server に構築したプロジェクトをデプロイします。プロジェクトは、Business Central インターフェイスまたは KIE Server REST API (http://SERVER:PORT/kie-server/services/rest/server/containers/{containerId} への PUT 要求) を使用してデプロイできます。

   実行中の KIE Server にプロジェクトを追加した後に、新しい REST エンドポイントとの対話を開始します。

   今回の例では、以下の情報を使用して新規エンドポイントを呼び出すことができます。

   • 要求 URL 例: http://localhost:8080/kie-server/services/rest/server/containers/instances/demo/ksession/defaultKieSession
   • HTTP メソッド: POST

   • HTTP ヘッダー:

     • Content-Type: application/json
     • Accept: application/json

   • メッセージペイロードの例:

     [
       {
         "org.jbpm.test.Person": {
           "name": "john",
           "age": 25
         }
       },
       {
         "org.jbpm.test.Person": {
           "name": "mary",
           "age": 22
         }
       }
     ]

   • サーバーの応答例: 200 (success)

   • サーバーのログ出力例:

     13:37:20,347 INFO  [stdout] (default task-24) Hello mary
     13:37:20,348 INFO  [stdout] (default task-24) Hello john

手順

1. 空の Maven プロジェクトを作成して、以下のパッケージタイプと依存関係を、プロジェクトの pom.xml ファイルに定義します。

   サンプルプロジェクトの pom.xml ファイルの例

   <packaging>jar</packaging>
   
   <properties>
     <version.org.kie>7.48.0.Final-redhat-00004</version.org.kie>
   </properties>
   
   <dependencies>
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-api</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-internal</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-api</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-services-common</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-services-drools</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-core</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-compiler</artifactId>
       <version>${version.org.kie}</version>
     </dependency>
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
       <version>1.7.25</version>
     </dependency>
     <dependency>
       <groupId>org.apache.mina</groupId>
       <artifactId>mina-core</artifactId>
       <version>2.1.3</version>
     </dependency>
   </dependencies>

2. 以下の例のように、プロジェクトの Java クラスに org.kie.server.services.api.KieServerExtension インターフェイスを実装します。

   KieServerExtension インターフェイスの実装例

   public class MinaDroolsKieServerExtension implements KieServerExtension {
   
       private static final Logger logger = LoggerFactory.getLogger(MinaDroolsKieServerExtension.class);
   
       public static final String EXTENSION_NAME = "Drools-Mina";
   
       private static final Boolean disabled = Boolean.parseBoolean(System.getProperty("org.kie.server.drools-mina.ext.disabled", "false"));
       private static final String MINA_HOST = System.getProperty("org.kie.server.drools-mina.ext.port", "localhost");
       private static final int MINA_PORT = Integer.parseInt(System.getProperty("org.kie.server.drools-mina.ext.port", "9123"));
   
       // Taken from dependency on the `Drools` extension:
       private KieContainerCommandService batchCommandService;
   
       // Specific to MINA:
       private IoAcceptor acceptor;
   
       public boolean isActive() {
           return disabled == false;
       }
   
       public void init(KieServerImpl kieServer, KieServerRegistry registry) {
   
           KieServerExtension droolsExtension = registry.getServerExtension("Drools");
           if (droolsExtension == null) {
               logger.warn("No Drools extension available, quitting...");
               return;
           }
   
           List<Object> droolsServices = droolsExtension.getServices();
           for( Object object : droolsServices ) {
               // If the given service is null (not configured), continue to the next service:
               if (object == null) {
                   continue;
               }
               if( KieContainerCommandService.class.isAssignableFrom(object.getClass()) ) {
                   batchCommandService = (KieContainerCommandService) object;
                   continue;
               }
           }
           if (batchCommandService != null) {
               acceptor = new NioSocketAcceptor();
               acceptor.getFilterChain().addLast( "codec", new ProtocolCodecFilter( new TextLineCodecFactory( Charset.forName( "UTF-8" ))));
   
               acceptor.setHandler( new TextBasedIoHandlerAdapter(batchCommandService) );
               acceptor.getSessionConfig().setReadBufferSize( 2048 );
               acceptor.getSessionConfig().setIdleTime( IdleStatus.BOTH_IDLE, 10 );
               try {
                   acceptor.bind( new InetSocketAddress(MINA_HOST, MINA_PORT) );
   
                   logger.info("{} -- Mina server started at {} and port {}", toString(), MINA_HOST, MINA_PORT);
               } catch (IOException e) {
                   logger.error("Unable to start Mina acceptor due to {}", e.getMessage(), e);
               }
   
           }
       }
   
       public void destroy(KieServerImpl kieServer, KieServerRegistry registry) {
           if (acceptor != null) {
               acceptor.dispose();
               acceptor = null;
           }
           logger.info("{} -- Mina server stopped", toString());
       }
   
       public void createContainer(String id, KieContainerInstance kieContainerInstance, Map<String, Object> parameters) {
           // Empty, already handled by the `Drools` extension
   
       }
   
       public void disposeContainer(String id, KieContainerInstance kieContainerInstance, Map<String, Object> parameters) {
         // Empty, already handled by the `Drools` extension
   
       }
   
       public List<Object> getAppComponents(SupportedTransports type) {
           // Nothing for supported transports (REST or JMS)
           return Collections.emptyList();
       }
   
       public <T> T getAppComponents(Class<T> serviceType) {
   
           return null;
       }
   
       public String getImplementedCapability() {
           return "BRM-Mina";
       }
   
       public List<Object> getServices() {
           return Collections.emptyList();
       }
   
       public String getExtensionName() {
           return EXTENSION_NAME;
       }
   
       public Integer getStartOrder() {
           return 20;
       }
   
       @Override
       public String toString() {
           return EXTENSION_NAME + " KIE Server extension";
       }
   }

   KieServerExtension インターフェイスは、新規の MINA トランスポートの機能を追加する時に KIE Server が使用する主要な拡張インターフェイスです。このインターフェイスには、以下のコンポーネントが含まれます。

   KieServerExtension インターフェイスの概要

   public interface KieServerExtension {
   
       boolean isActive();
   
       void init(KieServerImpl kieServer, KieServerRegistry registry);
   
       void destroy(KieServerImpl kieServer, KieServerRegistry registry);
   
       void createContainer(String id, KieContainerInstance kieContainerInstance, Map<String, Object> parameters);
   
       void disposeContainer(String id, KieContainerInstance kieContainerInstance, Map<String, Object> parameters);
   
       List<Object> getAppComponents(SupportedTransports type);
   
       <T> T getAppComponents(Class<T> serviceType);
   
       String getImplementedCapability();  1
   
       List<Object> getServices();
   
       String getExtensionName();  2
   
       Integer getStartOrder();  3
   }

   1

   この拡張で対応している機能を指定します。この機能は、KIE Server 内で一意でなければなりません。

   2

   拡張は、人間が解読可能な名前に定義します。

   3

   指定した拡張の起動のタイミングを決定します。他の拡張と依存関係がある拡張の場合、この設定は親の設定と競合しないようにしてください。たとえば、今回の場合、このカスタムの拡張は Drools 拡張に依存しており、Drool 拡張の StartOrder は 0 に設定されているため、このカスタムのアドオン拡張は 0 を超える値でなければなりません (サンプルの実装では 20 に設定)。

   このインターフェイスの先程の MinaDroolsKieServerExtension 実装例では、init メソッドが主に、Drools 拡張からサービスを収集して、MINA サーバーをブートストラップ化する要素となっています。KieServerExtension インターフェイスの他のメソッドは、標準の実装のままで、インターフェイスの要件を満たします。

   TextBasedIoHandlerAdapter クラスは、受信要求に対応する MINA サーバーにあるハンドラーです。

3. 以下の例のように、MINA サーバーの TextBasedIoHandlerAdapter ハンドラーを実装します。

   TextBasedIoHandlerAdapter ハンドラーの実装例

   public class TextBasedIoHandlerAdapter extends IoHandlerAdapter {
   
       private static final Logger logger = LoggerFactory.getLogger(TextBasedIoHandlerAdapter.class);
   
       private KieContainerCommandService batchCommandService;
   
       public TextBasedIoHandlerAdapter(KieContainerCommandService batchCommandService) {
           this.batchCommandService = batchCommandService;
       }
   
       @Override
       public void messageReceived( IoSession session, Object message ) throws Exception {
           String completeMessage = message.toString();
           logger.debug("Received message '{}'", completeMessage);
           if( completeMessage.trim().equalsIgnoreCase("quit") || completeMessage.trim().equalsIgnoreCase("exit") ) {
               session.close(false);
               return;
           }
   
           String[] elements = completeMessage.split("\\|");
           logger.debug("Container id {}", elements[0]);
           try {
               ServiceResponse<String> result = batchCommandService.callContainer(elements[0], elements[1], MarshallingFormat.JSON, null);
   
               if (result.getType().equals(ServiceResponse.ResponseType.SUCCESS)) {
                   session.write(result.getResult());
                   logger.debug("Successful message written with content '{}'", result.getResult());
               } else {
                   session.write(result.getMsg());
                   logger.debug("Failure message written with content '{}'", result.getMsg());
               }
           } catch (Exception e) {
   
           }
       }
   }

   この例では、ハンドラークラスはテキストメッセージを受信して、Drools サービスでこのメッセージを実行します。

   TextBasedIoHandlerAdapter ハンドラー実装を使用する場合は、以下のハンドラー要件と動作を考慮してください。

   • 各受信トランスポート要求が 1 行であるため、ハンドラーに送信する内容は、1 行でなければなりません。
   • ハンドラーで containerID|payload の形式が想定されるように、この 1 行に KIE コンテナー ID を渡す必要があります。
   • マーシャラーで生成される方法で応答を設定できます。応答は複数行にすることができます。
   • このハンドラーは stream mode をサポートし、KIE Server セッションを切断せずにコマンドを送信できます。ストリームモードで KIE Server セッションを終了するには、サーバーに exit コマンドまたは quit コマンドを送信してください。
4. 新規のデータトランスポートを KIE Server で検出できるようにするには、Maven プロジェクトで META-INF/services/org.kie.server.services.api.KieServerExtension ファイルを作成し、このファイルに KieServerExtension 実装クラスの完全修飾名を追加します。たとえば、このファイルには org.kie.server.ext.mina.MinaDroolsKieServerExtension の 1 行が含まれます。
5. プロジェクトを構築して、作成された JAR ファイルと mina-core-2.0.9.jar ファイル (今回の例でこの拡張が依存) をプロジェクトの ~/kie-server.war/WEB-INF/lib ディレクトリーにコピーします。たとえば、Red Hat JBoss EAP ではこのディレクトリーへのパスは EAP_HOME/standalone/deployments/kie-server.war/WEB-INF/lib です。

6. KIE Server を起動して、実行中の KIE Server に構築したプロジェクトをデプロイします。プロジェクトは、Business Central インターフェイスまたは KIE Server REST API (http://SERVER:PORT/kie-server/services/rest/server/containers/{containerId} への PUT 要求) を使用してデプロイできます。

   プロジェクトを実行中の KIE Server にデプロイした後に、KIE Server ログで新規データトランスポートのステータスを表示して、新規データトランスポートの使用を開始できます。

   サーバーログの新規データトランスポート

   Drools-Mina KIE Server extension -- Mina server started at localhost and port 9123
   Drools-Mina KIE Server extension has been successfully registered as server extension

   この例では、Telnet を使用して KIE Server の 新しい MINA ベースのデータトランスポートと対話できます。

   コマンド端末での Telnet の開始およびポート 9123 での KIE Server の接続

   telnet 127.0.0.1 9123

   コマンド端末での KIE Server との対話例

   Trying 127.0.0.1...
   Connected to localhost.
   Escape character is '^]'.
   
   # Request body:
   demo|{"lookup":"defaultKieSession","commands":[{"insert":{"object":{"org.jbpm.test.Person":{"name":"john","age":25}}}},{"fire-all-rules":""}]}
   
   # Server response:
   {
     "results" : [ {
       "key" : "",
       "value" : 1
     } ],
     "facts" : [ ]
   }
   
   demo|{"lookup":"defaultKieSession","commands":[{"insert":{"object":{"org.jbpm.test.Person":{"name":"mary","age":22}}}},{"fire-all-rules":""}]}
   {
     "results" : [ {
       "key" : "",
       "value" : 1
     } ],
     "facts" : [ ]
   }
   
   demo|{"lookup":"defaultKieSession","commands":[{"insert":{"object":{"org.jbpm.test.Person":{"name":"james","age":25}}}},{"fire-all-rules":""}]}
   {
     "results" : [ {
       "key" : "",
       "value" : 1
     } ],
     "facts" : [ ]
   }
   exit
   Connection closed by foreign host.

   サーバーログの出力例

   16:33:40,206 INFO  [stdout] (NioProcessor-2) Hello john
   16:34:03,877 INFO  [stdout] (NioProcessor-2) Hello mary
   16:34:19,800 INFO  [stdout] (NioProcessor-2) Hello james

手順

1. 空の Maven プロジェクトを作成して、以下のパッケージタイプと依存関係を、プロジェクトの pom.xml ファイルに定義します。

   サンプルプロジェクトの pom.xml ファイルの例

   <packaging>jar</packaging>
   
   <properties>
      <version.org.kie>7.48.0.Final-redhat-00004</version.org.kie>
    </properties>
   
    <dependencies>
      <dependency>
        <groupId>org.kie.server</groupId>
        <artifactId>kie-server-api</artifactId>
        <version>${version.org.kie}</version>
      </dependency>
      <dependency>
         <groupId>org.kie.server</groupId>
         <artifactId>kie-server-client</artifactId>
         <version>${version.org.kie}</version>
       </dependency>
      <dependency>
        <groupId>org.drools</groupId>
        <artifactId>drools-compiler</artifactId>
        <version>${version.org.kie}</version>
      </dependency>
    </dependencies>

2. 以下の例のように、プロジェクトの Java クラスに、関連する ServicesClient インターフェイスを実装します。

   RulesMinaServicesClient インターフェイスの例

   public interface RulesMinaServicesClient extends RuleServicesClient {
   
   }

   インターフェイスをもとにクライアントの実装を登録する必要があるため、特定のインターフェイスが必要です。また、指定のインターフェイスには実装は 1 つしか指定できません。

   この例では、カスタムの MINA ベースのデータトランスポートが Drools 拡張を使用し、この RulesMinaServicesClient インターフェイスの例は、Drools 拡張から、既存の RuleServicesClient クライアント API を拡張します。

3. 以下の例のように、新規の MINA トランスポートのクライアント機能を追加するのに KIE Server が使用可能な RulesMinaServicesClient インターフェイスを実装します。

   RulesMinaServicesClient インターフェイスの実装例

   public class RulesMinaServicesClientImpl implements RulesMinaServicesClient {
   
       private String host;
       private Integer port;
   
       private Marshaller marshaller;
   
       public RulesMinaServicesClientImpl(KieServicesConfiguration configuration, ClassLoader classloader) {
           String[] serverDetails = configuration.getServerUrl().split(":");
   
           this.host = serverDetails[0];
           this.port = Integer.parseInt(serverDetails[1]);
   
           this.marshaller = MarshallerFactory.getMarshaller(configuration.getExtraJaxbClasses(), MarshallingFormat.JSON, classloader);
       }
   
       public ServiceResponse<String> executeCommands(String id, String payload) {
   
           try {
               String response = sendReceive(id, payload);
               if (response.startsWith("{")) {
                   return new ServiceResponse<String>(ResponseType.SUCCESS, null, response);
               } else {
                   return new ServiceResponse<String>(ResponseType.FAILURE, response);
               }
           } catch (Exception e) {
               throw new KieServicesException("Unable to send request to KIE Server", e);
           }
       }
   
       public ServiceResponse<String> executeCommands(String id, Command<?> cmd) {
           try {
               String response = sendReceive(id, marshaller.marshall(cmd));
               if (response.startsWith("{")) {
                   return new ServiceResponse<String>(ResponseType.SUCCESS, null, response);
               } else {
                   return new ServiceResponse<String>(ResponseType.FAILURE, response);
               }
           } catch (Exception e) {
               throw new KieServicesException("Unable to send request to KIE Server", e);
           }
       }
   
       protected String sendReceive(String containerId, String content) throws Exception {
   
           // Flatten the content to be single line:
           content = content.replaceAll("\\n", "");
   
           Socket minaSocket = null;
           PrintWriter out = null;
           BufferedReader in = null;
   
           StringBuffer data = new StringBuffer();
           try {
               minaSocket = new Socket(host, port);
               out = new PrintWriter(minaSocket.getOutputStream(), true);
               in = new BufferedReader(new InputStreamReader(minaSocket.getInputStream()));
   
               // Prepare and send data:
               out.println(containerId + "|" + content);
               // Wait for the first line:
               data.append(in.readLine());
               // Continue as long as data is available:
               while (in.ready()) {
                   data.append(in.readLine());
               }
   
               return data.toString();
           } finally {
               out.close();
               in.close();
               minaSocket.close();
           }
       }
   }

   この実装例は、以下のデータおよび動作を指定します。

   • ソケットベースの通信を使用して簡素化します。
   • KIE Server クライアントのデフォルト設定に依存し、ServerUrl を使用して MINA サーバーのホストとポートを提供します。
   • マーシャリング形式で JSON を指定します。
   • 受信メッセージは左波括弧 { で始まる JSON オブジェクトでなければなりません。
   • 応答の最初の行を待機中に、ブロッキング API と直接、ソケット通信を使用してから、利用可能なすべての行を読み取ります。
   • ストリームモード を使用しないため、コマンドの呼び出し後に KIE Server セッションを切断します。

4. 以下の例のように、プロジェクトの Java クラスに org.kie.server.client.helper.KieServicesClientBuilder インターフェイスを実装します。

   KieServicesClientBuilder インターフェイスの実装例

   public class MinaClientBuilderImpl implements KieServicesClientBuilder {  1
   
       public String getImplementedCapability() {  2
           return "BRM-Mina";
       }
   
       public Map<Class<?>, Object> build(KieServicesConfiguration configuration, ClassLoader classLoader) {  3
           Map<Class<?>, Object> services = new HashMap<Class<?>, Object>();
   
           services.put(RulesMinaServicesClient.class, new RulesMinaServicesClientImpl(configuration, classLoader));
   
           return services;
       }
   
   }

   1

   一般の KIE Server クライアントインフラストラクチャーにクライアント API を追加できます。

   2

   クライアントが使用する KIE Server 機能 (拡張) を定義します。

   3

   クライアントの実装のマッピングを提供します。キーはインターフェイス、値は完全な初期実装です。

5. 新規のクライアント API を KIE Server クライアントで検出できるようにするには、Maven プロジェクトで META-INF/services/org.kie.server.client.helper.KieServicesClientBuilder ファイルを作成し、このファイルに KieServicesClientBuilder 実装クラスの完全修飾名を追加します。たとえば、このファイルには org.kie.server.ext.mina.client.MinaClientBuilderImpl の 1 行が含まれます。
6. プロジェクトを構築して、作成された JAR ファイルをプロジェクトの ~/kie-server.war/WEB-INF/lib ディレクトリーにコピーします。たとえば、Red Hat JBoss EAP ではこのディレクトリーへのパスは EAP_HOME/standalone/deployments/kie-server.war/WEB-INF/lib です。

7. KIE Server を起動して、実行中の KIE Server に構築したプロジェクトをデプロイします。プロジェクトは、Business Central インターフェイスまたは KIE Server REST API (http://SERVER:PORT/kie-server/services/rest/server/containers/{containerId} への PUT 要求) を使用してデプロイできます。

   実行中の KIE Server にプロジェクトをデプロイしたあとに、新規の KIE Server クライアントと対話を開始できます。標準の KIE Server クライアントと同じ方法で、クライアント設定とクライアントインスタンスを作成して、タイプ別にサービスクライアントを取得し、クライアントメソッドを呼び出して、新しいクライアントを使用します。

   たとえば、RulesMinaServiceClient クライアントインスタンスを作成して、MINA トランスポートを使用して KIE Server で操作を呼び出すことができます。

   RulesMinaServiceClient クライアント作成の実装例

   protected RulesMinaServicesClient buildClient() {
       KieServicesConfiguration configuration = KieServicesFactory.newRestConfiguration("localhost:9123", null, null);
       List<String> capabilities = new ArrayList<String>();
       // Explicitly add capabilities (the MINA client does not respond to `get-server-info` requests):
       capabilities.add("BRM-Mina");
   
       configuration.setCapabilities(capabilities);
       configuration.setMarshallingFormat(MarshallingFormat.JSON);
   
       configuration.addJaxbClasses(extraClasses);
   
       KieServicesClient kieServicesClient =  KieServicesFactory.newKieServicesClient(configuration);
   
       RulesMinaServicesClient rulesClient = kieServicesClient.getServicesClient(RulesMinaServicesClient.class);
   
       return rulesClient;
   }

   MINA トランスポートを使用して KIE Server 上で操作を呼び出す設定例

   RulesMinaServicesClient rulesClient = buildClient();
   
   List<Command<?>> commands = new ArrayList<Command<?>>();
   BatchExecutionCommand executionCommand = commandsFactory.newBatchExecution(commands, "defaultKieSession");
   
   Person person = new Person();
   person.setName("mary");
   commands.add(commandsFactory.newInsert(person, "person"));
   commands.add(commandsFactory.newFireAllRules("fired"));
   
   ServiceResponse<String> response = rulesClient.executeCommands(containerId, executionCommand);
   Assert.assertNotNull(response);
   
   Assert.assertEquals(ResponseType.SUCCESS, response.getType());
   
   String data = response.getResult();
   
   Marshaller marshaller = MarshallerFactory.getMarshaller(extraClasses, MarshallingFormat.JSON, this.getClass().getClassLoader());
   
   ExecutionResultImpl results = marshaller.unmarshall(data, ExecutionResultImpl.class);
   Assert.assertNotNull(results);
   
   Object personResult = results.getValue("person");
   Assert.assertTrue(personResult instanceof Person);
   
   Assert.assertEquals("mary", ((Person) personResult).getName());
   Assert.assertEquals("JBoss Community", ((Person) personResult).getAddress());
   Assert.assertEquals(true, ((Person) personResult).isRegistered());

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Users を選択します。
2. New user をクリックし、ユーザー名を入力し、Next をクリックします。
3. ユーザーにロールを割り当てるには、Roles タブをクリックして、Add Roles をクリックし、任意のロールを選択してから、Add to selected roles をクリックします。
4. 必要に応じて、ユーザーにグループを割り当てるには、Groups タブをクリックして Add to groups をクリックし、任意のグループを選択してから Add to selected groups をクリックします。
5. Create をクリックします。
6. Yes をクリックして、ユーザーにパスワードを設定し、Change をクリックします。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Users を選択します。
2. All users リストから、編集するユーザーをクリックします。右のペインにユーザーの情報が表示されます。

3. Edit をクリックして、以下のタスクを実行します。

   • ユーザーのグループを変更するには、Groups タブをクリックして、Add to groups をクリックします。次に、ユーザーを所属させるグループを選択して Add to selected groups をクリックし、Save をクリックします。
   • ユーザーのロールを変更するには、Roles タブをクリックし、Add roles をクリックします。ユーザーに割り当てるロールを選択して、Add to selected roles をクリックし、Save をクリックします。
   • ユーザーパーミッションを表示するには、Permissions タブをクリックして属性を展開します。
   • パスワードを変更するには、Change Password をクリックして、新規パスワードを入力し、Change をクリックします。
   • ユーザーを削除するには、Delete をクリックしてから、Yes をクリックし、削除を確定します。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Groups を選択します。
2. New group をクリックし、グループ名を入力し、Next をクリックします。

3. このグループに追加するユーザーを選択し、Add selected users をクリックします。

   新規作成したグループは、All groups に表示されます。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Groups を選択します。
2. All groups 一覧から、編集するグループをクリックします。右のペインにユーザーの情報が表示されます。
3. Home Page リストからホームページを選択します。
4. Priority リストから優先順位を選択します。

5. Permissions セクションから、リソース属性を展開して、パーミッションを変更します。

   注記

   Pages パーミッション、Editor パーミッション、Spaces パーミッション、および Projects パーミッションに例外を追加できます。

6. Save をクリックして変更を適用します。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Artifacts を選択します。
2. Open をクリックしてアーティファクトの詳細を表示します。
3. Ok をクリックして Artifacts ページに戻ります。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Artifacts を選択します。
2. Download をクリックします。
3. アーティファクトを保存するディレクトリーを参照します。
4. Save をクリックします。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Artifacts を選択します。
2. Upload をクリックします。
3. Choose File をクリックして、アーティファクトをアップロードするディレクトリーに移動して選択します。

4. Upload をクリックします。

   注記

   Maven 以外のアーティファクトを使用する場合は、先に mvn deploy コマンドを使用してアーティファクトを Maven リポジトリーにデプロイしてから Business Central のアーティファクト一覧を更新します。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Data Sources を選択します。
2. DataSource Explorer ペインで Add Driver をクリックします。New driver ウィンドウが開きます。
3. New driver ウィンドウで、データベースドライバーの Name、Driver Class Name、Group Id、Artifact Id、および Version を入力します。
4. Finish をクリックして Business Central にドライバーを追加します。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Data Sources を選択します。
2. DataSource Explorer ペインで編集するドライバーを選択します。
3. Driver Definition ペインで、Name フィールド、Driver Class Name フィールド、Group Id フィールド、Artifact Id フィールド、および Version フィールドに必要な変更を加えます。
4. Update をクリックします。
5. Yes をクリックしてドライバーへの変更を保存します。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Data Sources を選択します。
2. DataSource Explorer ペインで削除するドライバーを選択します。
3. Remove をクリックします。
4. Delete をクリックしてドライバーを削除します。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Data Sources を選択します。
2. DataSource Explorer ペインで Add DataSource をクリックします。New data source ウィンドウが開きます。
3. New data source ウィンドウで、データソースの Name、データベースの Connection URL、User と Password、ならびに Driver を入力します。
4. Test Connection をクリックして、データベースへの接続を確認します。
5. Finish をクリックして Business Central へデータソースを追加します。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Data Sources を選択します。
2. DataSource Explorer ペインで編集するデータソースを選択します。
3. Data Source Definition ペインで、Name フィールド、Connection URL フィールド、User フィールド、Password フィールド、および Driver フィールドに必要な変更を加えます。
4. Test Connection をクリックして、データベースへの接続を確認します。
5. Update をクリックします。
6. Save をクリックして、データソースへの変更を確定します。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Data Sources を選択します。
2. DataSource Explorer ペインで削除するデータソースを選択します。
3. Remove をクリックします。
4. Delete をクリックして、データソースの削除を確定します。

手順

1. Business Central で、Admin → Data Sets に移動します。

   Data Sets ページが開きます。

2. New Data Set をクリックして、以下のプロバイダータイプから 1 つ選択します。

   • Bean: Java クラスからデータセットを生成します。
   • CSV: リモートまたはローカルの CSV ファイルからデータセットを生成します。
   • SQL: ANSI-SQL 準拠データベースからデータセットを生成します。
   • Elastic Search: Elastic Search ノードからデータセットを生成します。
   • Prometheus: Prometheus クエリーを使用してデータセットを生成します。

   • Execution Server: Execution Server のカスタムのクエリー機能を使用してデータセットを生成します。

     注記

     Execution Server オプションに KIE Server を設定する必要があります。

3. Data Set Creation Wizard を完了し、Test をクリックします。

   注記

   設定手順は、選択するプロバイダーにより異なります。

4. Save をクリックします。

手順

1. Business Central で、Admin → Data Sets に移動します。

   Data Set Explorer ページが開きます。

2. Data Set Explorer ペインで、編集するデータセットを検索し、データセットを選択して Edit をクリックします。

3. Data Set Editor ペインで、適切なタブを使用して必要に応じてデータを編集します。タブは、選択するデータセットプロバイダーの種類によって異なります。

   たとえば、CSV データプロバイダーの編集には、以下の変更が適用できます。

   • CSV Configuration: データセット定義の名前、ソースファイル、区切り記号などのプロパティーを変更できます。

   • Preview: データのプレビューを使用できます。CSV Configuration タブで Test をクリックすると、システムはデータセットのルックアップコールを実行し、データが利用可能な場合はプレビューが表示されます。Preview タブには 2 つのサブタブがあります。

     • Data columns: どの列をデータセット定義に追加するかを指定できます。
     • Filter: 新しいフィルターを追加できます。

   • Advanced: 以下の設定を管理できます。

     • Caching: 詳細は キャッシュ を参照してください。
     • Cache life-cycle: データセット (またはデータ) を再読み込みされるまでの間隔を指定できます。バックエンドデータに変更が加えられると、Refresh on stale data 機能は、キャッシュしたデータを再読み込みします。
4. 必要な変更を行ったら、Validate をクリックします。
5. Save をクリックします。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択して、Archetypes を選択します。

   Status コラムの緑のアイコンは有効なアーキタイプを、赤のアイコンは無効なアーキタイプを、青のアイコンは対応するアーキタイプが新しいスペースのデフォルトであることを示します。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択して、Archetypes を選択します。
2. Add Archetype をクリックします。
3. Add Archetype パネルで、Group ID フィールド、Artifact ID フィールド、および Version フィールドにそれぞれ GAV 属性を入力します。
4. 追加 をクリックします。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択して、Archetypes を選択します。

2. Actions コラムから、アーキタイプの右側にある アイコンをクリックします。

   • ドロップダウンメニューから Delete を選択して、リストからアーキタイプを削除します。

   • ドロップダウンメニューから Validate を選択して、アーキタイプが有効かどうかを検証します。

     注記

     Business Central の起動時に、登録したアーキタイプがすべて自動的に検証されます。

   • ドロップダウンメニューから Set as default を選択して、新規スペースのデフォルトとしてアーキタイプを設定します。

手順

1. Business Central で、Menu → Design → Projects に移動します。
2. アーキタイプテンプレートから新しいプロジェクトを追加するスペースを選択または作成します。
3. Add Project をクリックします。
4. Name フィールドおよび Description フィールドにそれぞれプロジェクト名と説明を入力します。
5. Configure Advanced Options をクリックします。
6. Based on template チェックボックスを選択します。
7. 必要に応じてドロップダウンオプションからアーキタイプを選択します。スペースで設定済みのデフォルトのアーキタイプが選択されています。
8. 追加 をクリックします。

手順

1. Business Central で、Menu → Design → Projects に移動します。
2. アーキタイプを管理するスペースを選択または作成します。デフォルトのスペースは MySpace です。
3. Settings をクリックします。
4. スペースでアーキタイプを追加または除外するには、Include チェックボックスを選択します。
5. Actions コラムからアーキタイプの右側にある アイコンをクリックし、ドロップダウンメニューから Set as default を選択してスペースのデフォルトとしてアーキタイプを設定します。
6. Save をクリックします。

手順

1. システムでコマンド端末を開きます。

2. 以下の例のように、ssh-keygen コマンドを実行して、SSH キーを作成します。<user_login> はユーザー名に置き換えてください。

   ssh-keygen -t rsa -b 4096 -C "<user_login>"

   注記

   Business Central キーストアでサポートされる SSH キーは ssh-rsa、ssh-dss、ecdsa-sha2-nistp256、ecdsa-sha2-nistp384、および ecdsa-sha2-nistp521 です。

3. 以下の例のように、プロンプトが表示されたら、Enter キーを押して、デフォルトのキーファイルの場所を確定します。<user_login> はユーザー名に置き換えてください。

   Enter a file in which to save the key (/home/<user_login>/.ssh/id_rsa): [Press enter]

4. コマンドプロンプトで、パスフレーズを入力して確定します。

   Enter passphrase (empty for no passphrase): [Type a passphrase]
   Enter same passphrase again: [Type passphrase again]

5. ssh-agent を起動します。

   eval "$(ssh-agent -s)"
   Agent pid <any-number-here>

6. 新しい SSH 秘密鍵を ssh-agent に追加します。違う名前のキーを使用する場合は、コード内の id_rsa を置き換えます。

   ssh-add ~/.ssh/id_rsa

手順

1. システムでコマンド端末を開きます。

2. 以下の例のように、cat コマンドを実行します。id_rsa はキーの名前に置き換えます。

   cat ~/.ssh/id_rsa.pub

3. SSH 公開鍵のコンテンツをコピーします。
4. Business Central で、画面の右上隅にある Admin アイコンを選択し、SSH Keys を選択します。
5. SSH Keys ページで Add SSH Key をクリックします。

6. Add SSH Key ウィンドウで Name フィールドに名前を入力し、SSH 公開鍵のコンテンツを Key フィールドにコピーします。

   注記

   Name および Key は必須のフィールドです。

7. Add SSH Key をクリックしてキーを登録します。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、SSH Keys を選択します。
2. SSH Keys ページで削除する SSH キーの削除アイコンをクリックします。
3. Delete SSH Key をクリックして、削除を確定します。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Dashbuilder Data Transfer を選択します。

2. Dashbuilder 関連のデータをエクスポートするには、以下のいずれかのタスクを実行します。

   Dashbuilder データ全体を ZIP ファイルとしてエクスポートする場合は、以下のタスクを実行します。

   1. Dashbuilder Data Transfer ページで Export all をクリックします。

      すべての Databuilder データを含む export.zip ファイルがダウンロードされます。export.zip ファイル構造は、以下の例のようにデータタイプで区切られています。

      dashbuilder/datasets/definitions/dataset-example1.dset
      dashbuilder/datasets/definitions/dataset-example2.dset
      dashbuilder/datasets/readme.md
      dashbuilder/perspectives/page1/perspective_layout
      dashbuilder/perspectives/page1/perspective_layout.plugin
      dashbuilder/perspectives/page2/perspective_layout
      dashbuilder/perspectives/page2/perspective_layout.plugin
      dashbuilder/perspectives/readme.md
      dashbuilder/navigation/navigation/navtree.json
      dashbuilder/navigation/readme.md
      VERSION

   カスタマイズしたユーザーを作成して Dashbuilder データを ZIP ファイルとしてエクスポートする場合には、以下のタスクを実行します。

   1. Dashbuilder Data Transfer ページで Custom export をクリックします。

   2. Export Wizard パネルの ZIP ファイルに追加するデータセットおよびページを選択し、Next をクリックします。

      Export Wizard パネルは、選択したデータセットとページを検証します。パネルでデータセットおよびページの概要が表示されます。

      注記

      ナビゲーションは、常にエクスポートされた ZIP ファイルに含まれます。

   3. エクスポートの準備ができたら Download をクリックします。

      カスタマイズした Databuilder データを含む export.zip ファイルがダウンロードされます。

      注記

      Export Wizard パネルで関連するページおよびデータセットを選択する必要があります。データセットとページの両方を選択できない場合はエラーが生成され、export.zip ファイルをダウンロードできません。したがって、少なくとも 1 つのページを選択する必要があります。

   4. Finish をクリックします。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Dashbuilder Data Transfer を選択します。

   警告

   既存システムのデータが上書きされないように、新規インストールした Red Hat Process Automation Manager にのみ、Dashbuilder のデータをインポートするようにしてください。

2. Dashbuilder Data Transfer ページで、Choose File アイコンをクリックします。
3. インポートする ZIP ファイルに移動し、ファイルを選択します。
4. Upload アイコンをクリックします。
5. Import をクリックします。

手順

1. Business Central で、Menu → Design → Pages に移動します。
2. Components パネルで、必要なコンポーネントタイプをキャンバスにドラッグして編集し、Save をクリックして終了します。
3. 画面の右上隅にある Admin アイコンを選択し、Dashbuilder Data Transfer を選択します。
4. Dashbuilder Data Transfer ページで Custom export をクリックします。
5. Export Wizard パネルの ZIP ファイルに追加するページを選択し、Next をクリックします。

6. Export Wizard を選択し、Open をクリックします。

   Dashbuilder Runtime ホームページが表示されます。ログインしていない場合は、ログインページにリダイレクトされます。

7. Dashboards → Runtime Dashboards に移動し、ページが表示されます。

   選択したデータがエクスポートされ、Dashbuilder Runtime により、モデルコンテンツが開いた時に自動的に更新されます。

手順

1. Business Central で、Menu → Design → Projects に移動して、プロジェクト名をクリックします。
2. プロジェクトウィンドウで、Settings タブをクリックします。

3. General Settings タブで以下のタスクを実行します。

   • 他のプロジェクトで同じ GAV を使用できるようにするには、Disable GAV conflict check チェックボックスを選択します。
   • このプロジェクトに GAV エディションを指定できるようにするには、Allow child GAV edition チェックボックスを選択します。

4. Save をクリックします。

   注記

   Reset をクリックして、すべての変更を元に戻すことができます。

5. Save をクリックして、変更を確定します。

手順

1. Business Central で、画面の右上隅にある Admin アイコンを選択し、Projects を選択します。Projects ウィンドウが開きます。

2. Advanced GAV preferences タブで以下のタスクのいずれかを実行します。

   • 他のプロジェクトで同じ GAV を使用できるようにするには、Disable GAV conflict check チェックボックスを選択します。
   • このプロジェクトに GAV エディションを指定できるようにするには、Allow child GAV edition チェックボックスを選択します。
3. Save をクリックします。

手順

1. post-commit Git フックファイルを作成します。

   $ touch post-commit

2. post-commit ファイルのパーミッションを 755 に設定します。

   $ chmod 755 post-commit

3. 以下のように、#!/bin/bash と必要なコードを post-commit ファイルに追加します。

   • すべての変更をリモートリポジトリーにプッシュするには、以下のコマンドを実行します。

     #!/bin/bash
     git push origin +master

   • メッセージをログに記録するには、以下を実行します。

     #!/bin/bash
     echo 'Hello World'

   • 別のファイルのコードを実行するには、以下を実行します。

     #!/bin/bash
     java -jar _EAP_HOME_/bin/.niogit/<SPACE>/<PROJECT_NAME>.git/hooks/git-push.jar

     注記

     post-commit の Git フックを使用して Java コードを実行するには、以下の Java ライブラリーを使用する必要があります。

     • JGit: 内部の Business Central Git リポジトリーと対話するのに使用します。
     • GitHub API for Java: GitHub との通信に使用します。

     post-commit の Git フックと Java コードの例に関する情報は、Business Central post-commit Git Hooks Integration を参照してください。

手順

1. Business Central で、Menu → Projects に移動します。
2. Git プロジェクトをインポートするスペースを選択または作成します。
3. 画面の右側の をクリックして、Import Project を選択します。
4. Import Project ウィンドウで、Git リポジトリーの URL を入力します (例: https://github.com/USERNAME/REPOSITORY_NAME.git および Git リポジトリーの認証情報)。

5. Import をクリックします。

   プロジェクトを Business Central の Git リポジトリーに追加すると、スペースで使用できるようになります。

   重要

   SCP スタイルの SSH URL の代わりに、HTTPS または Git プロトコルを使用します。Business Central は基本的な SSH URL をサポートしないため、この URL を使用する場合はエラーが発生します。

   公開 SSH キーを Git プロバイダーに設定する必要があります。

   Git リポジトリーは、Red Hat Process Automation Manager のバージョンと互換性のある KJAR が 1 つだけ含まれる KJAR プロジェクトでなければなりません。KJAR コンテンツは、リポジトリーのルートに配置する必要があります。

6. コマンド端末で、プロジェクトのリポジトリー Git ディレクトリーにある hooks ディレクトリーに移動します。以下に例を示します。

   $ cd _EAP_HOME_/bin/.niogit/<SPACE>/<PROJECT_NAME>.git/hooks

7. 以下のように、リモート Git リポジトリーに変更をプッシュする post-commit ファイルを作成します。以下に例を示します。

   #!/bin/sh
   git push origin +master

   post-commit の Git フックの作成に関する情報は、「post-commit の Git フックの作成」 を参照してください。

8. 必要に応じて、設定が正常に行われたことを確認するには、Business Central のガイド付きルールを作成します。

   1. Business Central で Menu → Projects → Add Asset → Guided Rule に移動します。
   2. Create new Guided Rule ページで必要な情報を入力します。

   3. OK をクリックします。

      Business Central は、リモートリポジトリーにすべての変更を自動的にプッシュします。

手順

1. コマンド端末で、プロジェクトのリポジトリー Git ディレクトリーにある hooks ディレクトリーに移動します。以下に例を示します。

   $ cd _EAP_HOME_/bin/.niogit/<SPACE>/<PROJECT_NAME>.git/hooks

2. 以下のように、リモート Git リポジトリーに変更をプッシュする post-commit ファイルを作成します。以下に例を示します。

   #!/bin/sh
   git push origin +master

   post-commit の Git フックの作成に関する情報は、「post-commit の Git フックの作成」 を参照してください。

3. 必要に応じて、設定が正常に行われたことを確認するには、Business Central のガイド付きルールを作成します。

   1. Business Central で Menu → Projects → Add Asset → Guided Rule に移動します。
   2. Create new Guided Rule ページで必要な情報を入力します。

   3. OK をクリックします。

      Business Central は、リモートリポジトリーにすべての変更を自動的にプッシュします。

手順

1. ローカルシステムのディレクトリーに post-commit の Git フックを作成します。

   post-commit の Git フックの作成に関する情報は、「post-commit の Git フックの作成」 を参照してください。

2. org.uberfire.nio.git.hooks システムプロパティーの値に、フックファイルが含まれるディレクトリーを指定するには、以下のいずれかのタスクを実行します。

   • org.uberfire.nio.git.hooks システムプロパティーを standalone.xml ファイルに追加します。以下に例を示します。

     <system-properties>
       <property name="org.uberfire.nio.git.hooks" value="_EAP_HOME_/hooks">
       </property>
       ...
     </system-properties>

   • Business Central の実行時に、-Dorg.uberfire.nio.git.hooks 環境変数を使用します。以下に例を示します。

     $ ./standalone.sh -c standalone-full.xml -Dorg.uberfire.nio.git.hooks=_EAP_HOME_/hooks

3. Business Central を起動します。

   post-commit の Git フックは、Business Central の内部リポジトリーとプロジェクトのリポジトリーすべてにコピーされます。

手順

1. 端末ウィンドウで、GitHub リポジトリーをシステムにクローンします。

   $ git clone https://github.com/kiegroup/bc-git-integration-push.git

2. クローンしたリポジトリーに移動します。

   $ cd bc-git-integration-push

3. Maven の新規インストールを実行します。

   $ mvn clean install

4. EAP_HOME ディレクトリーに /hooks ディレクトリーを作成します。

   $ mkdir -p _EAP_HOME_/hooks/

5. git-push-2.1-SNAPSHOT.jar を EAP_HOME/hooks/ ディレクトリーにコピーします。

   $ cp bc-git-integration-push/target/git-push-2.1-SNAPSHOT.jar _EAP_HOME_/hooks/

6. 必要に応じて、テンプレートの .gitremote 設定ファイルを作成するには git-push-2.1-SNAPSHOT.jar を実行します。

   $ java -jar git-push-2.1-SNAPSHOT.jar

   テンプレート .gitremote 設定ファイルの例

   #This is an auto generated template empty property file
   provider=GIT_HUB
   login=
   password=
   token=
   remoteGitUrl=https://api.github.com/
   useSSH=false
   ignore=.*demo.*, test.*
   githubOrg=OrgName
   gitlabGroup=Group/subgroup

7. .gitremote 設定ファイルパラメーターを変更します。

   表44.1 .gitremote パラメーターの例

   パラメーター	説明
   provider	Git プロバイダー。許容値は GIT_HUB と GIT_LAB の 2 つのみ。必須。
   login	Git プロバイダーのユーザー名。必須。
   password	プレーンテキストのパスワードです。token が指定されている場合は必要ありません。
   token	username および password ベースの、安全対策がされていない接続の代わりとなる生成トークン。注記: これが設定されていない場合は、セキュアでない接続を使用している旨の警告が表示されます。password が指定されている場合は必須ではありません。注記: GitLab はトークン認証のみをサポートします。
   remoteGitUrl	パブリックのプロバイダー URL またはプロバイダー用にローカルでホストされたエンタープライズ URL。必須。注記: 公開 GitHub URL は API URL である必要があります。たとえば、api.github.com です。
   useSSH	SSH プロトコルがリモートリポジトリーに変更をプッシュできるようにするブール型。任意。デフォルト値 = false。注記: このパラメーターはローカルの ~/.ssh/ ディレクトリーを使用して SSH 設定を取得します。
   ignore	これらの式のいずれかに一致するプロジェクト名を無視するために、コンマ区切りの正規表現。任意。
   githubOrg	プロバイダーとして GitHub を使用する場合にリポジトリー組織を定義します。任意。
   gitlabGroup	プロバイダーとして GitLab を使用する場合にリポジトリーグループおよびサブグループを定義します。任意。

8. EAP_HOME/hooks に、post-commit Git フックファイルを作成します。

   $ touch post-commit

9. post-commit ファイルのパーミッションを 755 に設定します。

   $ chmod 755 post-commit

10. #!/bin/bash と git-push-2.1-SNAPSHOT.jar を実行するコードを post-commit ファイルに追加します。

    $ echo "#\!/bin/bash\njava -jar $APP_SERVER_HOME/hooks/git-push-2.1-SNAPSHOT.jar" > hooks/post-commit

11. -Dorg.uberfire.nio.git.hooks 環境変数を設定して、Business Central を起動します。以下に例を示します。

    $ ./standalone.sh -c standalone-full.xml -Dorg.uberfire.nio.git.hooks=_EAP_HOME_/hooks

手順

1. *.properties ファイルを作成して、各終了コードに以下の形式の適切なメッセージを 1 行追加してください。

   <exit_code>=<display_message>

   <exit_code> は、Git フックの終了コードに、<display_message> はユーザーに表示するカスタムメッセージに置き換えます。

   以下に例を示します。

   0=Success! All working as expected.
   1=Warning! Please check the logs and advise your admin.
   .
   .
   31=Error! Please advise your admin immediately.

   注記

   考えられる終了コードをすべて *.properties ファイルに定義する必要はありません。*.properties ファイルに定義されている終了コードに対する通知のみが表示されます。

   重要

   通知サービスは、プロパティーファイルに設定されている ISO 8859-1 (LATIN 1) 文字のみサポートします。拡張文字を使用する場合には、Unicode 文字コードのエスケープシーケンスを使用してください。

2. Git フック通知を有効化するには、appformer.git.hooks.bundle システムプロパティーの値としてファイルへのパスを指定します。

   Messages.properties ファイルを参照する設定が含まれている、以下の standalone.xml ファイル例を確認してください。

   <system-properties>
     <property name="appformer.git.hooks.bundle" value="/opt/jboss-as/git-hooks-messages/Messages.properties">
     </property>
     ...
   </system-properties>

手順

1. Business Central で、Menu → Design → Projects に移動します。

2. 必要に応じて、新規コントリビューターを追加します。

   1. プロジェクト名をクリックし、Contributors タブをクリックします。
   2. Add Contributor をクリックします。
   3. テキストフィールドにユーザー名を入力します。
   4. ドロップダウンリストから Contributor のロールタイプを選択します。
   5. OK をクリックします。

3. 関連のコントリビューターのブランチへのアクセス権限をロールベースでカスタマイズします。

   1. Settings → Branch Management をクリックします。
   2. ドロップダウンリストからブランチ名を選択します。
   3. Role Access のセクションで、パーミッションのチェックボックスを選択または選択解除して、利用可能なロールタイプごとにロールベースのブランチアクセスを指定します。
   4. Save をクリックし、再度 Save をクリックして変更を確定します。