JP1/Base 関数リファレンス
JP1イベントの拡張属性を次に示します。拡張属性には,共通情報と固有情報があります。
- <この項の構成>
- (1) 共通情報
- (2) 固有情報
(1) 共通情報
拡張属性の共通情報を次に示します。
表A-2 拡張属性(共通情報)
属性名 項目 内容 SEVERITY 重大度 次に示す重大度がある。
Emergency,Alert,Critical,Error,Warning,Notice,Information,Debug
重大度の詳細については,「表A-3 重大度の意味」を参照のこと。USER_NAME ユーザー名 ユーザー名。業務を実行しているユーザーの名前。 PRODUCT_NAME プロダクト名 プロダクト名。プロダクト名は,スラント「/」で区切られた半角英数字列となる。次のどちらかの形式に従い,会社ごとにユニークな文字列となるようにする。
/会社名/シリーズ名/プロダクト名
または
/会社名/プロダクト名
なお,会社名「HITACHI」は予約されているため,使用できない。OBJECT_TYPE オブジェクトタイプ オブジェクトタイプには,イベント発行元のオブジェクトの種類を指定する。デフォルトでは,次のオブジェクトタイプが登録されている。このタイプを使用してJP1イベントのフィルタリングおよび検索を実行するため,同じ意味を持つJP1イベントは,できるだけ同じオブジェクトタイプとして扱えるように指定する。
新しいオブジェクトタイプを追加する場合は,ユニークな名称を指定する。オブジェクトタイプを追加した場合は,オブジェクトタイプ定義ファイルを作成する必要がある。
JOB:ジョブ
JOBNET:ジョブネット
ACTION:アクション
ACTIONFLOW:アクションフロー
PRINTJOB:印刷ジョブ
PRINTQUEUE:プリントキュー
PRINTER:プリンタ
BATCHQUEUE:バッチキュー
PIPEQUEUE:パイプキュー
JOBBOX:ジョブボックス
LOGFILE:ログファイル
LINK:リンク(下位層の通信レイヤーの事象通知用)
SERVICE:サービス(デーモンプロセスなど)
PRODUCT:プロダクト(プログラム固有のそのほかの事象通知用)
CONFIGRATION:構成定義
SERVER:サーバ
BACKUP:バックアップ
RESTORE:リストア
MEDIA:メディアOBJECT_NAME オブジェクト名 オブジェクト名。オブジェクトタイプを特定するための名称を指定する。例えば,オブジェクトタイプが「JOB」の場合はジョブ名称などを指定する。 ROOT_OBJECT_TYPE 登録名タイプ 登録名タイプ。オブジェクトタイプの親オブジェクトのタイプを指定する。これは,オブジェクトが階層を持つ場合などに有効である。例えば,オブジェクトタイプが「JOB」の場合,ルートオブジェクトタイプは「JOBNET」となる。ルートオブジェクトタイプが存在しない場合は,オブジェクトタイプと同じ種別を指定すること。デフォルトでは,オブジェクトタイプと同じ値が定義されている。 ROOT_OBJECT_NAME 登録名 登録名。ルートオブジェクトタイプを特定するための名称を指定する。例えば,ジョブネット名称などを指定する。 OBJECT_ID オブジェクトID オブジェクトID。
PRODUCT_NAMEとの組み合わせによってオブジェクトのインスタンスを統合システム内で一意に意識できる文字列(形式は他製品に依存する。この情報はJP1/IMの[統合機能メニュー]画面から各製品のモニターを呼び出すときに使用する)。OCCURRENCE 事象種別 特定のオブジェクトについて,イベントの発行契機となる事象を設定する。デフォルトでは次のものがある。基本的には,オブジェクトタイプとこの事象種別によってフィルター設定などをすることで,特定のオブジェクトの特定の事象を選択できるようになる。
ACTIVE:アクティブになった
INACTIVE:非アクティブになった
START:開始した
END:終了した
NOTSTART:開始できなかった
CANCEL:キャンセルされた
LATESTART:開始予定時刻を過ぎた
LATEEND:終了予定時刻を過ぎた
SUBMIT:サブミットされた
UNSUBMIT:サブミットが取り消された
ENQUEUE:キューに登録された
DEQUEUE:キューから削除された
PAUSE:一時停止(保留)
RELEASE:一時停止の解除(保留解除)
RESTART:再実行を開始した
CREATE:作成された
DELETE:削除された
MODIFY:更新された
RETRY:リトライを開始した
STOP:停止中
MOVE:移動した
COPY:コピーした
NOTICE:通知した(オペレーターなどへの通知結果)
REPLY:応答された
CONNECT:接続した
DISCONNECT:切り離した
EXCEPTION:そのほかのエラーが発生したSTART_TIME 開始時刻 実行開始または再実行開始の時刻。UTC 1970年1月1日 00:00:00からの秒数で指定する。事象種別がSTART,RESTART,PAUSE,RELEASE,またはENDの場合だけに指定する。 END_TIME 終了時刻 実行終了の時刻。UTC 1970年1月1日 00:00:00からの秒数で指定する。事象種別がENDの場合だけに指定する。 RESULT_CODE 終了コード 10進数文字列の終了コード。事象種別がENDの場合だけに指定する。 PLATFORM※ − イベント拡張属性定義ファイル,モニター画面呼び出し定義ファイルなどでプラットフォーム種別として指定する任意の文字列を指定する。省略した場合は,「base」が指定されたものとして扱われる。 ACTION_VERSION※ − モニター画面呼び出しのときのバージョン情報として使用する。複数バージョンが混在していて,それぞれの場合に呼び出す画面などが異なる場合に必要である。指定しない場合は,モニター画面呼び出し定義でバージョン指定を使用しないこと。
- 注※
- これらの属性はJP1/IMのイベント詳細情報には表示されません。ただし,JP1/IMでイベント拡張属性定義ファイルに定義した場合はJP1/IMのイベント詳細情報に表示されます。
- 「重大度」の意味
- 拡張属性の共通情報「重大度」の意味を次の表に示します。独自イベントの「重大度」を設定するときには,ここに示す基準を指針としてください。なお,発行時に「重大度」が指定されていないイベントは,JP1/IMの[イベントコンソール]画面に表示されません。
表A-3 重大度の意味
重大度 表示名称 意味 Emergency 緊急 パニック状態。通常すべてのユーザーにブロードキャストするもの Alert 警戒 システムやデータベースの破壊など,直ちに修復が必要な状態 Critical 致命的 ハードデバイスのエラーなどの危険な状態 Error エラー エラー Warning 警告 警告メッセージ Notice 通知 エラー状態ではないが,特別な扱いが必要な状態 Information 情報 通知メッセージ Debug デバッグ 通常,プログラムのデバッグ時だけに使用する情報を含むメッセージ。メッセージ量の問題が発生するので,JP1イベント発行の対象としない
(2) 固有情報
共通情報のほかに,JP1イベントに付加して利用価値のある情報をプログラムごとに固有情報として設定します。拡張属性の固有情報を設定した場合は,JP1/IMでイベント拡張属性定義ファイルに定義する必要があります。
固有情報を設定するときの規則を次に示します。
- 属性名は意味のない記号名でもよい。
- 属性名と意味は,同じ「PRODUCT_NAME」の拡張属性を持つ各プログラムで1対1で対応するようにする。
All Rights Reserved. Copyright (C) 2009, 2011, Hitachi, Ltd.