Red Hat Process Automation Manager サービスのデプロイおよび管理

手順

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> タグの下に、以下の JVM プロパティーを設定します。

   表2.1 KIE Server インスタンスの JVM プロパティー

   プロパティー	値	注記
   org.kie.server.id	default-kie-server	KIE Server ID。
   org.kie.server.controller	http://localhost:8080/business-central/rest/controller	Business Central の場所Business Central の API に接続する URL。
   org.kie.server.controller.user	controllerUser	Business Central にログイン可能な rest-all ロールを持つユーザー名。
   org.kie.server.controller.pwd	controllerUser1234;	Business Central にログインできるユーザーのパスワード。
   org.kie.server.location	http://localhost:8080/kie-server/services/rest/server	KIE Server の場所KIE Server の API に接続する URL。

   表2.2 Business Central インスタンスの JVM プロパティー

   プロパティー	値	注記
   org.kie.server.user	controllerUser	kie-server ロールを持つユーザー名。
   org.kie.server.pwd	controllerUser1234;	ユーザーのパスワード。

   以下の例は、KIE Server インスタンスを設定する方法を示しています。

   <property name="org.kie.server.id" value="default-kie-server"/>
   <property name="org.kie.server.controller" value="http://localhost:8080/business-central/rest/controller"/>
   <property name="org.kie.server.controller.user" value="controllerUser"/>
   <property name="org.kie.server.controller.pwd" value="controllerUser1234;"/>
   <property name="org.kie.server.location" value="http://localhost:8080/kie-server/services/rest/server"/>

   以下の例は、Business Central インスタンスに設定する方法を示しています。

   <property name="org.kie.server.user" value="controllerUser"/>
   <property name="org.kie.server.pwd" value="controllerUser1234;"/>

3. KIE サーバーが正常に起動したことを確認するには、KIE サーバーが動作しているときに、http://SERVER:PORT/kie-server/services/rest/server/ に GET リクエストを送信します。KIE サーバー上での Red Hat Process Automation Manager の実行に関する詳細は、Red Hat Process Automation Manager の実行 を参照してください。

   認証に成功すると、以下の例のような XML 応答が返されます。

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

4. 登録が正常に完了したことを確認します。

   1. Business Central にログインします。

   2. Menu → Deploy → Execution Servers の順にクリックします。

      正常に登録されている場合は、登録されたサーバーの ID が表示されます。

手順

1. KIE Server の環境モードを設定するには、org.kie.server.mode システムプロパティーを org.kie.server.mode=development または org.kie.server.mode=production に設定します。

2. Business Central のプロジェクトにデプロイメントの動作を設定するには、プロジェクトの Settings → General Settings → Version に移動して、Development Mode オプションを切り替えます。

   注記

   デフォルトでは、KIE Server および Business Central のすべての新規プロジェクトは開発モードになっています。

   Development Mode をオンにしたプロジェクトをデプロイしたり、実稼働モードになっている KIE Server に手動で SNAPSHOT バージョンの接尾辞を追加したプロジェクトをデプロイしたりすることはできません。

手順

1. 外部リポジトリーの接続およびアクセスの詳細が含まれる Maven settings.xml ファイルを作成します。settings.xml ファイルの詳細は Maven の Settings Reference を参照してください。
2. 既知の場所 (例: /opt/custom-config/settings.xml) にファイルを保存します。
3. Red Hat Process Automation Manager インストールディレクトリーで、standalone-full.xml ファイルに移動します。たとえば、Red Hat Process Automation Manager に Red Hat JBoss EAP インストールを使用する場合は $EAP_HOME/standalone/configuration/standalone-full.xml に移動します。

4. standalone-full.xml の <system-properties> タグで、kie.maven.settings.custom プロパティーに settings.xml ファイルのフルパス名を設定します。

   以下に例を示します。

   <property name="kie.maven.settings.custom" value="/opt/custom-config/settings.xml"/>

5. Business Central と KIE Server を起動または再起動します。

手順

1. Business Central で Menu → Design → Projects に移動して、プロジェクト名をクリックし、プロジェクト内の任意のアセットを選択します。
2. 画面左側の Project Explorer メニューで Customize View ギアアイコンをクリックし、Repository View → pom.xml を選択します。

3. プロジェクトの pom.xml ファイルの最後 (</project> の終了タグの前) に以下の設定を追加します。値は、settings.xml ファイルに定義した設定に対応する必要があります。

   <distributionManagement>
   <repository>
   <id>${maven-repo-id}</id>
   <url>${maven-repo-url}</url>
   <layout>default</layout>
   </repository>
   </distributionManagement>

4. Save をクリックして pom.xml ファイルの変更を保存します。

手順

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

2. 右上隅で Deploy をクリックしてプロジェクトをビルドし、KIE Server にデプロイします。KIE Server にデプロイせずにプロジェクトをコンパイルするには、Build をクリックします。

   注記

   Build & Install オプションを選択してプロジェクトをビルドし、KJAR ファイルを KIE Server にデプロイせずに設定済みの Maven リポジトリーに公開することもできます。開発環境では、Deploy をクリックすると、ビルドされた KJAR ファイルを KIE Server に、実行中のインスタンス (がある場合はそれ) を停止せずにデプロイできます。または Redeploy をクリックして、ビルドされた KJAR ファイルをデプロイしてすべてのインスタンスを置き換えることもできます。次回、ビルドされた KJAR ファイルをデプロイまたは再デプロイすると、以前のデプロイメントユニット (KIE コンテナー) が同じターゲット KIE Server で自動的に更新されます。実稼働環境では Redeploy オプションは無効になっており、Deploy をクリックして、ビルドされた KJAR ファイルを KIE Server 上の新規デプロイメントユニット (KIE コンテナー) にデプロイすることのみが可能です。

   KIE Server の環境モードを設定するには、org.kie.server.mode システムプロパティーを org.kie.server.mode=development または org.kie.server.mode=production に設定します。Business Central の対応するプロジェクトでのデプロイメント動作を設定するには、プロジェクトの Settings → General Settings → Version に移動し、Development Mode オプションを選択します。デフォルトでは、KIE Server および Business Central のすべての新規プロジェクトは開発モードになっています。Development Mode をオンにしたプロジェクトをデプロイしたり、実稼働モードになっている KIE Server に手動で SNAPSHOT バージョンの接尾辞を追加したプロジェクトをデプロイしたりすることはできません。

   Business Central に KIE Server を 1 つだけ接続する場合、または接続したすべての KIE Server が同じサーバー設定にある場合は、デプロイメントユニット (KIE コンテナー) にあるプロジェクトのサービスが自動的に起動します。

   複数のサーバー設定が利用できる場合は、サーバーとデプロイメントの詳細の入力を求めるデプロイメントダイアログが Business Central に表示されます。

3. デプロイメントダイアログが表示されたら、以下の値を確認または設定します。

   • Deployment Unit Id / Deployment Unit Alias: KIE Server でサービスを実行しているデプロイメントユニット (KIE コンテナー) の名前およびエイリアスを確認します。通常は、この設定を変更する必要はありません。KIE コンテナーのエイリアスの詳細は、「KIE コンテナーのエイリアス」 を参照してください。
   • Server Configuration: このプロジェクトをデプロイするサーバー設定を選択します。後で、プロジェクトを再ビルドしなくても、設定したその他のサーバーにデプロイできます。
   • Start Deployment Unit?: デプロイメントユニット (KIE コンテナー) を開始するためにこのボックスが選択されていることを確認します。このボックスの選択を解除すると、サービスはサーバーにデプロイされますが、起動されません。

   プロジェクトのデプロイメントに関する詳細を確認するには、画面の上部にあるデプロイメントバナーの View deployment details か、Deploy のドロップダウンメニューをクリックします。このオプションを使用すると、Menu → Deploy → Execution Servers ページに移動します。

手順

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

3. 必要に応じて、General Settings の Group ID フィールド、Artifact IDフィールド、または Version フィールドを修正します。プロジェクトをデプロイし、新しいバージョンを開発中の場合、通常はバージョン番号を変更する必要があります。

   注記

   開発目的でのみ、プロジェクトの Settings → General Settings → Version で Development Mode オプションを切り替えて、プロジェクトバージョンに SNAPSHOT の接尾辞を追加できます。この接尾辞で、Maven に対して、Maven ポリシーに従って新しいスナップショットの更新を取得するように指示します。開発モード を使用したり、手動で実稼働環境に SNAPSHOT バージョンの接尾辞を追加したりしないでください。

4. Save をクリックして終了します。

手順

1. プロジェクトの ~/resources/META-INF ディレクトリーに、最低でも以下の内容を含む kmodule.xml メタデータを作成します。

   <?xml version="1.0" encoding="UTF-8"?>
   <kmodule xmlns="http://www.drools.org/xsd/kmodule">
   </kmodule>

   プロジェクトの resources パスで見つかったすべてのファイルを含むデフォルトの KIE ベースを 1 つ作成するには、この空の kmodule.xml ファイルで十分です。デフォルトの KIE ベースには、ビルド時にアプリケーションに KIE コンテナーを作成する際に発生するデフォルト KIE セッションも 1 つ含まれます。

   以下は、より高度な kmodule.xml ファイルの例です。

   <?xml version="1.0" encoding="UTF-8"?>
   <kmodule xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.drools.org/xsd/kmodule">
     <configuration>
         <property key="drools.evaluator.supersetOf" value="org.mycompany.SupersetOfEvaluatorDefinition"/>
     </configuration>
     <kbase name="KBase1" default="true" eventProcessingMode="cloud" equalsBehavior="equality" declarativeAgenda="enabled" packages="org.domain.pkg1">
       <ksession name="KSession1_1" type="stateful" default="true" />
       <ksession name="KSession1_2" type="stateful" default="true" beliefSystem="jtms" />
     </kbase>
     <kbase name="KBase2" default="false" eventProcessingMode="stream" equalsBehavior="equality" declarativeAgenda="enabled" packages="org.domain.pkg2, org.domain.pkg3" includes="KBase1">
       <ksession name="KSession2_1" type="stateless" default="true" clockType="realtime">
         <fileLogger file="debugInfo" threaded="true" interval="10" />
         <workItemHandlers>
           <workItemHandler name="name" type="new org.domain.WorkItemHandler()" />
         </workItemHandlers>
         <listeners>
           <ruleRuntimeEventListener type="org.domain.RuleRuntimeListener" />
           <agendaEventListener type="org.domain.FirstAgendaListener" />
           <agendaEventListener type="org.domain.SecondAgendaListener" />
           <processEventListener type="org.domain.ProcessListener" />
         </listeners>
       </ksession>
     </kbase>
   </kmodule>

   この例では、KIE ベースが 2 つ定義されます。ルールアセットの特定の パッケージ は両方 KIE ベースに含まれます。このようにパッケージを指定した場合は、指定したパッケージを反映するディレクトリー構造にルールファイルを整理する必要があります。KIE ベース KBase1 から 2 つの KIE セッションをインスタンス化し、KBase2 から KIE セッションを 1 つインスタンス化します。KBase2 の KIE セッションは ステートレス な KIE セッションですが、これは 1 つ前の KIE セッションで呼び出されたデータ (1 つ前のセッションの状態) が、セッションの呼び出しと呼び出しの間で破棄されることを示しています。また、その KIE セッションには、ファイル (またはコンソール) ロガー、WorkItemHandler、サポートされる 3 種類のリスナー (ruleRuntimeEventListener、agendaEventListener、および processEventListener) も指定されます。<configuration> 要素は、kmodule.xml ファイルをさらにカスタマイズするのに使用できる任意のプロパティーを定義します。

   プロジェクトに kmodule.xml ファイルを手動で追加する代わりに、Java アプリケーションの KieModuleModel インスタンスを使用するか、プログラムで kmodule.xml ファイルを作成し、KIE ベースおよび KIE セッションを定義し、KIE 仮想ファイルシステム KieFileSystem に、プロジェクトのリソースをすべて追加します。

   プログラムを使用して kmodule.xml を作成し、KieFileSystem に追加

   import org.kie.api.KieServices;
   import org.kie.api.builder.model.KieModuleModel;
   import org.kie.api.builder.model.KieBaseModel;
   import org.kie.api.builder.model.KieSessionModel;
   import org.kie.api.builder.KieFileSystem;
   
   KieServices kieServices = KieServices.Factory.get();
   KieModuleModel kieModuleModel = kieServices.newKieModuleModel();
   
   KieBaseModel kieBaseModel1 = kieModuleModel.newKieBaseModel("KBase1")
     .setDefault(true)
     .setEqualsBehavior(EqualityBehaviorOption.EQUALITY)
     .setEventProcessingMode(EventProcessingOption.STREAM);
   
   KieSessionModel ksessionModel1 = kieBaseModel1.newKieSessionModel("KSession1_1")
     .setDefault(true)
     .setType(KieSessionModel.KieSessionType.STATEFUL)
     .setClockType(ClockTypeOption.get("realtime"));
   
   KieFileSystem kfs = kieServices.newKieFileSystem();
   kfs.writeKModuleXML(kieModuleModel.toXML());

