Business Central 設定およびプロパティーの設定
ガイド
概要
はじめに
管理者は、管理者の Settings ページで以下をカスタマイズできます。
- Roles: ロールのホームページ、優先順位、パーミッションを設定します。
- Groups: グループのホームページ、優先順位、およびパーミッションを設定し、グループの作成および削除を行います。
- Users: ユーザーの作成や削除、ユーザーに対するグループおよびロールの追加または削除、およびユーザーパーミッションの表示を行います。
- Artifacts: M2 リポジトリーアーティファクトの表示、アーティファクトのアップロード、JAR ファイルの表示とダウンロードを行います。
- Data Sources: データソースおよびデータベースドライバーの追加、更新、または削除を行います。
- Data Sets: データセットの作成、変更、または削除を行います。
- Projects: ファイルエクスポートプロパティー、スペースプロパティー、デフォルト値、GAV 詳細プロパティーなどプロジェクトの設定を表示し、編集します。
- Artifact Repository: アーティファクトリーポジトリープロパティーを管理します。
- Artifact Repository: Business Central の言語を設定します。
- Process Administration: Business Central でデフォルトのページネーションオプションを設定します。
- Process Designer: ダイアグラムエディタープロパティーを設定します。
- SSH Keys: SSH キーを追加または削除します。
- Service Tasks Administration: デフォルトのサービスタスクを有効化または無効化して、カスタムのサービスタスクをアップロードします。
- Profiles: ワークベンチプロファイルを Planner and Rules または Full に設定します。
前提条件
- Red Hat JBoss Enterprise Application Platform 7.2.0 がインストールされている。インストールの詳細は、Red Hat JBoss Enterprise Application Platform 7.2 Installation Guide を参照してください。
- Red Hat Decision Manager がインストールされ、実行中である。詳細は、Red Hat JBoss EAP 7.2 への Red Hat Decision Manager のインストールおよび設定 を参照してください。
-
Business Central に
admin
ユーザーロールでログインします。
第1章 ユーザーおよびグループの管理
Business Central は、ユーザー、グループ、およびロールのセキュリティー管理のエンティティーを 3 種類定義します。パーミッションは、ロールにもグループにも両方割り当てることができます。Business Central には以下のロールがあります。
- process-admin
- manager
- admin
- analyst
- developer
- user
ロールレジストリーというアプリケーションのユーザーロールには、ロールの識別子がありますが、ユーザーグループにはありません。
Business Central を使用して、必要数のユーザーとグループを作成し、管理できます。ユーザーは、最低でもユーザー固有のロールを 1 つ以上割り当てて、Business Central にログインできるようにする必要があります。ユーザーの権限は、ユーザーが所属するグループとロールからのパーミッションにより異なります。ユーザーに複数のロールまたはグループが割り当てられている場合は、ロールまたはグループの優先順位が考慮される点に注意してください。
1.1. ユーザーの作成
ユーザーの権限および設定は、ユーザーに割り当てたロールと、ユーザーが属するグループで制御されます。Business Central で、ユーザーをいくつでも作成できます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Users を選択します。
- New user をクリックし、ユーザー名を入力し、Next をクリックします。
- ユーザーにロールを割り当てるには、Roles タブをクリックして、Add Roles をクリックし、任意のロールを選択してから、Add to selected roles をクリックします。
- 必要に応じて、ユーザーにグループを割り当てるには、Groups タブをクリックして Add to groups をクリックし、任意のグループを選択してから Add to selected groups をクリックします。
- Create をクリックします。
- Yes をクリックして、ユーザーにパスワードを設定し、Change をクリックします。
ユーザーが Business Central にアクセスするために 1 つ以上のロールが必要です。
1.2. ユーザーの編集
Business Central Settings ページの Users オプションを使用して、ユーザーのグループとロールを変更できます。全ユーザーパーミッションは、ユーザーのグループとロールパーミッションを元にしています。ユーザーのパーミッションは、Permissions タブから確認できます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Users を選択します。
- All users リストから、編集するユーザーをクリックします。右のペインにユーザーの情報が表示されます。
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.3. グループの作成
Business Central では、グループを使用してユーザーをまとめて、パーミッションを制御できます。任意の数のグループを作成できますが、グループには最低でもユーザーを 1 つ所属させる必要があります。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Groups を選択します。
- New group をクリックし、グループ名を入力し、Next をクリックします。
このグループに追加するユーザーを選択し、Add selected users をクリックします。
新規作成したグループは、All groups に表示されます。
1.4. グループの編集
必要に応じて、ホームページ、優先順位、パーミッションなどグループの属性を編集できます。Business Central の Settings の Groups オプションから、グループの変更や削除が可能です。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Groups を選択します。
- All groups 一覧から、編集するグループをクリックします。右のペインにユーザーの情報が表示されます。
- Home Page リストからホームページを選択します。
- Priority リストから優先順位を選択します。
Permissions セクションから、リソース属性を展開して、パーミッションを変更します。
注記Pages パーミッション、Editor パーミッション、Spaces パーミッション、および Projects パーミッションに例外を追加できます。
- Save をクリックして変更を適用します。
第2章 セキュリティー管理
セキュリティー管理とは、ユーザー、グループ、パーミッションを管理するプロセスです。Business Central セキュリティー管理ページから Business Central のリソースおよび機能へのアクセスを制御できます。
Business Central は、ユーザー、グループ、およびロールのセキュリティー管理のエンティティーを 3 種類定義します。パーミッションは、ロールにもグループにも両方割り当てることができます。ユーザーは、所属するグループおよびロールのパーミッションを継承します。
2.1. セキュリティー管理プロバイダー
レルムは、セキュリティー管理のコンテキストで各種アプリケーションリソースへのアクセスを制限します。レルムには、ユーザー、グループ、ロール、パーミッションに関する情報が含まれます。特定のレルムに対する具体的なユーザーおよびグループ管理サービスの実装は、セキュリティー管理プロバイダーと呼ばれます。
組み込みのセキュリティー管理プロバイダーがアプリケーションセキュリティーレルムの要件を満たさない場合は、独自のセキュリティー管理プロバイダーを構築して登録できます。
セキュリティー管理プロバイダーがインストールされていない場合は、セキュリティーレルムを管理するユーザーインターフェイスは利用できません。セキュリティー管理プロバイダーをインストールして設定した後に、セキュリティー管理ユーザーインターフェイスでユーザーおよびグループの管理機能は自動的に有効になります。
Business Central には、application-users.properties
または application-roles.properties
プロパティーファイルの内容を基にレルムタイプをサポートする Red Hat JBoss EAP セキュリティー管理プロバイダーが含まれます。
2.1.1. プロパティーファイルを基にした Red Hat JBoss EAP セキュリティー管理プロバイダーの設定
独自の Red Hat JBoss EAP セキュリティー管理プロバイダーを構築して登録できます。プロパティーファイルを基にして Red Hat JBoss EAP セキュリティー管理プロバイダーを使用するには、以下の手順を行います。
前提条件
- Red Hat JBoss EAP がインストールされている。
手順
Red Hat JBoss EAP インスタンスの既存のユーザーまたはロールプロパティーファイルを使用するには、以下の例で示すように、
EAP_HOME/standalone/configuration/application-users.properties
およびEAP_HOME/standalone/configuration/application-roles.properties
ファイルに以下のシステムプロパティーを含めます。<property name="org.uberfire.ext.security.management.wildfly.properties.realm" value="ApplicationRealm"/> <property name="org.uberfire.ext.security.management.wildfly.properties.users-file-path" value="/standalone/configuration/application-users.properties"/> <property name="org.uberfire.ext.security.management.wildfly.properties.groups-file-path" value="/standalone/configuration/application-roles.properties"/>
以下の表は、これらのプロパティーの説明とデフォルト値を示しています。
表2.1 プロパティーファイルを基にする Red Hat JBoss EAP セキュリティー管理プロバイダー
プロパティー 説明 デフォルト値 org.uberfire.ext.security.management.wildfly.properties.realm
レルムの名前このプロパティーは必須ではありません。
ApplicationRealm
org.uberfire.ext.security.management.wildfly.properties.users-file-path
ユーザープロパティーファイルの絶対パス。このプロパティーは必須です。
./standalone/configuration/application-users.properties
org.uberfire.ext.security.management.wildfly.properties.groups-file-path
グループプロパティーファイルの絶対パス。このプロパティーは必須です。
./standalone/configuration/application-roles.properties
アプリケーションのルートディレクトリーに
security-management.properties
ファイルを作成します。たとえば、以下のファイルを作成します。src/main/resources/security-management.properties
security-management.properties
ファイルの値として、以下のシステムプロパティーおよびセキュリティープロバイダー名を入力します。<property name="org.uberfire.ext.security.management.api.userManagementServices" value="WildflyUserManagementService"/>
2.1.2. プロパティーファイルと CLI モードを基にした Red Hat JBoss EAP セキュリティー管理プロバイダーの設定
プロパティーファイルと CLI モードを基に Red Hat JBoss EAP セキュリティー管理プロバイダーを使用するには、以下の手順を行います。
前提条件
- Red Hat JBoss EAP がインストールされている。
手順
Red Hat JBoss EAP インスタンスの既存のユーザーまたはロールプロパティーファイルを使用するには、以下の例で示すように、
EAP_HOME/standalone/configuration/application-users.properties
およびEAP_HOME/standalone/configuration/application-roles.properties
ファイルに以下のシステムプロパティーを含めます。<property name="org.uberfire.ext.security.management.wildfly.cli.host" value="localhost"/> <property name="org.uberfire.ext.security.management.wildfly.cli.port" value="9990"/> <property name="org.uberfire.ext.security.management.wildfly.cli.user" value="<USERNAME>"/> <property name="org.uberfire.ext.security.management.wildfly.cli.password" value="<USER_PWD>"/> <property name="org.uberfire.ext.security.management.wildfly.cli.realm" value="ApplicationRealm"/>
以下の表は、これらのプロパティーの説明とデフォルト値を示しています。
表2.2 プロパティーファイルと CLI モードを基にする Red Hat JBoss EAP セキュリティー管理プロバイダー
プロパティー 説明 デフォルト値 org.uberfire.ext.security.management.wildfly.cli.host
ネイティブ管理インターフェイスホスト。
localhost
org.uberfire.ext.security.management.wildfly.cli.port
ネイティブ管理インターフェイスポート。
9990
org.uberfire.ext.security.management.wildfly.cli.user
ネイティブ管理インターフェイスのユーザー名。
NA
org.uberfire.ext.security.management.wildfly.cli.password
ネイティブ管理インターフェイスのユーザーのパスワード。
NA
org.uberfire.ext.security.management.wildfly.cli.realm
アプリケーションのセキュリティーコンテキストで使用されるレルム。
ApplicationRealm
アプリケーションのルートディレクトリーに
security-management.properties
ファイルを作成します。たとえば、以下のファイルを作成します。src/main/resources/security-management.properties
security-management.properties
ファイルの値として、以下のシステムプロパティーおよびセキュリティープロバイダー名を入力します。<property name="org.uberfire.ext.security.management.api.userManagementServices" value="WildflyCLIUserManagementService"/>
2.2. パーミッションおよび設定
パーミッションは、アプリケーション内の特定のリソースに関連するアクションを実行するためにユーザーに付与される権限です。たとえば、以下のパーミッションを指定できます。
- ページを表示する。
- プロジェクトを保存する。
- リポジトリーを削除する。
- ダッシュボードを削除する。
パーミッションは、付与と拒否ができ、グローバルに設定することも、リソースを指定して設定することもできます。パーミッションを使用すると、リソースへのアクセス時のセキュリティーが保護され、アプリケーション内の機能をカスタマイズできます。
2.2.1. Business Central でのグループおよびロールのパーミッションの変更
Business Central では、個人ユーザーに対するパーミッションは変更できません。ただし、グループおよびロールのパーミッションは変更できます。変更したパーミッションは、変更したロールが割り当てられているか、変更したグループに所属するユーザーに適用されます。
ロールまたはグループへの変更は、そのロールまたはグループに関連のあるユーザーに加えられます。
前提条件
-
Business Central に
admin
ユーザーロールでログインします。
手順
- Business Central で Security management ページにアクセスするには、画面の右上隅にある Admin アイコンを選択します。
Business Central Settings ページで Roles、Groups、または Users をクリックします。
クリックしたアイコンのタブに、Security management ページが開きます。
- リストから編集するロールまたはグループをクリックします。全詳細が右側のペインに表示されます。
- Settings セクションの Home Page または Priority を設定します。
Permissions セクションで、Business Central、ページ、エディター、スペース、プロジェクトのパーミッションを設定します。
図2.1 パーミッションの設定
- 変更するパーミッションのリソースタイプの横にある矢印をクリックして展開します。
必要に応じて、リソースタイプに例外を追加するには、Add Exception をクリックしてから、必要なパーミッションを設定します。
注記Business Central のリソースタイプには、例外を追加できません。
- Save をクリックします。
2.2.2. Business Central ホームページの変更
ホームページは、Business Central にログインすると表示されるページです。デフォルトでは、ホームページは Home
に設定されます。ロールとグループ別に異なるホームページを指定できます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Roles または Groups を選択します。
- ロールまたはグループを選択します。
- Home Page リストからページを選択します。
Save をクリックします。
注記そのロールまたはグループには、ページをホームページにする前に、そのページへの読み取りアクセスが必要です。
2.2.3. 優先順位の設定
ユーザーは、複数のロールを持ち、複数のグループに所属します。優先順位の設定は、ロールまたはグループの優先順を決定します。
前提条件
-
Business Central に
admin
ユーザーロールでログインします。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Roles または Groups を選択します。
- ロールまたはグループを選択します。
- 優先順位メニューから優先順位を選択し、Save をクリックします。
ユーザーに、設定が競合するロールが割り当てられているか、グループに所属している場合は、一番高い優先順位を持つロールまたはグループを設定します。
第3章 アーティファクトの管理
Business Central の Artifacts ページからアーティファクトを管理できます。アーティファクトリーポジトリーは、ローカルの Maven リポジトリーで、インストールごとに Maven リポジトリーは 1 つのみとなっています。Business Central は、Sonatype Nexus™、Apache Archiva™、JFrog Artifactory™ などの Maven リポジトリーソリューションを使用することを推奨します。
Artifacts ページでは、Maven リポジトリーの全アーティファクトをすべて表示します。アーティファクトは、Maven リポジトリーにアップロードできます。
Artifacts リポジトリーにアップロードできるのは、JAR ファイル、KJAR ファイル、および pom.xml
ファイルのみです。
3.1. アーティファクトの表示
Artifacts ページからローカルの maven リポジトリーのコンテンツをすべて確認できます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Artifacts を選択します。
- Open をクリックしてアーティファクトの詳細を表示します。
- Ok をクリックして Artifacts ページに戻ります。
3.2. アーティファクトのダウンロード
Business Central のリポジトリーからプロジェクトのローカルストレージにアーティファクトをダウンロードして保存できます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Artifacts を選択します。
- Download をクリックします。
- アーティファクトを保存するディレクトリーを参照します。
- Save をクリックします。
3.3. アーティファクトのアップロード
ローカルストレージから Business Central のプロジェクトにアーティファクトをアップロードできます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Artifacts を選択します。
- Upload をクリックします。
- Choose File をクリックして、アーティファクトをアップロードするディレクトリーに移動して選択します。
Upload をクリックします。
注記Maven 以外のアーティファクトを使用する場合は、先に
mvn deploy
コマンドを使用してアーティファクトを Maven リポジトリーにデプロイしてから Business Central のアーティファクト一覧を更新します。
第4章 データソース管理
Business Central ではデータソースの管理機能があり、データソースを定義してデータベースにアクセスできます。これらのデータソースは、データセットなど、他の Business Central コンポーネントが使用します。また、データベースドライバーは、データソースと対象のデータベースの間の通信を有効にするために使用します。
Data Source Authoring ページから、Business Central にデータソースとデータベースのドライバーを追加できます。
Business Central にはデフォルトのデータソースが含まれており、これは使用可能ですが、編集または削除することができません。
4.1. データベースドライバーの追加
Business Central に新規データベースドライバーを追加できます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Data Sources を選択します。
- DataSource Explorer ペインで Add Driver をクリックします。New driver ウィンドウが開きます。
- New driver ウィンドウで、データベースドライバーの Name、Driver Class Name、Group Id、Artifact Id、および Version を入力します。
- Finish をクリックして Business Central にドライバーを追加します。
4.2. データベースドライバーの編集
Driver Definition ペインからデータベースドライバーのプロパティーを更新できます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Data Sources を選択します。
- DataSource Explorer ペインで編集するドライバーを選択します。
- Driver Definition ペインで、Name フィールド、Driver Class Name フィールド、Group Id フィールド、Artifact Id フィールド、および Version フィールドに必要な変更を加えます。
- Update をクリックします。
- Yes をクリックしてドライバーへの変更を保存します。
4.3. データベースドライバーの削除
Business Central の Data Source Definition ペインからデータベースドライバーを削除できます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Data Sources を選択します。
- DataSource Explorer ペインで削除するドライバーを選択します。
- Remove をクリックします。
- Delete をクリックしてドライバーを削除します。
4.4. データソースの追加
Data Sources Authoring ページから Business Central に新しいデータソースを追加できます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Data Sources を選択します。
- DataSource Explorer ペインで Add DataSource をクリックします。New data source ウィンドウが開きます。
- New data source ウィンドウで、データソースの Name、データベースの Connection URL、User と Password、ならびに Driver を入力します。
- Test Connection をクリックして、データベースへの接続を確認します。
- Finish をクリックして Business Central へデータソースを追加します。
4.5. データソースの編集
Business Central でデータソースのプロパティーを編集し、データベースへの接続をテストできます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Data Sources を選択します。
- DataSource Explorer ペインで編集するデータソースを選択します。
- Data Source Definition ペインで、Name フィールド、Connection URL フィールド、User フィールド、Password フィールド、および Driver フィールドに必要な変更を加えます。
- Test Connection をクリックして、データベースへの接続を確認します。
- Update をクリックします。
- Save をクリックして、データソースへの変更を確定します。
4.6. データソースの削除
Business Central の DataSource Explorer ペインから既存のデータソースを削除できます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Data Sources を選択します。
- DataSource Explorer ペインで削除するデータソースを選択します。
- Remove をクリックします。
- Delete をクリックして、データソースの削除を確定します。
第5章 データセットのオーサリング
データセットは情報の関連セットの集まりです。データベース、Microsoft Excel ファイル、メモリーなど、さまざまな方法で保存できます。データセット定義は、Business Central メソッドにデータセットへのアクセス、読み取り、および解析を指示します。Business Central はデータを保存しません。データが保存される場所にかかわらず、データセットへのアクセスを定義できます。
たとえば、データベースにデータが保存されると、有効なデータセットには、SQL クエリーの結果として、データベース全体またはデータベースのサブセットが含まれます。いずれの場合も、データは、情報を表示する Business Central のレポーティングコンポーネントの入力情報として使用されます。
データセットにアクセスするには、データセット定義を作成および登録する必要があります。このデータセットの定義では、データセットの場所と、その場所へのアクセス、読み取り、および解析の方法、ならびにデータセットが含まれるコラムを指定します。
Data Sets ページは、admin ロールを持つユーザーにのみ表示されます。
5.1. データセットの追加
外部データソースからデータを取得して、レポーティングコンポーネントでデータを使用するデータセットを作成できます。
手順
- Business Central で、Admin → Data Sets に移動します。Data Set Explorer ページが開きます。
New Data Set をクリックして、以下のプロバイダータイプから 1 つ選択します。
- Bean: Java クラスからデータセットを生成するのに使用します。
- CSV: リモートまたはローカルの CSV ファイルからデータセットを生成するのに使用します。
- SQL: ANSI-SQL 準拠データベースからデータセットを生成するのに使用します。
- Elastic Search: Elastic Search ノードからデータセットを生成するのに使用します。
Execution Server: Execution Server のカスタムのクエリー機能を使用してデータセットを生成します。
注記KIE Server は、このオプションを使用して設定する必要があります。
Data Set Creation Wizard を完了し、Test をクリックします。
注記設定手順は、選択するプロバイダーにより異なります。
- Save をクリックします。
5.2. データセットの編集
既存のデータセットを編集し、レポーティングコンポーネントに取得したデータが最新になっていることを確認します。
手順
- Business Central で、Admin → Data Sets に移動します。Data Set Explorer ページが開きます。
- Data Set Explorer ペインで、編集するデータセットを検索し、Edit をクリックします。
Data Set Editor ペインで、適切なタブを使用して必要に応じてデータを編集します。タブは、選択するデータセットプロバイダーの種類によって異なります。
たとえば、CSV データプロバイダーの編集には、以下の変更が適用できます。
- CSV Configuration: データセット定義の名前、ソースファイル、区切り記号などのプロパティーを変更できます。
Preview: データのプレビューを使用できます。CSV Configuration タブで Test をクリックすると、システムはデータセットのルックアップコールを実行し、データが利用可能な場合はプレビューが表示されます。Preview タブには 2 つのサブタブがあります。
- Data columns: どの列をデータセット定義に追加するかを指定できます。
- Filter: 新しいフィルターを追加できます。
Advanced: 以下の設定を管理できます。
- Caching: 詳細は、「キャッシュ」 を参照してください。
- Cache life-cycle: データセット (またはデータ) を再読み込みされるまでの間隔を指定できます。バックエンドデータに変更が加えられると、Refresh on stale data 機能は、キャッシュしたデータを再読み込みします。
- 必要な変更を行ったら、Validate をクリックします。
- Save をクリックします。
5.3. データの再読み込み
データの再読み込み機能を使用すると、データセット (またはデータ) を再読み込みされるまでの間隔を指定できます。バックエンドデータに変更が加えられると、Refresh on stale data 機能は、キャッシュしたデータを再読み込みします。
5.4. キャッシュ
Business Central は、インメモリーデータを使用してデータセットを保存し、データ操作を実行するキャッシュメカニズムを提供します。データのキャッシュにより、ネットワークトラフィック、リモートシステムのペイロード、処理時間が減ります。パフォーマンスの問題を回避するには、Decision Central にキャッシュを設定します。
データセットを生成するデータルックアップ呼び出しの場合、キャッシュメソッドは、データルックアップ呼び出しが実行される場所と結果のデータセットが格納される場所を決定します。データのルックアップコールの例としては、ロケールパラメーターを Urban として設定するすべての住宅ローンアプリケーションが挙げられます。
Business Central データセット機能には、キャッシュレベルが 2 つあります。
- クライアントレベル
- バックエンドレベル
クライアントキャッシュ
キャッシュを有効にすると、データセットはルックアップ操作時に Web ブラウザーにキャッシュされ、その後のルックアップ操作ではバックエンドへの要求が実行されません。グループ化、集計、フィルターリング、並べ替えなどのデータセット操作は Web ブラウザーで処理されます。クライアントのキャッシュは、データセットのサイズが小さい場合 (例: データが 10 MB より少ない) にのみ有効になります。データセットが大きい場合は、パフォーマンスの低下や断続的なフリーズなどのブラウザー問題が発生する場合があります。クライアントのキャッシュは、ストレージシステムへの要求などの、バックエンド要求の数を減らします。
バックエンドキャッシュ
キャッシュが有効な場合に、デシジョンエンジンはデータセットをキャッシュします。これにより、リモートのストレージシステムへのバックエンドの要求数が減ります。データセットの全操作は、インメモリーデータを使用してデシジョンエンジンで実行されます。バックエンドキャッシュは、データセットのサイズが頻繁に更新され、インメモリーに保存されて処理される場合に限り有効です。バックエンドキャッシングは、リモートストレージを使用した低レイテンシー接続問題が発生している状況でも有用です。
バックエンドキャッシュの設定は、Data Set Editor の Advanced タブに常に表示されるわけではありません。これは、インメモリーデシジョンエンジンでデータのルックアップ操作を解決するのに、Java および CSV のデータプロバイダーはバックエンドキャッシュに依存するためです (データセットはメモリー内に存在する必要があります)。
第6章 プロジェクト設定のカスタマイズ
プロジェクトにはアセットが保存され、スペースの一部になります。スペースでは、複数のプロジェクトを保持できます。
たとえば、組織には HR、給与、エンジニアリング、R&D など、多くの部署が含まれます。各部署はスペースにマッピングされ、部署ごとに独自のプロジェクトが割り当てられます。
最初から新規プロジェクトを作成するか、既存の Git リポジトリーからプロジェクトをクローンできます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Projects を選択します。Projects ページが開きます。
Project Preferences ペインで変更する設定をクリックします。以下の設定を利用できます。
File exporting: この設定には以下のプロパティーが含まれます。
表6.1 ファイルエクスポートのプロパティー
フィールド 説明 PDF の向き
PDF の向きが横向きか、縦向きかを指定します。
PDF の単位
PDF の単位が PT、MM、CN、または IN のいずれかを指定します。
PDF ページ形式
PDF ページ形式が A[0-10]、B[0-10]、または C[0-10] のいずれかに指定します。
Spaces: この設定には以下のプロパティーが含まれます。
表6.2 スペースのプロパティー
フィールド 説明 名前
スペースのデフォルト名。存在しない場合は自動的に作成されます。
所有者
スペースのデフォルトの所有者。存在しない場合は自動的に作成されます。
グループ ID
スペースのデフォルトグループ ID。存在しない場合は自動的に作成されます。
エイリアス (単数)
スペースのカスタマイズエイリアス (単数) を指定します。
エイリアス (複数)
スペースのカスタマイズエイリアス (複数) を指定します。
Default values: この設定には以下のプロパティーが含まれます。
表6.3 デフォルト値のプロパティー
フィールド 説明 バージョン
クイック設定オプションを使用してプロジェクトを作成する場合のプロジェクトのデフォルトバージョン番号
説明
クイック設定オプションを使用してプロジェクトを作成する場合のプロジェクトのデフォルトの説明
ブランチ
Git リポジトリーを使用時に使用するデフォルトのブランチ
Advanced GAV preferences: この設定には以下のプロパティーが含まれます。
表6.4 GAV 詳細設定のプロパティー
フィールド 説明 GAV の競合チェックを無効にしますか ?
GAV の競合チェックを有効化するか、無効化するか指定します。この機能を無効にすると、複数のプロジェクトに同じ GAV (グループ ID、アーティファクト、バージョン) を指定できます。
GAV の子エディションを許可しますか ?
GAV エディションに対する子/サブプロジェクトを許可するかどうかを指定します。
注記重複する GAV の検出は、Development Mode のプロジェクトでは無効になっています。Business Central のプロジェクトで重複する GAV 検出を有効にするには、プロジェクトの Settings → General Settings → Version に移動して、Development Mode オプションを OFF (該当する場合) に切り替えます。
- Save をクリックします。
第7章 アーティファクトリーポジトリーのカスタマイズのプロパティー
場合によっては、ドメインモデルの JAR ファイルをビルドするのに、プロジェクトで外部の依存関係を解決する必要があります。リポジトリーには、以下の機能を持つアーティファクトが必要です。
- リポジトリーは、Maven リポジトリーである
- 全スナップショットにはタイムスタンプが含まれる
- アセットはほぼ、ローカルのハードドライブに保存されている
デフォルトでは、アーティファクトのリポジトリーは $WORKING_DIRECTORY/repositories/kie
に含まれます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Artifact Repository を選択します。Artifact Repository ページが開きます。
- いずれかを選択して、Properties セクションに情報を入力します。
- Save をクリックします。
第8章 言語のカスタマイズ設定
Business Central の Settings ページで、言語を変更できます。Business Central は以下の言語をサポートします。
- 英語
- ドイツ語
- スペイン語
- フランス語
- 日本語
- ポルトガル語
- 簡体字中国語
デフォルトの言語は英語です。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Lauguages を選択します。Language Selector が開きます。
- Language リストから希望の言語を選択します。
- OK をクリックします。
第9章 プロセス管理のカスタマイズ
Business Central では、Process Administration ページの Default items per page プロパティーを編集して、デフォルトのページオプションをカスタマイズできます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Process Administration を選択します。
Properties セクションから Default items per page プロパティーを更新して、Save をクリックします。
注記ページごとに表示するアイテムは 10、20、50、または 100 のいずれかを指定できます。
第10章 Process Designer のカスタマイズ
Business Central では、Settings ページからダイアグラムエディターのプロパティーを編集して、Process Designer をカスタマイズできます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Process Designer を選択します。
Properties セクションで、以下のプロパティーのいずれかを更新します。
- Auto hide category panel チェックボックスを選択して、自動的にカテゴリーツールバーパネルが非表示になるようにします。
- 描画エリアの幅を設定するには、Drawing area width フィールドで、2800 から 5600 までの整数値を入力します。
- 描画エリアの高さを設定するには、Drawing area height フィールドで、1400 から 2800 までの整数値を入力します。
- 高解像度のディプレイを使用しており、文字やオブジェクトがぼやけて表示される場合には、Enable HiDPI チェックボックスを選択します。このオプションはデフォルトで無効になっています。
- Save をクリックします。
第11章 SSH キー
Business Central には SSH キーストアサービスがあり、ユーザーの SSH 認証を有効にします。また、設定可能なデフォルトの SSH キーストアと拡張可能な API (カスタムの実装) が含まれており、複数の SSH の公開鍵形式をサポートします。
SSH 公開鍵を登録するには、Business Central の Settings ページから SSH Keys オプションにアクセスできます。
11.1. デフォルトの SSH キーストア
Business Central に含まれるデフォルトの SSH キーストアでは、ユーザーの公開鍵を保存するのにファイルベースのストレージメカニズムが採用されています。デフォルトでは、Business Central は *.security
ディレクトリーを root ディレクトリーとして使用します。ただし、別のディレクトリーを参照するように、appformer.ssh.keys.storage.folder
システムプロパティーの値を設定することで、カスタムのストレージパスを使用できます。
SSH 公開鍵は {securityFolderPath}/pkeys/{userName}/
ディレクリー構造に保存されます。
各 SSH 公開鍵は以下のファイルで設定されており、これらのファイルはストレージフォルダーに配置されています。
{keyId}.pub
: このファイルには SSH 公開鍵のコンテンツが含まれます。ファイル名で、システムのロジックキー ID がわかるので、ファイル名がランタイム時に変更されないようにしてください。以下に例を示します。
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDmak4Wu23RZ6XmN94bOsqecZxuTa4RRhhQmHmTZjMB7HM57/90u/B/gB/GhsPEu1nAXL0npY56tT/MPQ8vRm2C2W9A7CzN5+z5yyL3W01YZy3kzslk77CjULjfhrcfQSL3b2sPG5jv5E5/nyC/swSytucwT/PE7aXTS9H6cHIKUdYPzIt94SHoBxWRIK7PJi9d+eLB+hmDzvbVa1ezu5a8yu2kcHi6NxxfI5iRj2rsceDTp0imC1jMoC6ZDfBvZSxL9FXTMwFdNnmTlJveBtv9nAbnAvIWlilS0VOkdj1s3GxBxeZYAcKbcsK9sJzusptk5dxGsG2Z8vInaglN6OaOQ7b7tcomzCYYwviGQ9gRX8sGsVrw39gsDIGYP2tA4bRr7ecHnlNg1b0HCchA5+QCDk4Hbz1UrnHmPA2Lg9c3WGm2qedvQdVJXuS3mlwYOqL40aXPs6890PvFJUlpiVSznF50djPnwsMxJZEf1HdTXgZD1Bh54ogZf7czyUNfkNkE69yJDbTHjpQd0cKUQnu9tVxqmBzhX31yF4VcsMeADcf2Z8wlA3n4LZnC/GwonYlq5+G93zJpFOkPhme8c2XuPuCXF795lsxyJ8SB/AlwPJAhEtm0y0s0l1l4eWqxsDxkBOgN+ivU0czrVMssHJEJb4o0FLf7iHhOW56/iMdD9w== userName
.{keyId}.pub.meta
: このファイルには、JSON 形式のキーメタデータが含まれます。キーにメタデータが含まれない場合は、新規のメタデータファイルが動的に生成されます。以下に例を示します。
{ "name":"Key", "creationDate":"Oct 10, 2018 10:10:50 PM", "lastTimeUsed":"Oct 11, 2018 12:11:23 PM" }
11.2. カスタムの SSH キーストア
要件に合わせてデフォルトの SSH キーストアを拡張し、カスタマイズできます。appformer.ssh.keystore
システムプロパティーで、使用する SSH サービスの Java クラス名を指定してください。このプロパティーが定義されていない場合や、不正な値が含まれる場合には、デフォルトの SSH キーストアが読み込まれます。
SSH キーストアのカスタム実装を作成するには、Java クラスが uberfire-ssh-api
モジュールで定義した org.uberfire.ssh.service.backend.keystore.SSHKeyStore
クラスを実装する必要があります。
11.3. SSH キーの作成
SSH キーを Business Central に追加または登録する前に、お使いのシステムで SSH キーを生成する必要があります。
手順
- システムでコマンド端末を開きます。
以下の例のように、
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
です。以下の例のように、プロンプトが表示されたら、Enter キーを押して、デフォルトのキーファイルの場所を確定します。
<user_login>
はユーザー名に置き換えてください。Enter a file in which to save the key (/home/<user_login>/.ssh/id_rsa): [Press enter]
コマンドプロンプトで、パスフレーズを入力して確定します。
Enter passphrase (empty for no passphrase): [Type a passphrase] Enter same passphrase again: [Type passphrase again]
ssh-agent
を起動します。eval "$(ssh-agent -s)" Agent pid <any-number-here>
新しい SSH 秘密鍵を
ssh-agent
に追加します。違う名前のキーを使用する場合は、コード内のid_rsa
を置き換えます。ssh-add ~/.ssh/id_rsa
11.4. SSH キーストアを使用した SSH 公開鍵の登録
新規作成した SSH 公開鍵は、Business Central キーストアに登録する必要があります。
手順
- システムでコマンド端末を開きます。
以下の例のように、
cat
コマンドを実行します。id_rsa
はキーの名前に置き換えます。cat ~/.ssh/id_rsa.pub
- SSH 公開鍵のコンテンツをコピーします。
- Business Central で、画面の右上隅にある Admin アイコンを選択し、SSH Keys を選択します。
- SSH Keys ページで Add SSH Key をクリックします。
Add SSH Key ウィンドウで Name フィールドに名前を入力し、SSH 公開鍵のコンテンツを Key フィールドにコピーします。
注記Name および Key は必須のフィールドです。
- Add SSH Key をクリックしてキーを登録します。
11.5. SSH キーの削除
Business Central の SSH Keys ページから SSH キーを削除できます。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、SSH Keys を選択します。
- SSH Keys ページで削除する SSH キーの削除アイコンをクリックします。
- Delete SSH Key をクリックして、削除を確定します。
第12章 Business Central でのサービスタスクの管理
サービスタスク (作業アイテム) とは、複数のビジネスプロセスまたは Business Central の全プロジェクトの間でカスタマイズして再利用できるタスクのことです。Red Hat Decision Manager は、Business Central のサービスタスクのリポジトリーで、サービスタスクセットを提供します。デフォルトのサービスタスクを有効化または無効化して、カスタムのサービスタスクを Business Central にアップロードし、適切なプロセスにこのタスクを実装できます。
手順
Business Central で、画面の右上隅にある Admin アイコンを選択して、Service Tasks Administration を選びます。
このページは、サービスタスクのインストール設定や、Business Central 全体にあるプロジェクトのプロセスで利用可能なサービスタスクを表示します。このページで有効にしたサービスタスクは、プロジェクトレベルの設定で利用できます。プロジェクトレベルの設定で、プロセスで使用する各サービスタスクをインストールできます。サービスタスクをプロジェクトにインストールする方法は、Service Tasks Administration ページの Settings で有効化または無効化したグローバル設定により決まります。
Settings で、各設定を有効化または無効化して、ユーザーがプロジェクトレベルでインストールするときに、利用可能なサービスタスクを実装する方法を決定します。
以下のサービスタスクの設定が利用できます。
- Install as Maven artifact: ファイルがない場合には、サービスタスクの JAR ファイルを Maven リポジトリーにアップロードし、Business Central で設定します。
-
Install service task dependencies into project: サービスタスクの依存関係をプロジェクトの
pom.xml
ファイルに追加します。このファイルでタスクがインストールされます。 -
Use version range when installing service task into project: プロジェクトの依存関係として追加するサービスタスクの固定バージョンではなく、バージョン範囲を使用します。たとえば、
7.16.0.Final
ではなく[7.16,)
です。
必要に応じて利用可能なサービスタスクを有効化または無効化します (ON または OFF に設定)。有効化したサービスタスクは、Business Central の全プロジェクトのプロジェクトレベル設定に表示されます。
図12.1 サービスタスクおよびサービスタスク設定の有効化
-
カスタムのサービスタスクを追加するには、Add Service Task, をクリックして、適切な JAR ファイルを参照し、Upload アイコンをクリックします。JAR ファイルには、
@Wid
のアノテーションを指定したワークアイテムハンドラーの実装を含める必要があります。 - Business Central ですべての必須サービスタスクを設定した後に、プロジェクトの Settings → Service Tasks に移動して、有効化した利用可能なサービスタスクを表示してください。
- サービスタスクごとに、Install をクリックして、対象のプロジェクトのプロセスでタスクを利用できるようにするか、Uninstall をクリックして、プロジェクトのプロセスからタスクを除外します。
サービスタスクのインストール時に追加情報を求められた場合には、サービスタスクの必須パラメーターも入力して、もう一度 Install をクリックします。
サービスタスクの必須パラメーターは、タスクのタイプにより異なります。たとえば、ルールとデシジョンタスクにはアーティファクトの GAV 情報 (グループ ID、アーティファクト ID、およびバージョン) が、メールタスクにはホストとポートアクセスの情報が、REST タスクには API の認証情報が必要です。他のサービスタスクでは、追加のパラメーターが必要でない場合もあります。
図12.2 プロセスで使用するためのサービスタスクのインストール
プロジェクトページに戻り、プロジェクトのビジネスプロセスを選択または追加します。プロセスデザイナーパレットで Service Tasks オプションを選択すると、有効化してインストールした、利用可能なサービスタスクが表示されます。
図12.3 プロセスデザイナーでのインストール済みサービスタスクのアクセス
第13章 LDAP 接続
Business Central は、ユーザータスクサービスがユーザー、グループ、およびロールの情報を LDAP サービスから直接取得できるように、Red Hat Decision Manager で LDAP サーバー専用の UserGroupCallback
実装を提供します。
以下の LDAP UserGroupCallback
実装プロパティーは、設定可能です。
表13.1 LDAP UserGroupCallback プロパティー
プロパティー | 説明 |
---|---|
| LDAP サーバーへの接続に使用するユーザー名 指定がない場合はこのプロパティーは任意となり、LDAP サーバーは匿名アクセスを受け入れます。 |
| LDAP サーバーへの接続に使用するパスワード 指定がない場合はこのプロパティーは任意となり、LDAP サーバーは匿名アクセスを受け入れます。 |
| ユーザー情報を含む LDAP のコンテキスト |
| グループおよびロールの情報を含む LDAP のコンテキスト |
| ユーザーグループおよびロールのメンバーシップ情報を含む LDAP のコンテキスト
指定がない場合はこのプロパティーは任意となり、代わりに |
| ユーザー情報検索用のフィルター このプロパティーは通常、代入キー {0} が含まれており、パラメーターと置き換えられます。 |
| グループおよびロールの情報の検索フィルター このプロパティーは通常、代入キー {0} が含まれており、パラメーターと置き換えられます。 |
| ユーザーグループおよびロールのメンバーシップ情報を検索するためのフィルター このプロパティーは通常、代入キー {0} が含まれており、パラメーターと置き換えられます。 |
| LDAP に含まれるユーザー ID の属性名
指定がない場合はこのプロパティーは任意となり、代わりに |
| LDAP 内のグループおよびロール ID の属性名
指定がない場合はこのプロパティーは任意となり、代わりに |
|
DN のユーザー ID。ロールの検索前にユーザー DN をクエリーするようにコールバックを指示します。これは任意で、デフォルトは |
|
初期コンテキストファクトリークラス名。デフォルトは |
|
認証タイプ。可能な値は、 |
|
|
|
LDAP url (デフォルトは |
13.1. LDAP UserGroupCallback 実装
以下のいずれかの方法で、該当の LDAP プロパティーを設定して、LDAP UserGroupCallback
実装を使用できます。
プログラム: 該当の
LDAPUserGroupCallbackImpl
プロパティーでプロパティーのオブジェクトをビルドし、プロパティーオブジェクトで、パラメーターとしてLDAPUserGroupCallbackImpl
を作成します。以下に例を示します。
import org.kie.api.PropertiesConfiguration; import org.kie.api.task.UserGroupCallback; ... Properties properties = new Properties(); properties.setProperty(LDAPUserGroupCallbackImpl.USER_CTX, "ou=People,dc=my-domain,dc=com"); properties.setProperty(LDAPUserGroupCallbackImpl.ROLE_CTX, "ou=Roles,dc=my-domain,dc=com"); properties.setProperty(LDAPUserGroupCallbackImpl.USER_ROLES_CTX, "ou=Roles,dc=my-domain,dc=com"); properties.setProperty(LDAPUserGroupCallbackImpl.USER_FILTER, "(uid={0})"); properties.setProperty(LDAPUserGroupCallbackImpl.ROLE_FILTER, "(cn={0})"); properties.setProperty(LDAPUserGroupCallbackImpl.USER_ROLES_FILTER, "(member={0})"); UserGroupCallback ldapUserGroupCallback = new LDAPUserGroupCallbackImpl(properties); UserGroupCallbackManager.getInstance().setCallback(ldapUserGroupCallback);
宣言設定: アプリケーションのルートに
jbpm.usergroup.callback.properties
ファイルを作成するか、システムプロパティーとしてファイルの場所を指定します。以下に例を示します。
-Djbpm.usergroup.callback.properties=FILE_LOCATION_ON_CLASSPATH
ユーザータスクサーバーの起動時に LDAP コールバックを登録するようにしてください。
以下に例を示します。
#ldap.bind.user= #ldap.bind.pwd= ldap.user.ctx=ou\=People,dc\=my-domain,dc\=com ldap.role.ctx=ou\=Roles,dc\=my-domain,dc\=com ldap.user.roles.ctx=ou\=Roles,dc\=my-domain,dc\=com ldap.user.filter=(uid\={0}) ldap.role.filter=(cn\={0}) ldap.user.roles.filter=(member\={0}) #ldap.user.attr.id= #ldap.roles.attr.id=
関連情報
第14章 データベース接続
Business Central は、Red Hat Decision Manager でデータベースサーバー用の UserGroupCallback
実装を提供し、ユーザータスクサービスを有効にします。ユーザータスクサービスを使用して、ユーザーやグループ (ロール) の情報を直接データベースから取得できるようにします。
以下のデータベースの UserGroupCallback
実装プロパティーを設定することができます。
表14.1 データベースの UserGroupCallback プロパティー
プロパティー | 説明 |
---|---|
| 接続に使用するデータソースの JNDI 名 |
| ユーザーの存在を確認する |
| 特定のユーザーのグループを収集する |
| グループの存在を確認する |
14.1. データベースの UserGroupCallback 実装
データベースの UserGroupCallback
実装では、必須のデータベースを作成する必要があります。以下のいずれかの方法で、該当のデータベースプロパティーを設定し、この実装を使用できます。
プログラム: 該当の
DBUserGroupCallbackImpl
プロパティーでプロパティーのオブジェクトをビルドし、プロパティーオブジェクトで、パラメーターとしてDBUserGroupCallbackImpl
を作成します。以下に例を示します。
import static org.jbpm.services.task.identity.DBUserGroupCallbackImpl.DS_JNDI_NAME; import static org.jbpm.services.task.identity.DBUserGroupCallbackImpl.PRINCIPAL_QUERY; import static org.jbpm.services.task.identity.DBUserGroupCallbackImpl.ROLES_QUERY; import static org.jbpm.services.task.identity.DBUserGroupCallbackImpl.USER_ROLES_QUERY; ... props = new Properties(); props.setProperty(DS_JNDI_NAME, "jdbc/jbpm-ds"); props.setProperty(PRINCIPAL_QUERY, "select userId from Users where userId = ?"); props.setProperty(ROLES_QUERY, "select groupId from UserGroups where groupId = ?"); props.setProperty(USER_ROLES_QUERY, "select groupId from UserGroups where userId = ?"); callback = new DBUserGroupCallbackImpl(props);
宣言設定: アプリケーションのルートに
jbpm.usergroup.callback.properties
ファイルを作成するか、システムプロパティーとしてファイルの場所を指定します。以下に例を示します。
-Djbpm.usergroup.callback.properties=FILE_LOCATION_ON_CLASSPATH
ユーザータスクサーバーの起動時にデータベースコールバックを登録するようにしてください。
以下に例を示します。
System.setProperty("jbpm.usergroup.callback.properties", "/jbpm.usergroup.callback.db.properties"); callback = new DBUserGroupCallbackImpl(true); ... db.ds.jndi.name = jdbc/jbpm-ds db.user.query = select userId from Users where userId = ? db.roles.query = select groupId from UserGroups where groupId = ? db.user.roles.query = select groupId from UserGroups where userId = ?
関連情報
第15章 settings.xml ファイルを使用した Maven の設定
Java アプリケーション開発は、Apache Maven ビルド自動化ツールを使用して、ソフトウェアプロジェクトをビルドし、管理します。Maven は Project Object Model (POM) 設定の XML ファイルを使用して、プロジェクトプロパティーとビルドプロセスの両方を定義します。
Maven はレポジトリーを使用して Java ライブラリー、プラグイン、および他のビルドアーティファクトを格納します。リポジトリーはローカルまたはリモートのいずれかになります。ローカルリポジトリーは、ローカルマシンにキャッシュされたリモートリポジトリーからアーティファクトをダウンロードしたものです。リモートリポジトリーは、http://
(HTTP サーバーにある場合) や file://
(ファイルサーバーにある場合) などの一般的なプロトコルを使用してアクセスされる他のリポジトリーです。デフォルトのリポジトリーは、パブリックのリモート Maven 2 Central Repository となっています。Maven は、settings.xml ファイルを変更して設定できます。グローバルの Maven 設定は、M2_HOME/conf/settings.xml
ファイルで、ユーザーレベルの設定は USER_HOME/.m2/settings.xml
ファイルで実行可能です。
関連情報
第16章 GAV チェック管理
Business Central では、プロジェクトは グループ ID、アーティファクト ID、および バージョン (GAV) の Maven 命名規則で識別されます。GAV の値は、プロジェクトとプロジェクトバージョンを区別し、特定のプロジェクトとの依存関係を識別します。
デフォルトでは、Business Central は GAV の重複を検出します。この機能は、admin ロールを持つユーザーにより無効にできます。
16.1. GAV チェックおよび子の GAV エディションの設定
以下の手順では、Business Central での GAV チェックの設定方法を説明します。
手順
- Business Central で、Menu → Design → Projects に移動して、プロジェクト名をクリックします。
- プロジェクトウィンドウで、Settings タブをクリックします。
General Settings タブで以下のタスクを実行します。
- 他のプロジェクトで同じ GAV を使用できるようにするには、Disable GAV conflict check チェックボックスを選択します。
- このプロジェクトに GAV エディションを指定できるようにするには、Allow child GAV edition チェックボックスを選択します。
Save をクリックします。
注記Reset をクリックして、すべての変更を元に戻すことができます。
- Save をクリックして、変更を確定します。
重複する GAV の検出は、Development Mode のプロジェクトでは無効になっています。Business Central で重複する GAV 検出を有効にするには、プロジェクトの Settings → General Settings → Version に移動して、Development Mode オプションを OFF (該当する場合) に切り替えます。
16.2. 全プロジェクトの GAV チェックの設定
以下の手順では、Business Central の全プロジェクトに GAV チェックを設定する方法を説明します。また、システムの起動時に GAV チェックを無効にすることも可能です。
手順
- Business Central で、画面の右上隅にある Admin アイコンを選択し、Projects を選択します。Projects ウィンドウが開きます。
Advanced GAV preferences タブで以下のタスクのいずれかを実行します。
- 他のプロジェクトで同じ GAV を使用できるようにするには、Disable GAV conflict check チェックボックスを選択します。
- このプロジェクトに GAV エディションを指定できるようにするには、Allow child GAV edition チェックボックスを選択します。
- Save をクリックします。
Business Central の起動時に、org.guvnor.project.gav.check.disabled
システムプロパティーを true に設定して、重複した GAV の削除機能を無効にすることも可能です。
$ ~/EAP_HOME/bin/standalone.sh -c standalone-full.xml -Dorg.guvnor.project.gav.check.disabled=true
第17章 Decision Server および Business Central での環境モードの設定
Decision Server は、production
(実稼働) モードと development
(開発) モードでの実行が設定可能です。開発モードでは、柔軟な開発ポリシーが提供され、小規模な変更の場合はアクティブなプロセスインスタンスを維持しながら、既存のデプロイメントユニット (KIE コンテナー) を更新できます。また、大規模な変更の場合は、アクティブなプロセスインスタンスを更新する前に、デプロイメントユニットの状態をリセットすることも可能です。実稼働モードは、各デプロイメントで新規デプロイメントユニットが作成される実稼働環境に最適です。
開発環境では、Business Central の Deploy をクリックして、実行中のインスタンスを停止せずにビルドされた KJAR ファイルを Decision Server にデプロイするか (該当する場合)、または Redeploy をクリックして、ビルドされた KJAR ファイルをデプロイし、実行中のインスタンスを停止します。ビルドした KJAR ファイルを次回にデプロイまたは再デプロイすると、以前のデプロイメントユニット (KIE コンテナー) が同じターゲット Decision Server で自動的に更新されます。
実稼働環境では、Business Central の Redeploy オプションは無効になり、Deploy をクリックして、ビルドした KJAR ファイルを Decision Server 上の新規デプロイメントユニット (KIE コンテナー) にデプロイすることのみが可能です。
手順
-
Decision Server 環境モードを設定するには、
org.kie.server.mode
システムプロパティーをorg.kie.server.mode=development
またはorg.kie.server.mode=production
に設定します。 Business Central のプロジェクトにデプロイメントの動作を設定するには、プロジェクトの Settings → General Settings → Version に移動して、Development Mode オプションを切り替えます。
注記デフォルトでは、Decision Server と Business Central の新規プロジェクトはすべて、開発モードになっています。
Development Mode がオンのプロジェクトや、実稼働モードの Decision Server に手動で
SNAPSHOT
バージョンの接尾辞を追加したプロジェクトをデプロイすることはできません。
第18章 リポジトリーフック
Business Central で、フックとして知られるスクリプトを使用し、特定のイベントが発生するたびに、リポジトリーが指定のアクションをトリガーするように設定できます。Git フックの詳細は、Customizing Git Hooks を参照してください。
18.1. Git フックの設定
Business Central では、コミット後のフックを設定し、Git フックを使用してリモートのリポジトリーに対して自動的に変更をプッシュできます。
現在、コミット後にフックのみがサポートされています。コミット後のフックは、コミットプロセスの完了後にトリガーされます。
前提条件
- Red Hat JBoss EAP 7.2 サーバーインスタンスに Red Hat Decision Manager がインストールされている。
- Red Hat Decision Manager プロジェクトが外部の Git リポジトリーに存在している。
- 外部 Git リポジトリーへの読み取りアクセスに必要な認証情報。
-
(Windows の場合) Cygwin は、インストール時に追加される Git パッケージでインストールします。Cygwin
/bin
フォルダーへのパスは、お使いの環境のPATH
変数に追加されます。たとえば、C:\cygwin64\bin
です。Cygwin のインストールに関する詳細は、Installing and Updating Cygwin Packages を参照してください。
手順
- Business Central で、Menu → Projects に移動します。
- Git プロジェクトをインポートするスペースを選択または作成します。
- 画面の右側の をクリックして、Import Project を選択します。
-
Import Project ウィンドウで、Git リポジトリーの URL を入力します (例:
https://github.com/USERNAME/REPOSITORY_NAME.git
および Git リポジトリーの認証情報)。 Import をクリックします。
プロジェクトを Business Central の Git リポジトリーに追加すると、スペースで使用できるようになります。
重要SCP スタイルの SSH URL の代わりに、HTTPS または Git プロトコルを使用します。Business Central は基本的な SSH URL をサポートしないため、この URL を使用する場合はエラーが発生します。
公開 SSH キーを Git プロバイダーに設定する必要があります。
Git リポジトリーは、Red Hat Decision Manager のバージョンと互換性のある KJAR が 1 つだけ含まれる、KJAR プロジェクトでなければなりません。KJAR コンテンツは、リポジトリーのルートに配置する必要があります。
コマンドターミナルで、リポジトリーのフォルダーに移動します。
cd JBOSS_HOME/bin/.niogit/<SPACE>/REPOSITORY_NAME.git
-
権限が
rwxr—r--
に設定されたhooks
フォルダーにpost-commit
ファイルを作成します。たとえば、JBOSS_HOME/bin/.niogit/<SPACE>/REPOSITORY_NAME.git/hooks/post-commit
です。 以下のコンテンツを
post-commit
ファイルに追加します。#!/bin/sh git push origin +master
設定が正常に行われたことを確認するには、Business Central のガイド付きルールを作成します。
- Business Central で Menu → Projects → Add Asset → Guided Rule に移動します。
- Create new Guided Rule ページで必要な情報を入力します。
OK をクリックします。
Business Central は、リモートリポジトリーにすべての変更を自動的にプッシュします。
org.uberfire.nio.git.hooks
システムプロパティーの値に対して、フックファイルのディレクトリーを指定できます。このディレクトリーは、新たに作成された Git リポジトリーにコピーされます。この設定の standalone.xml
ファイルの一例として、以下を参照してください。
<system-properties> <property name="org.uberfire.nio.git.hooks" value="/opt/jboss-as/git-hooks"> </property> ... </system-properties>
18.2. Git フックの終了コード
Git フックの終了時には、整数値が返され、Git フックの実行ステータスを判断します。この整数値は、Git フックの終了コードとして知られています。実行ステータスは、成功 (1)、警告 (2 から 30) または失敗 (31 から 255) です。
18.3. Git フック通知のカスタマイズ
Business Central には、フックの終了コードをもとに、カスタマイズした Git フック通知をユーザーが受信可能なメカニズムがあります。
この通知メカニズムを有効にするには、カスタムのメッセージを含む *.properties
ファイルを作成してから、appformer.git.hooks.bundle
システムプロパティーの値として対象のファイルのパスを指定する必要があります。
手順
*.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 文字コードのエスケープシーケンスを使用してください。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>
18.3.1. Business Central の Git フック通知
Business Central で Git フックの通知を確認できます。Git フックの終了コードの通知タイプは 3 種類あります。
表18.1 Git フックの UI 通知タイプ
終了コード | カスタマイズしたメッセージ | UI での通知の色 |
---|---|---|
| Success!All working as expected. (成功 ! すべて想定どおりに機能しています。) | 緑 |
| Warning!Please check the logs and advise your admin. (警告 ! ログを確認して管理者に連絡してください。) | オレンジ |
| Error!Please advise your admin immediately. (エラー ! 今すぐ管理者に連絡してください。) | 赤 |
UNIX マシンがサポートするエラーコードは 0 (success) から 255 (error) までで、この範囲外の終了コードは別のコードに変換され、誤った通知メッセージが表示される可能性があります。
Windows マシンには、制限がなく、幅広い終了コードをサポートします。
18.3.2. Git フック通知の国際化サポート
通知メッセージの国際化には、appformer.git.hooks.bundle
システムプロパティーとして指定した元のプロパティーファイルと同じパスに、追加でプロパティーファイルを配置してください。
各種ローカライズファイルの名前は、<filename>_<lang>.properties
に指定し、<filename>
は元のファイルと同じファイル名にしてください。たとえば、システムプロパティーが Messages.properties
を参照している場合、英語は Messages_en.properties
、フランス語は Messages_fr.properties
、またはイタリア語は Messages_it.properties
として作成できます。
通知サービスは、ユーザー言語をもとにプロパティーファイルを選択します。対象言語の翻訳がない場合には、元の Messages.properties
ファイルからのエントリーを使用します。
第19章 プロセスインスタンスログの表示
Logs タブから、インスタンスのプロセスイベントをすべて表示できます。インスタンスログは、現在と過去のプロセスの状態をすべて表示します。Business Central には、Business と Technical ログの 2 種類のプロセスインスタンスログがあります。
手順
- Business Central で、Menu → Manage → Process Instances に移動します。
- Manage Process Instances ページで、表示するログのプロセスインスタンスをクリックします。
Logs タブを選択します。
- ビジネスインベントログを表示するには、Business をクリックします。
- テクニカルイベントログを表示するには、Technical をクリックします。
- Asc または Desc をクリックすると、ログファイルの順序が変わります。
付録A バージョン情報
本書の最終更新日: 2021 年 11 月 15 日 (月)