3.19.1. アラート機能¶
IM-Workflow ではアラート機能として以下に示す動作仕様を定めています。後述する標準提供のアラート検出プログラムも以下に従って実装されています。また、動作仕様に従う形でアラート機能を追加実装することもできます。
「アラート検出プログラム」はワークフローの状態を確認できます。確認の結果、検出プログラムが定めた条件に合致する場合はアラート情報を通知します。 アラート検出プログラムが通知したアラート情報は「アラート一覧画面」にて参照できます。ただし、アラート一覧画面を使用できるのはワークフローシステム管理者のみです。アラート情報には以下の要素があります。
アラート情報 項目名 キー 必須 アラート情報ID キー TRUE システムにて採番アラート情報を一意に指し示しますアラート種類 - TRUE アラートの検出対象を識別するID通常は1つのアラート検出プログラムを指示します検出日時 - TRUE アラートを検出した日時 アラートレベル - TRUE アラートレベルを表す アラートメッセージ - FALSE アラート画面に表示するメッセージ リンク使用可否 - FALSE アラートメッセージをリンク表示するかどうかのフラグ URL - FALSE アラートメッセージをリンク表示した際の遷移先URL
アラートの検出対象を一意に示すIDを「アラート種類」と呼びます。通常は1つの検出プログラムは1つの検出対象のチェックを行いますので、アラート種類はアラート検出プログラムを一意に示すIDとしても使用します。 アラート機能で通知するメッセージを「アラートメッセージ」と呼びます。アラートメッセージは任意のページへのリンクとすることもできます。また、メッセージの表示言語はワークフローシステム管理者に設定されているロケールで切り替わります。 アラート情報にはエラーレベルを設定できます。これを「アラートレベル」と呼びます。アラート検出プログラム側で以下の値のうち何れかを設定します。アラートレベル
条件 説明 INFO 情報レベル WARN 警告レベル ERROR エラーレベル
- アラート検出プログラムとアラート一覧画面は「アラートテーブル」を介してアラート情報を共有します。
アラート検出プログラムとアラート画面