2. 手動またはプログラムで kmodule.xml ファイルをプロジェクトに設定したら、設定を検証する KIE コンテナーから KIE ベースおよび KIE セッションを取得します。

   KieServices kieServices = KieServices.Factory.get();
   KieContainer kContainer = kieServices.getKieClasspathContainer();
   
   KieBase kBase1 = kContainer.getKieBase("KBase1");
   KieSession kieSession1 = kContainer.newKieSession("KSession1_1"),
       kieSession2 = kContainer.newKieSession("KSession1_2");
   
   KieBase kBase2 = kContainer.getKieBase("KBase2");
   StatelessKieSession kieSession3 = kContainer.newStatelessKieSession("KSession2_1");

   kmodule.xml ファイルに、KieBase または KieSession を default="true" と設定している場合は、先ほどの kmodule.xml 例のように、名前を渡さずに KIE コンテナーから取得できます。

   KieContainer kContainer = ...
   
   KieBase kBase1 = kContainer.getKieBase();
   KieSession kieSession1 = kContainer.newKieSession(),
       kieSession2 = kContainer.newKieSession();
   
   KieBase kBase2 = kContainer.getKieBase();
   StatelessKieSession kieSession3 = kContainer.newStatelessKieSession();

   Red Hat Process Automation Manager ディストリビューションの以下のシステムプロパティーの値を変更して、デシジョンエンジンにキャッシュする KIE モジュールまたはアーティファクトバージョンの最大数を増減できます。

   • kie.repository.project.cache.size: デシジョンエンジンにキャッシュする最大 KIE モジュール数。デフォルト値は 100 です。
   • kie.repository.project.versions.cache.size: デシジョンエンジンにキャッシュする同一のアーティファクトに対して最大指定可能なバージョン数。デフォルト値は 10 です。

   KIE リポジトリー設定の完全一覧については、Red Hat カスタマーポータル から Red Hat Process Automation Manager 7.11.0 Source Distribution の ZIP ファイルをダウンロードして、~/rhpam-7.11.0-sources/src/drools-$VERSION/drools-compiler/src/main/java/org/drools/compiler/kie/builder/impl/KieRepositoryImpl.java に移動してください。

手順

1. Maven プロジェクトの pom.xml ファイルで、パッケージタイプを kjar に設定し、kie-maven-plugin ビルドコンポーネントを追加します。

   <packaging>kjar</packaging>
   ...
   <build>
     <plugins>
       <plugin>
         <groupId>org.kie</groupId>
         <artifactId>kie-maven-plugin</artifactId>
         <version>${rhpam.version}</version>
         <extensions>true</extensions>
       </plugin>
     </plugins>
   </build>

   kjar パッケージングタイプは、kie-maven-plugin コンポーネントをアクティブにして、アーティファクトリーソースを検証してプリコンパイルします。<version> は、プロジェクトで現在使用している Red Hat Process Automation Manager の Maven アーティファクトバージョンです (例: 7.52.0.Final-redhat-00007)。これらの設定は、デプロイメント用に Maven プロジェクトを適切にパッケージ化する必要があります。

   注記

   個別の依存関係に対して Red Hat Process Automation Manager <version> を指定するのではなく、Red Hat Business Automation BOM (bill of materials) の依存関係をプロジェクトの pom.xml ファイルに追加することを検討してください。Red Hat Business Automation BOM は、Red Hat Decision Manager と Red Hat Process Automation Manager の両方に適用されます。BOM ファイルを追加すると、提供される Maven リポジトリーから、推移的依存関係の適切なバージョンがプロジェクトに含められます。

   BOM 依存関係の例:

   <dependency>
     <groupId>com.redhat.ba</groupId>
     <artifactId>ba-platform-bom</artifactId>
     <version>7.11.0.redhat-00005</version>
     <scope>import</scope>
     <type>pom</type>
   </dependency>

   Red Hat Business Automation BOM (Bill of Materials) に関する詳細情報は、What is the mapping between Red Hat Process Automation Manager and the Maven library version? を参照してください。

2. 必要に応じて、プロジェクトに Decision Model and Notation (DMN) アセットが含まれる場合は、pom.xml ファイルに以下の依存関係を追加して、DMN 実行可能モデルを有効にしてください。DMN 実行可能モデルを使用すると、DMN プロジェクトの DMN デシジョンテーブルロジックをより効果的に評価できるようになります。

   <dependency>
     <groupId>org.kie</groupId>
     <artifactId>kie-dmn-core</artifactId>
     <scope>provided</scope>
     <version>${rhpam.version}</version>
   </dependency>

3. Maven プロジェクトの ~/resources ディレクトリーに、最低でも以下の内容を含む META-INF/kmodule.xml メタデータファイルを作成します。

   <?xml version="1.0" encoding="UTF-8"?>
   <kmodule xmlns="http://www.drools.org/xsd/kmodule">
   </kmodule>

   この kmodule.xml ファイルは、すべての Red Hat Process Automation Manager プロジェクトに必要な KIE モジュール記述子です。KIE モジュールを使用して、1 つ以上の KIE ベースを定義し、各 KIE ベースに 1 つ以上の KIE セッションを定義します。

   kmodule.xml 設定の詳細は 「KIE モジュール記述子ファイルの設定」 を参照してください。

4. Maven プロジェクトの関連リソースで、.java クラスを設定して KIE コンテナーおよび KIE セッションを作成して、KIE ベースを読み込みます。

   import org.kie.api.KieServices;
   import org.kie.api.runtime.KieContainer;
   import org.kie.api.runtime.KieSession;
   
   public void testApp() {
   
     // Load the KIE base:
     KieServices ks = KieServices.Factory.get();
     KieContainer kContainer = ks.getKieClasspathContainer();
     KieSession kSession = kContainer.newKieSession();
   
   }

   この例では、KIE コンテナーは、testApp プロジェクトのクラスパスからビルドしたファイルを読み込みます。KieServices API を使用すれば、KIE ビルド設定およびランタイム設定のすべてにアクセスできます。

   プロジェクトの ReleaseId を KieServices API に渡して KIE コンテナーを作成することもできます。ReleaseId は、プロジェクトの pom.xml ファイルの GroupId 値、ArtifactId 値、Version 値 (GAV) から生成します。

   import org.kie.api.KieServices;
   import org.kie.api.builder.ReleaseId;
   import org.kie.api.runtime.KieContainer;
   import org.kie.api.runtime.KieSession;
   import org.drools.compiler.kproject.ReleaseIdImpl;
   
   public void testApp() {
   
     // Identify the project in the local repository:
     ReleaseId rid = new ReleaseIdImpl("com.sample", "my-app", "1.0.0");
   
     // Load the KIE base:
     KieServices ks = KieServices.Factory.get();
     KieContainer kContainer = ks.newKieContainer(rid);
     KieSession kSession = kContainer.newKieSession();
   
   }

5. コマンドターミナルで Maven プロジェクトディレクトリーに移動し、以下のコマンドを実行してプロジェクトをビルドします。

   mvn clean install

   DMN 実行可能なモデルの場合は、以下のコマンドを実行します。

   mvn clean install -DgenerateDMNModel=YES

   ビルドに失敗したら、コマンドラインのエラーメッセージに記載されている問題に対応し、ビルドに成功するまでファイルの妥当性確認を行います。

   注記

   デフォルトで Maven プロジェクト内のルールアセットが実行可能なルールモデルからビルドされない場合は、以下の依存関係がプロジェクトの pom.xml ファイルに含まれていることを確認して、プロジェクトを再構築してください。

   <dependency>
     <groupId>org.drools</groupId>
     <artifactId>drools-model-compiler</artifactId>
     <version>${rhpam.version}</version>
   </dependency>

   この依存関係は、デフォルトで Red Hat Process Automation Manager のルールアセットが実行可能なルールモデルからビルドされるために必要です。Red Hat Process Automation Manager のコアパッケージに、この依存関係は同梱されていますが、Red Hat Process Automation Manager のアップグレード履歴によっては、この依存関係を手動で追加して、実行可能なルールモデルの動作を有効にする必要がある場合があります。

   実行可能なルールモデルの詳細は、「実行可能ルールモデル」 を参照してください。

6. プロジェクトをローカルで正常にビルドしてテストした後に、プロジェクトをリモートの Maven リポジトリーにデプロイします。

   mvn deploy

手順

