System Governance Toolkit には、ガバナンス・プロセスを作成またはカスタマイズするために IBM Process Designer で使用できるテンプレートとサービスが用意されています。
概要
IBM Business Process Manager のインストール時に、System Governance Toolkit (TWSYSG) が Process Center リポジトリーにインポートされます。作成する各ガバナンス・プロセスには、System Governance Toolkit への依存関係が含まれている必要があります。
ツールキットには、ガバナンス・プロセスの作成に必要な仕組みが用意されています。 ツールキットには、プロセス・アプリケーション・スナップショットのインストールやスナップショット状況の設定を行うための統合サービスが含まれています。
System Governance Toolkit 内の成果物の編集や変更はできませんが、ツールキットを開いてその内部にある成果物を表示することはできます。
テンプレート
System Governance Toolkit に用意されているテンプレートには、「要求されたインストール」テンプレートと「Snapshot 状況変更」テンプレートの 2 つがあります。これらのテンプレートのそれぞれがビジネス・プロセス定義 (BPD) であり、特定の組織のニーズに適応させることができます。それぞれのテンプレートは、対応するガバナンス・イベントに関連付けられています。ガバナンス・サービスを利用するには、いずれかのテンプレートから Process Center でガバナンス・プロセスを作成する必要があります。
- 「要求されたインストール」テンプレート
- このテンプレートをベースとして使用して、カスタマイズしたガバナンス・プロセスを作成し、インストール・サービスをツールキットから呼び出すだけに過ぎないデフォルトの「要求されたインストール」BPD を置き換えます。「要求されたインストール」テンプレートには、(ProcessAppInstallation タイプの) ProcessAppInstallationRequest 変数が含まれています。
- 「Snapshot 状況変更」テンプレート
- このテンプレートをベースとして使用して、カスタマイズしたガバナンス・プロセスを作成し、アクティビティーが 1 つもないデフォルトの「Snapshot 状況変更」BPD を置き換えます。「Snapshot 状況変更」テンプレートには、(SnapshotStatus タイプの) SnapshotStatusRequest 変数が含まれています。
インストール・サービス
System Governance Toolkit には、インストール・ガバナンス用に以下の統合サービスが用意されており、これらはすべて Process Center でローカルにのみ実行されます。 これらのサービスを使用してスナップショットのインストール、インストールのキャンセル、またはインストール状況の設定を行う場合は、Process Center でインストール要求を開始する必要があります。 詳しくは、これ以降の各セクションを参照してください。
- Snapshot のインストール
- 指定されたプロセス・サーバーにスナップショットをインストールします。
- Snapshot インストールのキャンセル
- 進行中の (つまり、承認を待機中の) インストール要求をキャンセルします。インストールが開始された後は、キャンセル要求は無視されます。
- すべての Process Server の取得
- Process Center に登録済みのプロセス・サーバーの配列を返します。
- インストール状況の設定
- 長時間にわたるインストール中のインストール状況を設定します。
ガバナンス・プロセスで使用するインストール状況メッセージを定義してください。
- インストール状況の取得
- 長時間にわたるインストール中のインストール状況を取得します。
インストール試行が失敗した場合は、「Snapshot インストールのキャンセル」サービスを呼び出して、Process Center の状況をクリアします。 これ以外の方法で失敗をクリアするには、プロセス・アプリケーションのガバナンス・プロセスをシステム・デフォルトのプロセスにリセットするしかありません。「Snapshot のインストール」サービスを呼び出したガバナンス・ビジネス・プロセス定義 (BPD) は、その障害から入手できるすべてのデータを既に持っているはずであり、その情報を E メールで送信するか、ログに記録することができます。 プロセス・アプリケーションのエラーが原因で発生した障害については、その状況を失敗のままにして、誰もそのバージョンを再インストールしないようにした方がよい場合があります。
Snapshot のインストール
- 入力: processAppInstallation
- 入力: processAppInstallationRequest。これは、デフォルトの「要求されたインストール」BPD で使用されます。
- 出力: installResponse。これは、インストールが成功したかどうか、および障害がリカバリー可能かどうかを判別するために使用されます。
- 実装: インストールのための Java API を呼び出します。
このサービスは、いくつかの理由でスナップショットのインストールに失敗することがあります。 インストール要求は、エラーが発生したかどうか、およびエラーがリカバリー可能かどうかを示す戻り値を生成します。
Snapshot インストールのキャンセル
- 入力: installRequest (processAppInstallation)
- 実装: インストールのための Java API を呼び出します。
このサービスは、以下の場合に失敗することがあります。
- 「Snapshot インストールのキャンセル」サービスは、入力として processAppInstallation オブジェクトを取り、処理中に processAppInstallation に設定されたさまざまな ID を使用します。 それらの ID は、NULL または長さ 0 であってはなりません。また、スナップショット・インストール要求が実行されたときに processAppInstallation オブジェクトが受信した同じ ID でなければなりません。
- インストールが開始した後にキャンセルが呼び出された場合、キャンセル要求は無視されます。
- 同じインストール要求に対してキャンセルが複数回呼び出された場合、最初の呼び出しの後はすべての呼び出しが無視されます。これは、インストール要求が既にキャンセルされたためです。
- ガバナンスが有効になっていないプロセス・アプリケーションに対してキャンセルが呼び出された場合、キャンセル要求は無視されます。
- スナップショットとプロセス・サーバーの組み合わせに対してアクティブなインストール要求が存在しない場合、キャンセル要求は失敗します。
- スナップショットまたはプロセス・サーバーが正しく識別されない場合、Process Center で検出することはできません。
すべての Process Server の取得
- 出力: processServers (processServers) は、使用可能なプロセス・サーバーのリストを提供します。
- 実装: リストを取得するための Java API を呼び出します。
インストール状況の設定
インストール要求が承認を待っている間のインストール状況を更新するには、このサービスを使用します。 このサービスが呼び出されると、現在の状況またはインストールが完了するのを待たずに、状況が即座に更新されます。
このサービスは、以下の入力を取ります。
- processServerID (ストリング)
- snapshotID (ストリング)
- status (ストリング)。これは、1 から 64 文字の範囲内でなければなりません。
- description (ストリング)。これはオプションです。長さは 0 から 250 文字の範囲内でなければなりません。
実装: インストール状況を設定するための Java API を呼び出します。
このサービスは、以下の場合に失敗することがあります。
- ガバナンスが有効になっていない場合は、このサービスを使用できません。
- 当該スナップショットとプロセス・サーバーの組み合わせに対するインストール要求が存在しない場合は、状況を提供できません。 つまり、インストール要求がオープンであり、アクティブである必要があります。
- 「Snapshot のインストール」サービスが完了した後で「インストール状況の設定」サービスを呼び出すことはできません。「Snapshot のインストール」要求によって状況が変更され、インストール完了時にはすべての状況値が削除されます。
- このサービスが呼び出される前にインストールが失敗した場合、状況は提供されません。
- スナップショットまたはプロセス・サーバーが正しく識別されない場合、Process Center で検出することはできません。
インストール状況の取得
- 入力: processServerID (ストリング)
- 入力: snapshotID (ストリング)
- 出力: status (String) は、「インストール状況の設定」を通してカスタム・メッセージが提供されない場合に、事前定義された状況メッセージを提供します。
- 実装: インストール状況を設定するための Java API を呼び出します。
Snapshot 状況サービス
System Governance Toolkit には、スナップショット状況の追跡用に以下の統合サービスが用意されており、これらはすべて Process Center でローカルにのみ実行されます。 次の 3 つのサービスは、プロセス・アプリケーションとツールキットの両方で使用できます。
スナップショット状況サービスをガバナンス・プロセスと共に使用することも、ガバナンス・プロセスと関係なく使用することもできます。 スナップショット状況イベントは、それらが使用されていてもいなくても、常にアクティブです。
- スナップショット状況の取得
- スナップショットの状況を返します。
- 複数のスナップショット状況の取得
- スナップショットで使用されている状況を含むストリングのリストを返します。 このリストには、製品に定義されているデフォルト値と、ガバナンス・プロセスを通して追加され、現在スナップショットで使用されているカスタム値が含まれます。
- スナップショット状況の設定
- スナップショットを、指定された状況に設定します。 指定された状況ストリングがまだ存在しない場合、API は、そのストリングを使用する新しい状況値を作成します。
Snapshot 状況の取得
- 入力: snapshotID (ストリング)
- 出力: status (ストリング)
- 実装: 状況を取得するための Java API を呼び出します。
複数の Snapshot 状況の取得
- 出力: statuses (ストリング) (リスト)
- 実装: 状況のリストを取得するための Java API を呼び出します。
Snapshot 状況の設定
- 入力: status (ストリング)。ストリングの拡張です。長さは 1 から 50 文字の範囲内でなければなりません。
- 入力: snapshotID (ストリング)
- 実装: 状況を設定するための Java API を呼び出します。