1. 必要に応じて、プロジェクトに Decision Model and Notation (DMN) アセットが含まれる場合は、Java プロジェクトの該当のクラスパスに以下の依存関係を追加して、DMN 実行可能モデルを有効にしてください。DMN 実行可能モデルを使用すると、DMN プロジェクトの DMN デシジョンテーブルロジックをより効果的に評価できるようになります。

   <dependency>
     <groupId>org.kie</groupId>
     <artifactId>kie-dmn-core</artifactId>
     <scope>provided</scope>
     <version>${rhpam.version}</version>
   </dependency>

   <version> は、プロジェクトで現在使用している Red Hat Process Automation Manager の Maven アーティファクトバージョンです (例: 7.52.0.Final-redhat-00007)。

   注記

   個別の依存関係に対して Red Hat Process Automation Manager <version> を指定するのではなく、Red Hat Business Automation BOM (bill of materials) の依存関係をプロジェクトの pom.xml ファイルに追加することを検討してください。Red Hat Business Automation BOM は、Red Hat Decision Manager と Red Hat Process Automation Manager の両方に適用されます。BOM ファイルを追加すると、提供される Maven リポジトリーから、推移的依存関係の適切なバージョンがプロジェクトに含められます。

   BOM 依存関係の例:

   <dependency>
     <groupId>com.redhat.ba</groupId>
     <artifactId>ba-platform-bom</artifactId>
     <version>7.11.0.redhat-00005</version>
     <scope>import</scope>
     <type>pom</type>
   </dependency>

   Red Hat Business Automation BOM (Bill of Materials) に関する詳細情報は、What is the mapping between Red Hat Process Automation Manager and the Maven library version? を参照してください。

2. KieServices API を使用して、必要な KIE ベースおよび KIE セッションを持つ KieModuleModel インスタンスを作成します。KieServices API を使用すれば、KIE ビルド設定およびランタイム設定のすべてにアクセスできます。KieModuleModel インスタンスは、プロジェクトの kmodule.xml ファイルを生成します。

   kmodule.xml 設定の詳細は 「KIE モジュール記述子ファイルの設定」 を参照してください。

3. KieModuleModel インスタンスを XML に変換し、XML を KieFileSystem に追加します。

   プログラムを使用して kmodule.xml を作成し、KieFileSystem に追加

   import org.kie.api.KieServices;
   import org.kie.api.builder.model.KieModuleModel;
   import org.kie.api.builder.model.KieBaseModel;
   import org.kie.api.builder.model.KieSessionModel;
   import org.kie.api.builder.KieFileSystem;
   
     KieServices kieServices = KieServices.Factory.get();
     KieModuleModel kieModuleModel = kieServices.newKieModuleModel();
   
     KieBaseModel kieBaseModel1 = kieModuleModel.newKieBaseModel("KBase1")
       .setDefault(true)
       .setEqualsBehavior(EqualityBehaviorOption.EQUALITY)
       .setEventProcessingMode(EventProcessingOption.STREAM);
   
     KieSessionModel ksessionModel1 = kieBaseModel1.newKieSessionModel("KSession1")
       .setDefault(true)
       .setType(KieSessionModel.KieSessionType.STATEFUL)
       .setClockType(ClockTypeOption.get("realtime"));
   
     KieFileSystem kfs = kieServices.newKieFileSystem();
     kfs.writeKModuleXML(kieModuleModel.toXML());

4. プロジェクトで使用する残りの Red Hat Process Automation Manager アセットをすべて KieFileSystem インスタンスに追加します。アーティファクトは、Maven プロジェクトファイル構造に含まれる必要があります。

   import org.kie.api.builder.KieFileSystem;
   
     KieFileSystem kfs = ...
     kfs.write("src/main/resources/KBase1/ruleSet1.drl", stringContainingAValidDRL)
       .write("src/main/resources/dtable.xls",
         kieServices.getResources().newInputStreamResource(dtableFileStream));

   この例では、プロジェクトアセットは、String 変数および Resource インスタンスの両方として追加されます。Resource インスタンスは KieResources ファクトリーを使用して作成され、KieServices インスタンスにより提供されます。KieResources クラスは、InputStream オブジェクト、URL オブジェクト、および File オブジェクト、またはファイルシステムのパスを示す String を、KieFileSystem が管理する Resource インスタンスに変換する factory メソッドを提供します。

   プロジェクトのアーティファクトを KieFileSystem に追加する際に、ResourceType プロパティーを Resource オブジェクトに明示的に割り当てることもできます。

   import org.kie.api.builder.KieFileSystem;
   
     KieFileSystem kfs = ...
     kfs.write("src/main/resources/myDrl.txt",
       kieServices.getResources().newInputStreamResource(drlStream)
         .setResourceType(ResourceType.DRL));

5. buildAll() メソッドと KieBuilder を併用して KieFileSystem のコンテンツをビルドし、KIE コンテナーを作成してデプロイします。

   import org.kie.api.KieServices;
   import org.kie.api.KieServices.Factory;
   import org.kie.api.builder.KieFileSystem;
   import org.kie.api.builder.KieBuilder;
   import org.kie.api.runtime.KieContainer;
   
     KieServices kieServices = KieServices.Factory.get();
     KieFileSystem kfs = ...
   
     KieBuilder kieBuilder = ks.newKieBuilder( kfs );
     kieBuilder.buildAll()
     assertEquals(0, kieBuilder.getResults().getMessages(Message.Level.ERROR).size());
   
     KieContainer kieContainer = kieServices
       .newKieContainer(kieServices.getRepository().getDefaultReleaseId());

   ERROR ビルドは、プロジェクトのコンパイルに失敗し、KieModule が作成されず、KieRepository シングルトンに何も追加されないことを示しています。WARNING または INFO の結果は、プロジェクトのコンパイルが成功したことと、ビルドプロセスの詳細を示しています。

   注記

   実行可能なルールモデルから Java アプリケーションプロジェクトでルールアセットをビルドするには、プロジェクトの pom.xml ファイルに以下の依存関係があることを確認します。

   <dependency>
     <groupId>org.drools</groupId>
     <artifactId>drools-model-compiler</artifactId>
     <version>${rhpam.version}</version>
   </dependency>

   この依存関係は、Red Hat Process Automation Manager のルールアセットが実行可能なルールモデルからビルドされるために必要です。Red Hat Process Automation Manager のコアパッケージに、この依存関係は同梱されていますが、Red Hat Process Automation Manager のアップグレード履歴によっては、この依存関係を手動で追加して、実行可能なルールモデルの動作を有効にする必要がある場合があります。

   依存関係を確認したあとに、以下のように変更した buildAll() オプションを使用して実行可能なモデルを有効にします。

   kieBuilder.buildAll(ExecutableModelProject.class)

   実行可能なルールモデルの詳細は、「実行可能ルールモデル」 を参照してください。

手順

1. プロジェクト内の、該当する .java クラスで、以下のコード例のように、KIE スキャナーを登録して起動します。

   KIE コンテナー向けの KIE スキャナーの登録および起動

   import org.kie.api.KieServices;
   import org.kie.api.builder.ReleaseId;
   import org.kie.api.runtime.KieContainer;
   import org.kie.api.builder.KieScanner;
   
   ...
   
   KieServices kieServices = KieServices.Factory.get();
   ReleaseId releaseId = kieServices
     .newReleaseId("com.sample", "my-app", "1.0-SNAPSHOT");
   KieContainer kContainer = kieServices.newKieContainer(releaseId);
   KieScanner kScanner = kieServices.newKieScanner(kContainer);
   
   // Start KIE scanner for polling the Maven repository every 10 seconds (10000 ms)
   kScanner.start(10000L);

   この例では、KIE スキャナーは一定の間隔で実行されるように設定しています。KIE スキャナーの最小のポーリング間隔は 1 ミリ秒 (ms) で、最大のポーリング間隔はデータ型 long の最大値です。ポーリングの間隔が 0 以下の場合は、java.lang.IllegalArgumentException: pollingInterval must be positive エラーが発生します。また、KIE スキャナーを scanNow() メソッドで呼び出してオンデマンドで実行するように設定することも可能です。

   この例のプロジェクトグループ ID、アーティファクト ID、およびバージョン (GAV) の設定は、com.sample:my-app:1.0-SNAPSHOT で設定されています。プロジェクトバージョンには、-SNAPSHOT の接尾辞を含めて、KIE スキャナーが指定のアーティファクトバージョンの最新ビルドを取得できるようにする必要があります。1.0.1-SNAPSHOT への更新など、スナップショットのプロジェクトバージョン番号を変更する場合は、KIE スキャナー設定の GAV 定義のバージョンも更新する必要があります。KIE スキャナーは、com.sample:my-app:1.0 など、静的バージョンのプロジェクトの更新を取得しません。

2. Maven リポジトリーの settings.xml ファイルで、updatePolicy 設定を always に指定し、KIE スキャナーが正しく機能するようにします。

   <profile>
     <id>guvnor-m2-repo</id>
     <repositories>
       <repository>
         <id>guvnor-m2-repo</id>
         <name>BA Repository</name>
         <url>http://localhost:8080/business-central/maven2/</url>
         <layout>default</layout>
         <releases>
           <enabled>true</enabled>
           <updatePolicy>always</updatePolicy>
         </releases>
         <snapshots>
           <enabled>true</enabled>
           <updatePolicy>always</updatePolicy>
         </snapshots>
       </repository>
     </repositories>
   </profile>

   KIE スキャナーがポーリングを開始した後に、KIE スキャナーが指定の KIE コンテナーで SNAPSHOT プロジェクトの更新バージョンを検出した場合に、KIE スキャナーは自動的に新しいプロジェクトバージョンをダウンロードして、新規プロジェクトのインクリメンタルビルドをトリガーします。この時点以降、KIE コンテナーから作成された新規の KieBase オブジェクトおよび KieSession オブジェクトで、新規プロジェクトバージョンが使用されるようになります。

   KIE Server API を使用して KIE スキャナーを開始または停止する方法は、KIE API を使用した Red Hat Process Automation Manager の操作 を参照してください。

手順

1. Business Central で、Menu → Design → Projects に移動します。
2. 画面の右上隅にある Try Samples の横にある矢印をクリックし、Try Samples を選択します。
3. Mortgage_Process を選択し、OK をクリックします。プロジェクトの Assets ビューを開きます。
4. 変更するアセットをクリックします。アセットは、プロジェクト要件に合わせて、すべて編集できます。

手順

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

手順

1. Business Central で、Menu → Design → Projects に移動します。
2. Mortgage_Process のサンプルプロジェクトなど、新規ブランチを作成するプロジェクトをクリックします。

3. master → Add Branch をクリックします。

   図12.1 新規ブランチの作成メニュー

   
4. Name フィールドに testBranch1 と入力して、Add Branch ウィンドウから master を選択します。testBranch1 は、新規ブランチに指定する名前に置き換えます。
5. Add Branch ウィンドウから、新規ブランチのベースとなるブランチを選択します。既存のブランチであれば、どれでも選択できます。

6. Add をクリックします。

   図12.2 新規ブランチ追加のウィンドウ

   

手順

1. 現在のブランチ名をクリックして、ドロップダウンリストから任意のプロジェクトブランチを選択します。

   図12.3 ブランチメニューの選択

   

手順

1. 画面の右上隅の をクリックして、Delete Branch を選択します。

   図12.4 ブランチの削除

   
2. Delete Branch ウィンドウで、削除するブランチの名前を入力します。
3. Delete Branch をクリックします。ブランチが削除され、プロジェクトブランチが master ブランチに切り替わります。

手順

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

2. 右上隅の Deploy をクリックしてプロジェクトをビルドし、KIE Server にデプロイします。

   注記

   Build & Install オプションを選択してプロジェクトをビルドし、KJAR ファイルを KIE Server にデプロイせずに設定済みの Maven リポジトリーに公開することもできます。開発環境では、Deploy をクリックすると、ビルドされた KJAR ファイルを KIE Server に、実行中のインスタンス (がある場合はそれ) を停止せずにデプロイできます。または Redeploy をクリックして、ビルドされた KJAR ファイルをデプロイしてすべてのインスタンスを置き換えることもできます。次回、ビルドされた KJAR ファイルをデプロイまたは再デプロイすると、以前のデプロイメントユニット (KIE コンテナー) が同じターゲット KIE Server で自動的に更新されます。実稼働環境では Redeploy オプションは無効になっており、Deploy をクリックして、ビルドされた KJAR ファイルを KIE Server 上の新規デプロイメントユニット (KIE コンテナー) にデプロイすることのみが可能です。

   KIE Server の環境モードを設定するには、org.kie.server.mode システムプロパティーを org.kie.server.mode=development または org.kie.server.mode=production に設定します。Business Central の対応するプロジェクトでのデプロイメント動作を設定するには、プロジェクトの Settings → General Settings → Version に移動し、Development Mode オプションを選択します。デフォルトでは、KIE Server および Business Central のすべての新規プロジェクトは開発モードになっています。Development Mode をオンにしたプロジェクトをデプロイしたり、実稼働モードになっている KIE Server に手動で SNAPSHOT バージョンの接尾辞を追加したプロジェクトをデプロイしたりすることはできません。

   ビルドに失敗したら、画面下部の Alerts パネルに記載されている問題に対処します。

   プロジェクトのデプロイメントに関する詳細を確認するには、画面の上部にあるデプロイメントバナーの View deployment details か、Deploy のドロップダウンメニューをクリックします。このオプションを使用すると、Menu → Deploy → Execution Servers ページに移動します。

   プロジェクトデプロイメントのオプションに関する詳細は、Red Hat Process Automation Manager プロジェクトのパッケージ化およびデプロイ を参照してください。

手順

1. Business Central で、Menu → Design → Projects に移動して、マージする変更内容が含まれるスペースとプロジェクトを選択します。

2. プロジェクトページで、変更が含まれるブランチを選択します。

   図13.1 ブランチメニューの選択

   

3. 変更要求を送信するには、以下のいずれかのタスクを実行します。

   • 画面の右上隅の をクリックして、Submit Change Request を選択します。

   • Change Requests タブをクリックし、Submit Change Request をクリックします。

     Submit Change Request ウィンドウが表示されます。

4. 概要と説明を入力し、ターゲットブランチを選択して Submit をクリックします。ターゲットブランチは、変更のマージ先のブランチです。Submit をクリックすると、変更要求ウィンドウが表示されます。

手順

1. Business Central で、Menu → Design → Projects に移動して、スペースとプロジェクトを選択します。

2. プロジェクトページで、正しいブランチを指定していることを確認します。

   
3. Change Requests タブをクリックします。保留中の変更要求の一覧が表示されます。
4. 変更要求をフィルターリングするには、Search ボックスの左側にある Open、Closed、または All を選択します。
5. 特定の変更要求を検索するには、Search ボックスに ID またはテキストを入力し、拡大鏡をクリックします。

6. 変更要求の詳細を表示するには、概要リンクをクリックします。変更要求ウィンドウには、タブが 2 つあります。

   1. 変更要求に関する全般情報については、Overview タブを確認してください。
   2. Changed Files タブをクリックし、ファイルを展開して、変更案を確認します。

7. 右上隅のボタンをクリックします。

   • Squash and Merge をクリックして、全コミットを 1 つのコミットにまとめて、まとめたコミットをターゲットブランチにマージします。
   • 変更をターゲットブランチにマージするには、Merge をクリックします。
   • また、変更を拒否し、ターゲットブランチに変更を加えないようにするには、Reject をクリックします。
   • 拒否も許可もせずに、変更要求を閉じるには、Close をクリックします。変更要求を閉じることができるのは、この要求を送信したユーザーのみです。
   • 変更せずにプロジェクトウィンドウに戻るには、Cancel をクリックします。

手順

1. [GET] /server/containers など、要求の送信先に適した API endpoint を特定し、KIE Server から KIE コンテナーを取得します。

2. REST クライアントまたは curl ユーティリティーで、/server/containers への GET 要求に以下のコンポーネントを記入します。ご自分のユースケースに合わせて、要求詳細を調整します。

   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/server/containers となります。

   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/server/containers となります。

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -X GET "http://localhost:8080/kie-server/services/rest/server/containers"

3. 要求を実行し、KIE Server の応答を確認します。

   サーバー応答の例 (JSON):

   {
     "type": "SUCCESS",
     "msg": "List of created containers",
     "result": {
       "kie-containers": {
         "kie-container": [
           {
             "container-id": "itorders_1.0.0-SNAPSHOT",
             "release-id": {
               "group-id": "itorders",
               "artifact-id": "itorders",
               "version": "1.0.0-SNAPSHOT"
             },
             "resolved-release-id": {
               "group-id": "itorders",
               "artifact-id": "itorders",
               "version": "1.0.0-SNAPSHOT"
             },
             "status": "STARTED",
             "scanner": {
               "status": "DISPOSED",
               "poll-interval": null
             },
             "config-items": [],
             "container-alias": "itorders"
           }
         ]
       }
     }
   }

4. この例では、プロジェクトの group-id、artifact-id、および version (GAV) のデータを応答で返されたデプロイ済み KIE コンテナーのいずれかからコピーするか、書き留めます。

5. REST クライアントまたは curl ユーティリティーで、/server/containers/{containerId} への PUT 要求を以下のコンポーネントで送信し、コピーしたプロジェクトの GAV データで新規 KIE コンテナーをデプロイします。ご自分のユースケースに合わせて、要求詳細を調整します。

   REST クライアントの場合:

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

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

     • Accept: application/json

     • Content-Type: application/json

       注記

       fields=not_null を Content-Type に追加すると、null フィールドは REST API レスポンスから除外されます。

   • HTTP method: PUT に設定します。
   • URL: KIE Server REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/kie-server/services/rest/server/containers/MyContainer となります。
   • 要求のボディ: 新規 KIE コンテナー用の設定アイテムのある JSON 要求のボディを追加します。

   {
     "config-items": [
       {
         "itemName": "RuntimeStrategy",
         "itemValue": "SINGLETON",
         "itemType": "java.lang.String"
       },
       {
         "itemName": "MergeMode",
         "itemValue": "MERGE_COLLECTIONS",
         "itemType": "java.lang.String"
       },
       {
         "itemName": "KBase",
         "itemValue": "",
         "itemType": "java.lang.String"
       },
       {
         "itemName": "KSession",
         "itemValue": "",
         "itemType": "java.lang.String"
       }
     ],
     "release-id": {
       "group-id": "itorders",
       "artifact-id": "itorders",
       "version": "1.0.0-SNAPSHOT"
     },
     "scanner": {
       "poll-interval": "5000",
       "status": "STARTED"
     }
   }

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

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

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

     • Accept: application/json

     • Content-Type: application/json

       注記

       fields=not_null を Content-Type に追加すると、null フィールドは REST API レスポンスから除外されます。

   • -X: PUT に設定します。
   • URL: KIE Server REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/kie-server/services/rest/server/containers/MyContainer となります。
   • -d: 新規 KIE コンテナー用の設定アイテムのある JSON 要求のボディまたはファイル (@file.json) を追加します。

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Content-Type: application/json" -X PUT "http://localhost:8080/kie-server/services/rest/server/containers/MyContainer" -d "{ \"config-items\": [ { \"itemName\": \"RuntimeStrategy\", \"itemValue\": \"SINGLETON\", \"itemType\": \"java.lang.String\" }, { \"itemName\": \"MergeMode\", \"itemValue\": \"MERGE_COLLECTIONS\", \"itemType\": \"java.lang.String\" }, { \"itemName\": \"KBase\", \"itemValue\": \"\", \"itemType\": \"java.lang.String\" }, { \"itemName\": \"KSession\", \"itemValue\": \"\", \"itemType\": \"java.lang.String\" } ], \"release-id\": { \"group-id\": \"itorders\", \"artifact-id\": \"itorders\", \"version\": \"1.0.0-SNAPSHOT\" }, \"scanner\": { \"poll-interval\": \"5000\", \"status\": \"STARTED\" }}"

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Content-Type: application/json" -X PUT "http://localhost:8080/kie-server/services/rest/server/containers/MyContainer" -d @my-container-configs.json

6. 要求を実行し、KIE Server の応答を確認します。

   サーバー応答の例 (JSON):

   {
     "type": "SUCCESS",
     "msg": "Container MyContainer successfully deployed with module itorders:itorders:1.0.0-SNAPSHOT.",
     "result": {
       "kie-container": {
         "container-id": "MyContainer",
         "release-id": {
           "group-id": "itorders",
           "artifact-id": "itorders",
           "version": "1.0.0-SNAPSHOT"
         },
         "resolved-release-id": {
           "group-id": "itorders",
           "artifact-id": "itorders",
           "version": "1.0.0-SNAPSHOT"
         },
         "status": "STARTED",
         "scanner": {
           "status": "STARTED",
           "poll-interval": 5000
         },
         "config-items": [],
         "messages": [
           {
             "severity": "INFO",
             "timestamp": {
               "java.util.Date": 1540584717937
             },
             "content": [
               "Container MyContainer successfully created with module itorders:itorders:1.0.0-SNAPSHOT."
             ]
           }
         ],
         "container-alias": null
       }
     }
   }

   要求エラーが発生した場合は、返されたエラーコードメッセージを確認して、それに応じて要求を調整します。

   プロセスインスタンスの REST API 要求

   複雑なデータオブジェクトをプロセスインスタンスのエンドポイント (/server/containers/{containerId}/processes/{processId}/instances) に送信する REST API 要求の場合は、要求ボディーに、完全修飾クラス名 (com.myspace.Person など) または単純なクラス名 (Person など) を含めるようにしてください。Red Hat Process Automation Manager で、正しいビジネスオブジェクトに要求ボディーをマッピングするには、クラス名が必要です。要求からクラス名を除外すると、KIE Server では、想定するタイプにオブジェクトがアンマーシャルされません。

   プロセスインスタンスの要求ボディー (正)

   {
     "id": 4,
     "lease": {
       "com.myspace.restcall.LeaseModel": {
         "annualRent": 109608,
         "isAutoApproved": false
       }
     }
   }

   プロセスインスタンスの要求ボディー (誤)

   {
     "id": 4,
     "lease": {
       "annualRent": 109608,
       "isAutoApproved": false
     }
   }

手順

1. Web ブラウザーで http://SERVER:PORT/kie-server/docs を開きます。たとえば、http://localhost:8080/kie-server/docs となります。kie-server ロールを持つ KIE Server ユーザーのユーザー名とパスワードでログインします。
2. Swagger ページで、要求の送信先となる関連 API エンドポイントを選択します。たとえば、KIE Server and KIE containers → [GET] /server/containers で KIE コンテナーを KIE Server から取得します。
3. Try it out をクリックして、結果のフィルターリングに使用する任意のパラメーターを提供します。
4. Response content type ドロップダウンメニューで、サーバー応答のフォーマットを選択します (例: JSON フォーマットでは application/json)。

5. Execute をクリックし、KIE Server の応答を確認します。

   サーバー応答の例 (JSON):

   {
     "type": "SUCCESS",
     "msg": "List of created containers",
     "result": {
       "kie-containers": {
         "kie-container": [
           {
             "container-id": "itorders_1.0.0-SNAPSHOT",
             "release-id": {
               "group-id": "itorders",
               "artifact-id": "itorders",
               "version": "1.0.0-SNAPSHOT"
             },
             "resolved-release-id": {
               "group-id": "itorders",
               "artifact-id": "itorders",
               "version": "1.0.0-SNAPSHOT"
             },
             "status": "STARTED",
             "scanner": {
               "status": "DISPOSED",
               "poll-interval": null
             },
             "config-items": [],
             "container-alias": "itorders"
           }
         ]
       }
     }
   }

6. この例では、プロジェクトの group-id、artifact-id、および version (GAV) のデータを応答で返されたデプロイ済み KIE コンテナーのいずれかからコピーするか、書き留めます。
7. Swagger ページで KIE Server and KIE containers → [PUT] /server/containers/{containerId} エンドポイントに移動し、コピーしたプロジェクト GAV データで新規 KIE コンテナーをデプロイするための別の要求を送信します。ご自分のユースケースに合わせて、要求詳細を調整します。

8. Try it out をクリックして、以下の要求のコンポーネントを入力します。

   • containerId: 新規 KIE コンテナーの ID を入力します (例: MyContainer)。
   • body: Parameter content type を希望の要求のボディ形式 (JSON の場合は application/json など) に設定し、要求のボディに新規 KIE コンテナーの設定アイテムを追加します。

   {
     "config-items": [
       {
         "itemName": "RuntimeStrategy",
         "itemValue": "SINGLETON",
         "itemType": "java.lang.String"
       },
       {
         "itemName": "MergeMode",
         "itemValue": "MERGE_COLLECTIONS",
         "itemType": "java.lang.String"
       },
       {
         "itemName": "KBase",
         "itemValue": "",
         "itemType": "java.lang.String"
       },
       {
         "itemName": "KSession",
         "itemValue": "",
         "itemType": "java.lang.String"
       }
     ],
     "release-id": {
       "group-id": "itorders",
       "artifact-id": "itorders",
       "version": "1.0.0-SNAPSHOT"
     },
     "scanner": {
       "poll-interval": "5000",
       "status": "STARTED"
     }
   }

9. Response content type ドロップダウンメニューで、サーバー応答のフォーマットを選択します (例: JSON フォーマットでは application/json)。

10. Execute をクリックし、KIE Server の応答を確認します。

    サーバー応答の例 (JSON):

    {
      "type": "SUCCESS",
      "msg": "Container MyContainer successfully deployed with module itorders:itorders:1.0.0-SNAPSHOT.",
      "result": {
        "kie-container": {
          "container-id": "MyContainer",
          "release-id": {
            "group-id": "itorders",
            "artifact-id": "itorders",
            "version": "1.0.0-SNAPSHOT"
          },
          "resolved-release-id": {
            "group-id": "itorders",
            "artifact-id": "itorders",
            "version": "1.0.0-SNAPSHOT"
          },
          "status": "STARTED",
          "scanner": {
            "status": "STARTED",
            "poll-interval": 5000
          },
          "config-items": [],
          "messages": [
            {
              "severity": "INFO",
              "timestamp": {
                "java.util.Date": 1540584717937
              },
              "content": [
                "Container MyContainer successfully created with module itorders:itorders:1.0.0-SNAPSHOT."
              ]
            }
          ],
          "container-alias": null
        }
      }
    }

    要求エラーが発生した場合は、返されたエラーコードメッセージを確認して、それに応じて要求を調整します。

    プロセスインスタンスの REST API 要求

    複雑なデータオブジェクトをプロセスインスタンスのエンドポイント (/server/containers/{containerId}/processes/{processId}/instances) に送信する REST API 要求の場合は、要求ボディーに、完全修飾クラス名 (com.myspace.Person など) または単純なクラス名 (Person など) を含めるようにしてください。Red Hat Process Automation Manager で、正しいビジネスオブジェクトに要求ボディーをマッピングするには、クラス名が必要です。要求からクラス名を除外すると、KIE Server では、想定するタイプにオブジェクトがアンマーシャルされません。

    プロセスインスタンスの要求ボディー (正)

    {
      "id": 4,
      "lease": {
        "com.myspace.restcall.LeaseModel": {
          "annualRent": 109608,
          "isAutoApproved": false
        }
      }
    }

    プロセスインスタンスの要求ボディー (誤)

    {
      "id": 4,
      "lease": {
        "annualRent": 109608,
        "isAutoApproved": false
      }
    }

手順

1. クライアントアプリケーションで、Java プロジェクトの関連クラスパスに以下の依存関係が追加されていることを確認します。

   <!-- For remote execution on KIE Server -->
   <dependency>
     <groupId>org.kie.server</groupId>
     <artifactId>kie-server-client</artifactId>
     <version>${rhpam.version}</version>
   </dependency>
   
   <!-- For runtime commands -->
   <dependency>
     <groupId>org.drools</groupId>
     <artifactId>drools-compiler</artifactId>
     <scope>runtime</scope>
     <version>${rhpam.version}</version>
   </dependency>
   
   <!-- For debug logging (optional) -->
   <dependency>
     <groupId>ch.qos.logback</groupId>
     <artifactId>logback-classic</artifactId>
     <version>${logback.version}</version>
   </dependency>

2. Red Hat カスタマーポータル から Red Hat Process Automation Manager 7.11.0 Source Distribution をダウンロードし、~/rhpam-7.11.0-sources/src/droolsjbpm-integration-$VERSION/kie-server-parent/kie-server-remote/kie-server-client/src/main/java/org/kie/server/client に移動して KIE Server Java クライアントにアクセスします。
3. ~/kie/server/client ディレクトリーで、KIE Server の KIE コンテナーや他のアセット用のクライアントサービスにアクセスするために、KieServicesClient などの送信する要求用の関連 Java クライアントを特定します。

4. クライアントアプリケーションで、API 要求用の .java クラスを作成します。クラスには、KIE Server の場所とユーザー認証情報、KieServicesClient オブジェクト、KieServicesClient クライアントからの createContainer や disposeContainer などの実行するクライアントメソッドを含める必要があります。ご自分のユースケースに合わせて、設定詳細を調整します。

   コンテナーの作成および破棄

   import org.kie.server.api.marshalling.MarshallingFormat;
   import org.kie.server.client.KieServicesClient;
   import org.kie.server.client.KieServicesConfiguration;
   import org.kie.server.client.KieServicesFactory;
   import org.kie.server.api.model.KieContainerResource;
   import org.kie.server.api.model.ServiceResponse;
   
   public class MyConfigurationObject {
   
     private static final String URL = "http://localhost:8080/kie-server/services/rest/server";
     private static final String USER = "baAdmin";
     private static final String PASSWORD = "password@1";
   
     private static final MarshallingFormat FORMAT = MarshallingFormat.JSON;
   
     private static KieServicesConfiguration conf;
     private static KieServicesClient kieServicesClient;
   
     public static void initialize() {
       conf = KieServicesFactory.newRestConfiguration(URL, USER, PASSWORD);
   
     public void disposeAndCreateContainer() {
         System.out.println("== Disposing and creating containers ==");
   
         // Retrieve list of KIE containers
         List<KieContainerResource> kieContainers = kieServicesClient.listContainers().getResult().getContainers();
         if (kieContainers.size() == 0) {
             System.out.println("No containers available...");
             return;
         }
   
         // Dispose KIE container
         KieContainerResource container = kieContainers.get(0);
         String containerId = container.getContainerId();
         ServiceResponse<Void> responseDispose = kieServicesClient.disposeContainer(containerId);
         if (responseDispose.getType() == ResponseType.FAILURE) {
             System.out.println("Error disposing " + containerId + ". Message: ");
             System.out.println(responseDispose.getMsg());
             return;
         }
         System.out.println("Success Disposing container " + containerId);
         System.out.println("Trying to recreate the container...");
   
         // Re-create KIE container
         ServiceResponse<KieContainerResource> createResponse = kieServicesClient.createContainer(containerId, container);
         if(createResponse.getType() == ResponseType.FAILURE) {
             System.out.println("Error creating " + containerId + ". Message: ");
             System.out.println(responseDispose.getMsg());
             return;
         }
         System.out.println("Container recreated with success!");
         }
     }
   }

   org.kie.server.api.model.ServiceResponse<T> オブジェクトを使用してサービス応答を定義します。ここでの T は、返される応答のタイプを表します。ServiceResponse オブジェクトには以下の属性があります。

   • String message: 応答メッセージを返します。
   • ResponseType type: SUCCESS または FAILURE を返します。
   • T result: 要求されたオブジェクトを返します。

   この例では、コンテナーを破棄すると、ServiceResponse が Void 応答を返します。コンテナーを作成すると、ServiceResponse が KieContainerResource オブジェクトを返します。

   注記

   クライアントとクラスター環境内の特定の KIE Server コンテナーとの対話は、一意の conversationID でセキュリティーが保たれます。conversationID は X-KIE-ConversationId REST ヘッダーを使用して送信されます。コンテナーを更新する場合は、以前の conversationID の設定を解除します。KieServiesClient.completeConversation() を使用して Java API の conversationID を設定解除します。

5. 設定済みの .java クラスをプロジェクトディレクトリーから実行して、要求を出し、KIE Server の応答を確認します。

   デバッグのロギングが有効になっている場合は、JSON などの設定済みマーシャリングフォーマットに従って、KIE Server が詳細を返します。

   新規 KIE コンテナーのサーバー応答の例 (ログ):

   10:23:35.194 [main] INFO  o.k.s.a.m.MarshallerFactory - Marshaller extensions init
   10:23:35.396 [main] DEBUG o.k.s.client.balancer.LoadBalancer - Load balancer RoundRobinBalancerStrategy{availableEndpoints=[http://localhost:8080/kie-server/services/rest/server]} selected url 'http://localhost:8080/kie-server/services/rest/server'
   10:23:35.398 [main] DEBUG o.k.s.c.i.AbstractKieServicesClientImpl - About to send GET request to 'http://localhost:8080/kie-server/services/rest/server'
   10:23:35.440 [main] DEBUG o.k.s.c.i.AbstractKieServicesClientImpl - About to deserialize content:
    '{
     "type" : "SUCCESS",
     "msg" : "Kie Server info",
     "result" : {
       "kie-server-info" : {
         "id" : "default-kieserver",
         "version" : "7.11.0.Final-redhat-00003",
         "name" : "default-kieserver",
         "location" : "http://localhost:8080/kie-server/services/rest/server",
         "capabilities" : [ "KieServer", "BRM", "BPM", "CaseMgmt", "BPM-UI", "BRP", "DMN", "Swagger" ],
         "messages" : [ {
           "severity" : "INFO",
           "timestamp" : {
     "java.util.Date" : 1540814906533
   },
           "content" : [ "Server KieServerInfo{serverId='default-kieserver', version='7.11.0.Final-redhat-00003', name='default-kieserver', location='http://localhost:8080/kie-server/services/rest/server', capabilities=[KieServer, BRM, BPM, CaseMgmt, BPM-UI, BRP, DMN, Swagger], messages=null}started successfully at Mon Oct 29 08:08:26 EDT 2018" ]
         } ]
       }
     }
   }'
    into type: 'class org.kie.server.api.model.ServiceResponse'
   10:23:35.653 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - KieServicesClient connected to: default-kieserver version 7.11.0.Final-redhat-00003
   10:23:35.653 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Supported capabilities by the server: [KieServer, BRM, BPM, CaseMgmt, BPM-UI, BRP, DMN, Swagger]
   10:23:35.653 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Building services client for server capability KieServer
   10:23:35.653 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - No builder found for 'KieServer' capability
   10:23:35.654 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Building services client for server capability BRM
   10:23:35.654 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Builder 'org.kie.server.client.helper.DroolsServicesClientBuilder@6b927fb' for capability 'BRM'
   10:23:35.655 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Capability implemented by {interface org.kie.server.client.RuleServicesClient=org.kie.server.client.impl.RuleServicesClientImpl@4a94ee4}
   10:23:35.655 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Building services client for server capability BPM
   10:23:35.656 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Builder 'org.kie.server.client.helper.JBPMServicesClientBuilder@4cc451f2' for capability 'BPM'
   10:23:35.672 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Capability implemented by {interface org.kie.server.client.JobServicesClient=org.kie.server.client.impl.JobServicesClientImpl@1189dd52, interface org.kie.server.client.admin.ProcessAdminServicesClient=org.kie.server.client.admin.impl.ProcessAdminServicesClientImpl@36bc55de, interface org.kie.server.client.DocumentServicesClient=org.kie.server.client.impl.DocumentServicesClientImpl@564fabc8, interface org.kie.server.client.admin.UserTaskAdminServicesClient=org.kie.server.client.admin.impl.UserTaskAdminServicesClientImpl@16d04d3d, interface org.kie.server.client.QueryServicesClient=org.kie.server.client.impl.QueryServicesClientImpl@49ec71f8, interface org.kie.server.client.ProcessServicesClient=org.kie.server.client.impl.ProcessServicesClientImpl@1d2adfbe, interface org.kie.server.client.UserTaskServicesClient=org.kie.server.client.impl.UserTaskServicesClientImpl@36902638}
   10:23:35.672 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Building services client for server capability CaseMgmt
   10:23:35.672 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Builder 'org.kie.server.client.helper.CaseServicesClientBuilder@223d2c72' for capability 'CaseMgmt'
   10:23:35.676 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Capability implemented by {interface org.kie.server.client.admin.CaseAdminServicesClient=org.kie.server.client.admin.impl.CaseAdminServicesClientImpl@2b662a77, interface org.kie.server.client.CaseServicesClient=org.kie.server.client.impl.CaseServicesClientImpl@7f0eb4b4}
   10:23:35.676 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Building services client for server capability BPM-UI
   10:23:35.676 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Builder 'org.kie.server.client.helper.JBPMUIServicesClientBuilder@5c33f1a9' for capability 'BPM-UI'
   10:23:35.677 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Capability implemented by {interface org.kie.server.client.UIServicesClient=org.kie.server.client.impl.UIServicesClientImpl@223191a6}
   10:23:35.678 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Building services client for server capability BRP
   10:23:35.678 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Builder 'org.kie.server.client.helper.OptaplannerServicesClientBuilder@49139829' for capability 'BRP'
   10:23:35.679 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Capability implemented by {interface org.kie.server.client.SolverServicesClient=org.kie.server.client.impl.SolverServicesClientImpl@77fbd92c}
   10:23:35.679 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Building services client for server capability DMN
   10:23:35.679 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Builder 'org.kie.server.client.helper.DMNServicesClientBuilder@67c27493' for capability 'DMN'
   10:23:35.680 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Capability implemented by {interface org.kie.server.client.DMNServicesClient=org.kie.server.client.impl.DMNServicesClientImpl@35e2d654}
   10:23:35.680 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - Building services client for server capability Swagger
   10:23:35.680 [main] DEBUG o.k.s.c.impl.KieServicesClientImpl - No builder found for 'Swagger' capability
   10:23:35.681 [main] DEBUG o.k.s.client.balancer.LoadBalancer - Load balancer RoundRobinBalancerStrategy{availableEndpoints=[http://localhost:8080/kie-server/services/rest/server]} selected url 'http://localhost:8080/kie-server/services/rest/server'
   10:23:35.701 [main] DEBUG o.k.s.c.i.AbstractKieServicesClientImpl - About to send PUT request to 'http://localhost:8080/kie-server/services/rest/server/containers/employee-rostering3' with payload '{
     "container-id" : null,
     "release-id" : {
       "group-id" : "employeerostering",
       "artifact-id" : "employeerostering",
       "version" : "1.0.0-SNAPSHOT"
     },
     "resolved-release-id" : null,
     "status" : null,
     "scanner" : null,
     "config-items" : [ ],
     "messages" : [ ],
     "container-alias" : null
   }'
   10:23:38.071 [main] DEBUG o.k.s.c.i.AbstractKieServicesClientImpl - About to deserialize content:
    '{
     "type" : "SUCCESS",
     "msg" : "Container employee-rostering3 successfully deployed with module employeerostering:employeerostering:1.0.0-SNAPSHOT.",
     "result" : {
       "kie-container" : {
         "container-id" : "employee-rostering3",
         "release-id" : {
           "group-id" : "employeerostering",
           "artifact-id" : "employeerostering",
           "version" : "1.0.0-SNAPSHOT"
         },
         "resolved-release-id" : {
           "group-id" : "employeerostering",
           "artifact-id" : "employeerostering",
           "version" : "1.0.0-SNAPSHOT"
         },
         "status" : "STARTED",
         "scanner" : {
           "status" : "DISPOSED",
           "poll-interval" : null
         },
         "config-items" : [ ],
         "messages" : [ {
           "severity" : "INFO",
           "timestamp" : {
     "java.util.Date" : 1540909418069
   },
           "content" : [ "Container employee-rostering3 successfully created with module employeerostering:employeerostering:1.0.0-SNAPSHOT." ]
         } ],
         "container-alias" : null
       }
     }
   }'
    into type: 'class org.kie.server.api.model.ServiceResponse'

   エラーが発生した場合は、返されたエラーメッセージを確認して、それに応じて Java 設定を調整します。

手順

1. 要求の送信先となる関連する API エンドポイント を特定します。Process Automation Manager コントローラーから KIE Server テンプレートを取得する [GET] /controller/management/servers などです。

2. REST クライアントまたは curl ユーティリティーで、controller/management/servers への GET 要求に以下のコンポーネントを記入します。ご自分のユースケースに合わせて、要求詳細を調整します。

   REST クライアントの場合:

   • Authentication: rest-all ロールのある Process Automation Manager コントローラーユーザーまたは kie-server ロールを持つヘッドレス Process Automation Manager コントローラーユーザーのユーザー名とパスワードを入力します。

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

     • Accept: application/json
   • HTTP method: GET に設定します。
   • URL: Process Automation Manager コントローラー REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/controller/management/servers となります。

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

   • -u: rest-all ロールのある Process Automation Manager コントローラーユーザーまたは kie-server ロールを持つヘッドレス Process Automation Manager コントローラーユーザーのユーザー名およびパスワードを入力します。

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

     • Accept: application/json
   • -X: GET に設定します。
   • URL: Process Automation Manager コントローラー REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/controller/management/servers となります。

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -X GET "http://localhost:8080/business-central/rest/controller/management/servers"

3. 要求を実行し、Process Automation Manager コントローラーの応答を確認します。

   サーバー応答の例 (JSON):

   {
     "server-template": [
       {
         "server-id": "default-kieserver",
         "server-name": "default-kieserver",
         "container-specs": [
           {
             "container-id": "employeerostering_1.0.0-SNAPSHOT",
             "container-name": "employeerostering",
             "server-template-key": {
               "server-id": "default-kieserver",
               "server-name": "default-kieserver"
             },
             "release-id": {
               "group-id": "employeerostering",
               "artifact-id": "employeerostering",
               "version": "1.0.0-SNAPSHOT"
             },
             "configuration": {
               "RULE": {
                 "org.kie.server.controller.api.model.spec.RuleConfig": {
                   "pollInterval": null,
                   "scannerStatus": "STOPPED"
                 }
               },
               "PROCESS": {
                 "org.kie.server.controller.api.model.spec.ProcessConfig": {
                   "runtimeStrategy": "SINGLETON",
                   "kbase": "",
                   "ksession": "",
                   "mergeMode": "MERGE_COLLECTIONS"
                 }
               }
             },
             "status": "STARTED"
           },
           {
             "container-id": "mortgage-process_1.0.0-SNAPSHOT",
             "container-name": "mortgage-process",
             "server-template-key": {
               "server-id": "default-kieserver",
               "server-name": "default-kieserver"
             },
             "release-id": {
               "group-id": "mortgage-process",
               "artifact-id": "mortgage-process",
               "version": "1.0.0-SNAPSHOT"
             },
             "configuration": {
               "RULE": {
                 "org.kie.server.controller.api.model.spec.RuleConfig": {
                   "pollInterval": null,
                   "scannerStatus": "STOPPED"
                 }
               },
               "PROCESS": {
                 "org.kie.server.controller.api.model.spec.ProcessConfig": {
                   "runtimeStrategy": "PER_PROCESS_INSTANCE",
                   "kbase": "",
                   "ksession": "",
                   "mergeMode": "MERGE_COLLECTIONS"
                 }
               }
             },
             "status": "STARTED"
           }
         ],
         "server-config": {},
         "server-instances": [
           {
             "server-instance-id": "default-kieserver-instance@localhost:8080",
             "server-name": "default-kieserver-instance@localhost:8080",
             "server-template-id": "default-kieserver",
             "server-url": "http://localhost:8080/kie-server/services/rest/server"
           }
         ],
         "capabilities": [
           "RULE",
           "PROCESS",
           "PLANNING"
         ]
       }
     ]
   }

4. REST クライアントまたは curl ユーティリティーで、/controller/management/servers/{serverTemplateId} への PUT 要求を以下のコンポーネントで送信し、新規の KIE Server テンプレートを作成します。ご自分のユースケースに合わせて、要求詳細を調整します。

   REST クライアントの場合:

   • Authentication: rest-all ロールのある Process Automation Manager コントローラーユーザーまたは kie-server ロールを持つヘッドレス Process Automation Manager コントローラーユーザーのユーザー名とパスワードを入力します。

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

     • Accept: application/json
     • Content-Type: application/json
   • HTTP method: PUT に設定します。
   • URL: Process Automation Manager コントローラー REST API ベース URL およびエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/controller/management/servers/new-kieserver となります。
   • 要求のボディ: 新規 KIE Server テンプレート用の設定を含めて JSON 要求のボディを追加します。

   {
     "server-id": "new-kieserver",
     "server-name": "new-kieserver",
     "container-specs": [],
     "server-config": {},
     "capabilities": [
       "RULE",
       "PROCESS",
       "PLANNING"
     ]
   }

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

   • -u: rest-all ロールのある Process Automation Manager コントローラーユーザーまたは kie-server ロールを持つヘッドレス Process Automation Manager コントローラーユーザーのユーザー名およびパスワードを入力します。

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

     • Accept: application/json
     • Content-Type: application/json
   • -X: PUT に設定します。
   • URL: Process Automation Manager コントローラー REST API ベース URL およびエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/controller/management/servers/new-kieserver となります。
   • -d: 新規 KIE Server テンプレート用の設定を含めて JSON 要求のボディまたはファイル (@file.json) を追加します。

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Content-Type: application/json" -X PUT "http://localhost:8080/business-central/rest/controller/management/servers/new-kieserver" -d "{ \"server-id\": \"new-kieserver\", \"server-name\": \"new-kieserver\", \"container-specs\": [], \"server-config\": {}, \"capabilities\": [ \"RULE\", \"PROCESS\", \"PLANNING\" ]}"

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Content-Type: application/json" -X PUT "http://localhost:8080/business-central/rest/controller/management/servers/new-kieserver" -d @my-server-template-configs.json

5. 要求を実行し、Process Automation Manager コントローラーの応答が正常であることを確認します。

   要求エラーが発生した場合は、返されたエラーコードメッセージを確認して、それに応じて要求を調整します。

手順

1. Web ブラウザーで http://SERVER:PORT/CONTROLLER/docs に移動します。たとえば、http://localhost:8080/business-central/docs などです。rest-all ロールのある Process Automation Manager コントローラーユーザー、または kie-server ロールを持つヘッドレス Process Automation Manager コントローラーユーザーのユーザー名とパスワードでログインします。

   注記

   Business Central に組み込まれている Process Automation Manager コントローラーを使用している場合、Process Automation Manager コントローラーに関連付けられている Swagger ページは、Business Central REST サービスでは Business Central API として特定されます。Business Central なしでヘッドレス Process Automation Manager コントローラーを使用している場合は、ヘッドレス Process Automation Manager コントローラーに関連付けられている Swagger ページは、Controller API と特定されます。いずれの場合も、Process Automation Manager コントローラー REST API エンドポイントは、同じです。

2. Swagger ページで、要求の送信先となる関連 API エンドポイントを選択します。たとえば、Controller :: KIE Server templates and KIE containers → [GET] /controller/management/servers で KIE Server テンプレートを Process Automation Manager コントローラーから取得します。
3. 該当する場合は Try it out をクリックして、結果のフィルターリングに使用する任意のパラメーターを提供します。
4. Response content type ドロップダウンメニューで、サーバー応答のフォーマットを選択します (例: JSON フォーマットでは application/json)。

5. Execute をクリックし、KIE Server の応答を確認します。

   サーバー応答の例 (JSON):

   {
     "server-template": [
       {
         "server-id": "default-kieserver",
         "server-name": "default-kieserver",
         "container-specs": [
           {
             "container-id": "employeerostering_1.0.0-SNAPSHOT",
             "container-name": "employeerostering",
             "server-template-key": {
               "server-id": "default-kieserver",
               "server-name": "default-kieserver"
             },
             "release-id": {
               "group-id": "employeerostering",
               "artifact-id": "employeerostering",
               "version": "1.0.0-SNAPSHOT"
             },
             "configuration": {
               "RULE": {
                 "org.kie.server.controller.api.model.spec.RuleConfig": {
                   "pollInterval": null,
                   "scannerStatus": "STOPPED"
                 }
               },
               "PROCESS": {
                 "org.kie.server.controller.api.model.spec.ProcessConfig": {
                   "runtimeStrategy": "SINGLETON",
                   "kbase": "",
                   "ksession": "",
                   "mergeMode": "MERGE_COLLECTIONS"
                 }
               }
             },
             "status": "STARTED"
           },
           {
             "container-id": "mortgage-process_1.0.0-SNAPSHOT",
             "container-name": "mortgage-process",
             "server-template-key": {
               "server-id": "default-kieserver",
               "server-name": "default-kieserver"
             },
             "release-id": {
               "group-id": "mortgage-process",
               "artifact-id": "mortgage-process",
               "version": "1.0.0-SNAPSHOT"
             },
             "configuration": {
               "RULE": {
                 "org.kie.server.controller.api.model.spec.RuleConfig": {
                   "pollInterval": null,
                   "scannerStatus": "STOPPED"
                 }
               },
               "PROCESS": {
                 "org.kie.server.controller.api.model.spec.ProcessConfig": {
                   "runtimeStrategy": "PER_PROCESS_INSTANCE",
                   "kbase": "",
                   "ksession": "",
                   "mergeMode": "MERGE_COLLECTIONS"
                 }
               }
             },
             "status": "STARTED"
           }
         ],
         "server-config": {},
         "server-instances": [
           {
             "server-instance-id": "default-kieserver-instance@localhost:8080",
             "server-name": "default-kieserver-instance@localhost:8080",
             "server-template-id": "default-kieserver",
             "server-url": "http://localhost:8080/kie-server/services/rest/server"
           }
         ],
         "capabilities": [
           "RULE",
           "PROCESS",
           "PLANNING"
         ]
       }
     ]
   }

6. Swagger ページで Controller :: KIE Server templates and KIE containers → [GET] /controller/management/servers/{serverTemplateId} エンドポイントに移動し、新たな KIE Server テンプレートを作成するための別の要求を送信します。ご自分のユースケースに合わせて、要求詳細を調整します。

7. Try it out をクリックして、以下の要求のコンポーネントを入力します。

   • serverTemplateId: 新規 KIE Server テンプレートの ID を入力します (例: new-kieserver)。
   • body: Parameter content type を任意の要求のボディ形式 (JSON の場合は application/json など) に設定し、要求のボディに新規 KIE Server テンプレートの設定を追加します。

   {
     "server-id": "new-kieserver",
     "server-name": "new-kieserver",
     "container-specs": [],
     "server-config": {},
     "capabilities": [
       "RULE",
       "PROCESS",
       "PLANNING"
     ]
   }

8. Response content type ドロップダウンメニューで、サーバー応答のフォーマットを選択します (例: JSON フォーマットでは application/json)。

9. Execute をクリックし、Process Automation Manager コントローラーの応答が正常であることを確認します。

   要求エラーが発生した場合は、返されたエラーコードメッセージを確認して、それに応じて要求を調整します。

手順

1. クライアントアプリケーションで、Java プロジェクトの関連クラスパスに以下の依存関係が追加されていることを確認します。

   <!-- For remote execution on controller -->
   <dependency>
     <groupId>org.kie.server</groupId>
     <artifactId>kie-server-controller-client</artifactId>
     <version>${rhpam.version}</version>
   </dependency>
   
   <!-- For REST client -->
   <dependency>
     <groupId>org.jboss.resteasy</groupId>
     <artifactId>resteasy-client</artifactId>
     <version>${resteasy.version}</version>
   </dependency>
   
   <!-- For WebSocket client -->
   <dependency>
     <groupId>io.undertow</groupId>
     <artifactId>undertow-websockets-jsr</artifactId>
     <version>${undertow.version}</version>
   </dependency>
   
   <!-- For debug logging (optional) -->
   <dependency>
     <groupId>ch.qos.logback</groupId>
     <artifactId>logback-classic</artifactId>
     <version>${logback.version}</version>
   </dependency>

2. Red Hat カスタマーポータル から Red Hat Process Automation Manager 7.11.0 Source Distribution をダウンロードし、~/rhpam-7.11.0-sources/src/droolsjbpm-integration-$VERSION/kie-server-parent/kie-server-controller/kie-server-controller-client/src/main/java/org/kie/server/controller/client に移動して Process Automation Manager コントローラー Java クライアントにアクセスします。
3. ~/kie/server/controller/client ディレクトリーで、KIE Server テンプレートや KIE コンテナーが REST プロトコルでクライアントサービスにアクセスするために、RestKieServerControllerClient 実装などの送信する要求用の関連 Java クライアントを特定します。

4. クライアントアプリケーションで、API 要求用の .java クラスを作成します。クラスには、Process Automation Manager コントローラーの場所とユーザー認証情報、KieServerControllerClient オブジェクト、実行するクライアントメソッド (RestKieServerControllerClient 実装からの createServerTemplate や createContainer など) を含める必要があります。ご自分のユースケースに合わせて、設定詳細を調整します。

   KIE Server テンプレートおよび KIE コンテナーの作成と対話

   import java.util.Arrays;
   import java.util.HashMap;
   import java.util.Map;
   
   import org.kie.server.api.marshalling.MarshallingFormat;
   import org.kie.server.api.model.KieContainerStatus;
   import org.kie.server.api.model.KieScannerStatus;
   import org.kie.server.api.model.ReleaseId;
   import org.kie.server.controller.api.model.spec.*;
   import org.kie.server.controller.client.KieServerControllerClient;
   import org.kie.server.controller.client.KieServerControllerClientFactory;
   
   public class RestTemplateContainerExample {
   
     private static final String URL = "http://localhost:8080/business-central/rest/controller";
     private static final String USER = "baAdmin";
     private static final String PASSWORD = "password@1";
   
       private static KieServerControllerClient client;
   
       public static void main(String[] args) {
           KieServerControllerClient client = KieServerControllerClientFactory.newRestClient(URL,
                                                                                             USER,
                                                                                             PASSWORD,
                                                                                             MarshallingFormat.JSON);
           // Create server template and KIE container, start and stop KIE container, and delete server template
           ServerTemplate serverTemplate = createServerTemplate();
           ContainerSpec container = createContainer(serverTemplate);
           client.startContainer(container);
           client.stopContainer(container);
           client.deleteServerTemplate(serverTemplate.getId());
       }
   
       // Re-create and configure server template
       protected static ServerTemplate createServerTemplate() {
           ServerTemplate serverTemplate = new ServerTemplate();
           serverTemplate.setId("example-client-id");
           serverTemplate.setName("example-client-name");
           serverTemplate.setCapabilities(Arrays.asList(Capability.PROCESS.name(),
                                                        Capability.RULE.name(),
                                                        Capability.PLANNING.name()));
   
           client.saveServerTemplate(serverTemplate);
   
           return serverTemplate;
       }
   
       // Re-create and configure KIE containers
       protected static ContainerSpec createContainer(ServerTemplate serverTemplate){
           Map<Capability, ContainerConfig> containerConfigMap = new HashMap();
   
           ProcessConfig processConfig = new ProcessConfig("PER_PROCESS_INSTANCE", "kieBase", "kieSession", "MERGE_COLLECTION");
           containerConfigMap.put(Capability.PROCESS, processConfig);
   
           RuleConfig ruleConfig = new RuleConfig(500l, KieScannerStatus.SCANNING);
           containerConfigMap.put(Capability.RULE, ruleConfig);
   
           ReleaseId releaseId = new ReleaseId("org.kie.server.testing", "stateless-session-kjar", "1.0.0-SNAPSHOT");
   
           ContainerSpec containerSpec = new ContainerSpec("example-container-id", "example-client-name", serverTemplate, releaseId, KieContainerStatus.STOPPED, containerConfigMap);
           client.saveContainerSpec(serverTemplate.getId(), containerSpec);
   
           return containerSpec;
       }
   }

5. 設定済み .java クラスをプロジェクトディレクトリーから実行して要求を実行し、Process Automation Manager コントローラーの応答を確認します。

   デバッグのロギングが有効になっている場合は、JSON などの設定済みマーシャリングフォーマットに従って、KIE Server が詳細を返します。エラーが発生した場合は、返されたエラーメッセージを確認して、それに応じて Java 設定を調整します。

手順

1. 要求の送信先となる関連する API エンドポイント を特定します。Business Central からスペースを取得する [GET] /spaces などです。

2. REST クライアントまたは curl ユーティリティーで、/spaces への GET 要求に以下のコンポーネントを入力します。ご自分のユースケースに合わせて、要求詳細を調整します。

   REST クライアントの場合:

   • Authentication: rest-all ロールを持つ Business Central ユーザーのユーザー名とパスワードを入力します。

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

     • Accept: application/json
   • HTTP method: GET に設定します。
   • URL: Process Server REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/spaces となります。

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

   • -u: rest-all ロールを持つ Business Central ユーザーのユーザー名とパスワードを入力します。

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

     • Accept: application/json
   • -X: GET に設定します。
   • URL: Process Server REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/spaces となります。

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -X GET "http://localhost:8080/business-central/rest/spaces"

3. 要求を実行し、KIE Server の応答を確認します。

   サーバー応答の例 (JSON):

   [
     {
       "name": "MySpace",
       "description": null,
       "projects": [
         {
           "name": "Employee_Rostering",
           "spaceName": "MySpace",
           "groupId": "employeerostering",
           "version": "1.0.0-SNAPSHOT",
           "description": "Employee rostering problem optimisation using Planner. Assigns employees to shifts based on their skill.",
           "publicURIs": [
             {
               "protocol": "git",
               "uri": "git://localhost:9418/MySpace/example-Employee_Rostering"
             },
             {
               "protocol": "ssh",
               "uri": "ssh://localhost:8001/MySpace/example-Employee_Rostering"
             }
           ]
         },
         {
           "name": "Mortgage_Process",
           "spaceName": "MySpace",
           "groupId": "mortgage-process",
           "version": "1.0.0-SNAPSHOT",
           "description": "Getting started loan approval process in BPMN2, decision table, business rules, and forms.",
           "publicURIs": [
             {
               "protocol": "git",
               "uri": "git://localhost:9418/MySpace/example-Mortgage_Process"
             },
             {
               "protocol": "ssh",
               "uri": "ssh://localhost:8001/MySpace/example-Mortgage_Process"
             }
           ]
         }
       ],
       "owner": "admin",
       "defaultGroupId": "com.myspace"
     },
     {
       "name": "MySpace2",
       "description": null,
       "projects": [
         {
           "name": "IT_Orders",
           "spaceName": "MySpace",
           "groupId": "itorders",
           "version": "1.0.0-SNAPSHOT",
           "description": "Case Management IT Orders project",
           "publicURIs": [
             {
               "protocol": "git",
               "uri": "git://localhost:9418/MySpace/example-IT_Orders-1"
             },
             {
               "protocol": "ssh",
               "uri": "ssh://localhost:8001/MySpace/example-IT_Orders-1"
             }
           ]
         }
       ],
       "owner": "admin",
       "defaultGroupId": "com.myspace"
     }
   ]

4. REST クライアントまたは curl ユーティリティーで、/spaces/{spaceName}/projects への POST 要求を以下のコンポーネントで送信し、スペース内でプロジェクトを作成します。ご自分のユースケースに合わせて、要求詳細を調整します。

   REST クライアントの場合:

   • Authentication: rest-all ロールを持つ Business Central ユーザーのユーザー名とパスワードを入力します。

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

     • Accept: application/json
     • accept-Language: en-US
     • Content-Type: application/json
   • HTTP method: POST に設定します。
   • URL: Process Server REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/spaces/MySpace/projects となります。
   • 要求のボディ: 新規プロジェクト用の ID データのある JSON 要求ボディを追加します。

   {
     "name": "Employee_Rostering",
     "groupId": "employeerostering",
     "version": "1.0.0-SNAPSHOT",
     "description": "Employee rostering problem optimisation using Planner. Assigns employees to shifts based on their skill."
   }

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

   • -u: rest-all ロールを持つ Business Central ユーザーのユーザー名とパスワードを入力します。

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

     • Accept: application/json
     • accept-Language: en-US (定義されていない場合は JVM のデフォルトのロケールが反映されます)
     • Content-Type: application/json
   • -X: POST に設定します。
   • URL: Process Server REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/spaces/MySpace/projects となります。
   • -d: 新規プロジェクト用の ID データのある JSON 要求のボディまたはファイル (@file.json) を追加します。

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Accept-Language: en-US" -H "Content-Type: application/json" -X POST "http://localhost:8080/business-central/rest/spaces/MySpace/projects" -d "{ \"name\": \"Employee_Rostering\", \"groupId\": \"employeerostering\", \"version\": \"1.0.0-SNAPSHOT\", \"description\": \"Employee rostering problem optimisation using Planner. Assigns employees to shifts based on their skill.\"}"

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Accept-Language: en-US" -H "Content-Type: application/json" -X POST "http://localhost:8080/business-central/rest/spaces/MySpace/projects" -d @my-project.json

5. 要求を実行し、KIE Server の応答を確認します。

   サーバー応答の例 (JSON):

   {
     "jobId": "1541017411591-6",
     "status": "APPROVED",
     "spaceName": "MySpace",
     "projectName": "Employee_Rostering",
     "projectGroupId": "employeerostering",
     "projectVersion": "1.0.0-SNAPSHOT",
     "description": "Employee rostering problem optimisation using Planner. Assigns employees to shifts based on their skill."
   }

   要求エラーが発生した場合は、返されたエラーコードメッセージを確認して、それに応じて要求を調整します。

手順

1. [GET] /groups など、要求の送信先に適した API エンドポイント を特定し、Business Central からグループを取得します。

2. REST クライアントまたは curl ユーティリティーで、/groups への GET 要求に以下のコンポーネントを記入します。ご自分のユースケースに合わせて、要求詳細を調整します。

   REST クライアントの場合:

   • Authentication: admin ロールを持つ Business Central ユーザーのユーザー名とパスワードを入力します。

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

     • Accept: application/json
   • HTTP method: GET に設定します。
   • URL: Security Management REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/groups となります。

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

   • -u: admin ロールを持つ Business Central ユーザーのユーザー名とパスワードを入力します。

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

     • Accept: application/json
   • -X: GET に設定します。
   • URL: Security Management REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/groups となります。

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -X GET "http://localhost:8080/business-central/rest/groups"

3. 要求を実行し、KIE Server の応答を確認します。

   サーバー応答の例 (JSON):

   [
     	{
   		"group1"
   	},
   	{
   		"group2"
   	}
   ]

4. REST クライアントまたは curl ユーティリティーで、/users/{userName}/groups への POST 要求を以下のコンポーネントで送信し、ユーザーに割り当てられたグループを更新します。ご自分のユースケースに合わせて、要求詳細を調整します。

   REST クライアントの場合:

   • Authentication: admin ロールを持つ Business Central ユーザーのユーザー名とパスワードを入力します。

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

     • Accept: application/json
     • Content-Type: application/json
   • HTTP method: POST に設定します。
   • URL: Security Management REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/users/newUser/groups となります。
   • 要求のボディ: 新規グループ用の ID データを含む JSON 要求のボディを追加します。

   [
     "newGroup"
   ]

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

   • -u: admin ロールを持つ Business Central ユーザーのユーザー名とパスワードを入力します。

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

     • Accept: application/json
     • Content-Type: application/json
   • -X: POST に設定します。
   • URL: Security Management REST API ベース URL とエンドポイントを入力します。たとえば、http://localhost:8080/business-central/rest/users/newUser/groups となります。
   • -d: 新規グループ用の ID データを含む JSON 要求のボディまたはファイル (@file.json) を追加します。

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Content-Type: application/json" -X POST "http://localhost:8080/business-central/rest/users/newUser/groups" -d "["newGroup"]"

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Content-Type: application/json" -X POST "http://localhost:8080/business-central/rest/users/newUser/groups" -d @user-groups.json

5. 要求を実行し、KIE Server の応答を確認します。

   サーバー応答の例 (JSON):

   {
     "status": "OK",
     "message": "Groups [newGroup] are assigned successfully to user wbadmin"
   }

   要求エラーが発生した場合は、返されたエラーコードメッセージを確認して、それに応じて要求を調整します。