Hitachi

JP1 Version 12　JP1/Integrated Management 2 - Manager コマンド・定義ファイル・APIリファレンス

イベントガイド情報ファイル（jco_guide.txt）

〈このページの構成〉

形式

DESC_VERSION=ファイルバージョン
 
[EV_GUIDE_イベントガイド番号]
EV_USER=JP1ユーザー名
EV_COMP=属性名:属性値
EV_GUIDE=イベントガイドメッセージ
[END]
[EV_GUIDE_イベントガイド番号]
EV_COMP=属性名:属性値
EV_COMP=属性名:属性値
EV_FILE=イベントガイドメッセージファイル名
[END]
   :

ページの先頭へ

ファイル

sample_jco_guide_ja.txt（イベントガイド情報ファイルのサンプルファイル（日本語））

sample_jco_guide_en.txt（イベントガイド情報ファイルのサンプルファイル（英語））

sample_jco_guide_ja.txt.model（イベントガイド情報サンプルのモデルファイル（日本語））

sample_jco_guide_en.txt.model（イベントガイド情報サンプルのモデルファイル（英語））

ページの先頭へ

格納先ディレクトリ

Windowsの場合
物理ホストのとき

Consoleパス\conf\guide\

論理ホストのとき

共有フォルダ\jp1cons\conf\guide\

UNIXの場合
物理ホストのとき

/etc/opt/jp1cons/conf/guide/

論理ホストのとき

共有ディレクトリ/jp1cons/conf/guide/

ページの先頭へ

説明

JP1イベントに対して，イベントガイド情報を定義するファイルです。このファイルで記述した内容は，JP1/IM - Viewおよび統合オペレーション・ビューアーの［イベント詳細］画面に表示されます。

イベントガイド情報ファイルの最大サイズは，1メガバイトです。また，イベントガイド情報ファイルの最大件数は，1,000件です。

イベントガイド情報ファイルは，JP1/IM - Managerの動作する言語コードで記述してください。

なお，イベントガイド情報ファイルは，jco_guide.txtというファイル名で作成する必要があります。JP1/IM - Managerの動作する言語コードに合わせてsample_jco_guide_ja.txtまたはsample_jco_guide_en.txtをコピーし，ファイル名をjco_guide.txtに変更してから使用するようにしてください。また，格納先のディレクトリは，サンプルファイルと同じディレクトリにしてください。EV_FILEパラメーターで指定するファイル（イベントガイドメッセージファイル）と異なり，ファイル名は任意ではないため，注意してください。

発行されたJP1イベントに対して，複数のイベントガイド情報が一致する場合，イベントガイド情報ファイルで先に記述してある方が有効になります。

#を指定した場合，#以降は改行されるまでコメント扱いとなります。ただし，開始タグ，属性情報，終了タグの後方にコメントを記述できません。開始タグと終了タグの後方にコメントを記述した場合は，エラーとなります。また，属性値の後方にコメントを書いた場合は，属性値の一部として認識されます。

\を記述する場合，\\と記述する必要があります。\nおよび\$以外に\を記述していた場合はログが出力され，\を記述した行を無視して処理します。

イベントガイド情報ファイル，イベントガイドメッセージファイルに記述されているHTMLの構文チェックはしません。

ページの先頭へ

定義の反映時期

イベントガイド情報ファイルを編集後，JP1/IM - Managerを再起動するか，jco_spmd_reloadコマンドを実行したときから有効になります。なお，JP1/IM - Viewおよび統合オペレーション・ビューアーでのログイン時，［イベント詳細］画面にイベントガイド情報の表示領域がない場合，定義を有効にしたあと再ログインすることで，表示領域が表示されます。

イベントガイドメッセージファイルを編集した場合は，［イベント詳細］画面を表示し直すことで，編集内容が更新されます。

ページの先頭へ

記述内容

DESC_VERSION=ファイルバージョン

イベントガイド情報ファイルの形式のバージョンを表しています。1または2を指定できます。2を指定すると，EV_USERパラメーターを指定できます。

[EV_GUIDE_イベントガイド番号]

イベントガイド情報の開始タグです。[EV_GUIDE_イベントガイド番号]〜[END]で一つの定義ブロックとなります。このパラメーターと[END]の間に［イベント詳細］画面への表示対象となるJP1イベントの比較条件および表示するメッセージを記述します。イベントガイド番号は，1〜9999の数字を10進数で指定します。

複数の定義ブロックがある場合でも順序性を持たせる必要はありませんが，同一のイベントガイド番号を指定するとエラーになり，定義ブロックが無効になります。なお，[EV_GUIDE_1]と[EV_GUIDE_0001]は異なります。

EV_GUIDE_イベントガイド番号タグ内の文字列は一意にしてください。不正な文字列がある場合はログが出力され，該当個所を無視して処理します。

EV_GUIDE_イベントガイド番号タグ内に記述できる属性以外が記述されている場合は，該当個所を無視して処理します。

EV_USER=JP1ユーザー名

イベントガイドメッセージの表示対象となるJP1ユーザー名を指定します。指定できる文字数は，1〜31バイトです。半角英数字だけを使用できます。英字は大文字・小文字を区別しません。このパラメーターを指定する場合は，DESC_VERSIONに2を指定してください。このパラメーターは，複数指定できません。また，このパラメーターを省略した場合は，すべてのJP1ユーザーを対象ユーザーと仮定し動作します。

JP1/IM - Managerのバージョンが09-50以降の場合に指定できます。JP1ユーザー名とJP1ユーザー名は，一つ以上の空白で区切り，最大100個指定できます。

（例）

EV_USER=jp1user1 jp1user2 jp1user3

EV_COMP=属性名:属性値

このパラメーターは，JP1イベントを比較する属性の数だけ記述します。複数記述した場合は，AND条件になります。例えば，EV_COMPパラメーターを二つ以上指定した場合，すべての条件が成立したときにだけ，イベントガイドメッセージを［イベント詳細］画面に表示します。

EV_COMPパラメーターの属性名にイベントIDを指定する場合には，B.IDとB.IDBASEのどちらかを指定できます。B.IDの場合は属性値を基本部:拡張部の16桁で，B.IDBASEの場合は基本部8桁で記述します。

（例）

  • EV_COMP=B.ID:00004107:00000000

  • EV_COMP=B.IDBASE:00004107

なお，EV_COMPに指定できる条件は100件までです。EV_COMPを二つ以上指定する場合の例については，以降の定義例を参照してください。

また，発行元イベントサーバ名（B.SOURCESERVER），送信先イベントサーバ名（B.DESTSERVER），発生元ホスト名（E.JP1_SOURCEHOST）には業務グループ名を使用できません。業務グループ名を指定した場合，ホスト名として扱われます。

属性名

次の属性を指定できます。

・JP1イベントの基本属性：指定する場合「B.属性名」と指定します。

・JP1イベントの拡張属性：指定する場合「E.属性名」と指定します。

なお，登録要因（B.REASON），コードセット（B.CODESET）は指定できません。

属性名に登録時刻（B.TIME）または到着時刻（B.ARRIVEDTIME）を指定した場合はUTC 1970年1月1日00:00:00からの通算ミリ秒で比較を行います。

（例）到着時刻が2013/6/12 10:20:00.000（通算ミリ秒表記で1371000000000）のJP1イベントを指定する場合

EV_COMP=B.TIME:1371000000000

属性値

属性名で指定した属性の内容を正規表現で記述します。正規表現には拡張正規表現を使用します。正規表現の詳細については，マニュアル「JP1/Integrated Management 2 - Manager 導入・設計ガイド」の「付録G　正規表現」を参照してください。

デフォルトでは，指定した正規表現とJP1イベントの属性値全体を比較し，完全に一致した場合だけ条件が成立します。

部分一致にしたいときは，次の共通定義情報を定義した任意のファイルを引数にjbssetcnfコマンドを実行したあと，定義を有効にするため，JP1/IM - Managerを再起動してください。定義ファイル作成時にはファイルの終端が最下行の先頭になるようにしてください。

・物理ホストの場合

[JP1_DEFAULT\JP1CONSOLEMANAGER]

"GUIDE_EV_COMP"="find"

・論理ホストの場合

[論理ホスト名\JP1CONSOLEMANAGER]

"GUIDE_EV_COMP"="find"

定義内容を完全一致（デフォルト）に戻す場合は，共通定義情報"GUIDE_EV_COMP"の値に"match"を指定してください。

共通定義情報の設定がない場合や，値が不正な場合は"match"を仮定し完全一致で動作します。

なお，この共通定義情報はインストール直後の状態では設定されていません。

発行元IPアドレス（B.SOURCEIPADDR）および送信先IPアドレス（B.DESTIPADDR）にIPv6アドレスを指定する場合，次のように英字部分を英小文字で指定してください。

0011:2233:4455:6677:8899:aabb:ccdd:eeff

また，次のようなIPアドレスの省略形式は指定できません。

2012:7:8::a:b

登録時刻（B.TIME），または到着時刻（B.ARRIVEDTIME）を指定する場合は，UTC 1970-01-01 00:00:00からの秒数をミリ秒で指定してください。

EV_GUIDE=イベントガイドメッセージ

イベントガイドメッセージには，イベントガイドとして表示したい文字列を1行で記述します。指定した文字列は，［イベント詳細］画面のイベントガイド情報が表示される領域（［メッセージ］の下の［ガイド］）に表示されます。

なお，このパラメーターは，[EV_GUIDE_イベントガイド番号]と[END]の間に一つしか記述できません。

EV_GUIDE=イベントガイドメッセージとEV_FILE=イベントガイドメッセージファイル名を同時に指定した場合，EV_FILE=イベントガイドメッセージファイル名の記述が優先されます。

メッセージ中に\を記述する場合は\\，$を記述する場合は\$と記述します。メッセージに改行を入れる場合は，\nと記述します。

また，イベントガイドメッセージでは，HTMLタグを使ったり，JP1イベントの属性を変数として記述したりすることもできます。

  • HTMLタグの記述

    HTMLタグを記述すれば，［イベント詳細］画面に表示されるイベントガイドメッセージをHTML形式で表示できます（記述できるHTMLタグはEV_FILEの説明文にある「表2-27　イベントガイドメッセージとして使用できるHTMLタグ」を参照のこと）。

  • JP1イベントの属性を変数として記述

    メッセージ中に「$B.属性名△」，「$E.属性名△」を指定した場合，JP1イベントの属性名に対応する属性値がメッセージとして展開されます（△は半角スペースを表す）。ただし，登録要因（B.REASON），コードセット（B.CODESET）は指定できません。また，対応する属性が存在しない場合は空に置き換えられます。

    メッセージ中に指定できる属性名を，次表に一覧で示します。なお，JP1イベントの属性の詳細については，「3.1　JP1イベントの属性」を参照してください。

    表2‒24　メッセージ中に指定できる属性名の一覧

    JP1イベントの属性

    メッセージ中の記述

    基本属性

    イベントDB内通し番号

    B.SEQNO

    イベントID

    次の2とおり

    1. B.ID

    2. B.IDBASE

    発行元プロセスID

    B.PROCESSID

    登録時刻

    B.TIME

    到着時刻

    B.ARRIVEDTIME

    発行元ユーザーID

    B.USERID

    発行元グループID

    B.GROUPID

    発行元ユーザー名

    B.USERNAME

    発行元グループ名

    B.GROUPNAME

    発行元イベントサーバ名

    B.SOURCESERVER

    送信先イベントサーバ名

    B.DESTSERVER

    発行元イベントDB内通し番号

    B.SOURCESEQNO

    メッセージ

    B.MESSAGE

    拡張属性

    重大度

    E.SEVERITY

    ユーザー名

    E.USER_NAME

    プロダクト名

    E.PRODUCT_NAME

    オブジェクトタイプ

    E.OBJECT_TYPE

    オブジェクト名

    E.OBJECT_NAME

    登録名タイプ

    E.ROOT_OBJECT_TYPE

    登録名

    E.ROOT_OBJECT_NAME

    オブジェクトID

    E.OBJECT_ID

    事象種別

    E.OCCURRENCE

    開始時刻

    E.START_TIME

    終了時刻

    E.END_TIME

    終了コード

    E.RESULT_CODE

    発生元ホスト名

    E.JP1_SOURCEHOST

    上記以外の拡張属性

    E.xxxxxx※
    注※

    各JP1製品固有の拡張属性も使用できます。例えば，JP1/AJSのジョブの実行ホストは，E.C0です。製品固有の拡張属性についての詳細は，JP1イベントを発行する各製品のマニュアルを参照してください。

    イベントガイドメッセージに記述する文字数は196,608文字以内にしてください。196,608文字よりも長く記述した場合，196,609文字以降のメッセージは，［イベント詳細］画面に表示されません。

    なお，イベントガイドメッセージは，次の表に示す置き換え文字を指定することで，連携製品のWWWページなどを文字化けすることなく表示できます。

    表2‒25　指定できる置き換え文字

    指定形式

    説明

    $B.属性名△

    $E.属性名△

    属性値をそのまま展開する。

    ガイド情報の形式がHTML形式の場合は，HTMLエンコードを行う。

    JP1イベントの属性値をイベントガイドメッセージで表示する文章の一部として表示する場合に指定する。

    （例）$B.MESSAGE△

    $B.属性名$URLENC△

    $E.属性名$URLENC△

    属性値をUTF-8の文字列としてURLエンコードして展開する。

    WWWページアプリケーションの引数（URLパラメーター）としてJP1イベントの属性値をUTF-8の文字列として渡す場合に使用する。

    （例）<a href="http://host/page?msg=$B.MESSAGE$URLENC△">

    $B.属性名$ENC△

    $E.属性名$ENC△

    属性値をUTF-8の文字列としてBase64でエンコードして展開する。

    JP1イベントの属性値をUTF-8の文字列としてBase64でエンコードした値をイベントガイドメッセージで表示する文章の一部として表示する場合に指定する。

    ただし，WWWページアプリケーションの引数（URLパラメーター）として渡す場合は，「$B.属性名$ENC$URLENC△，$E.属性名$ENC$URLENC△」の変数を使用する。

    （例）$B.MESSAGE$ENC△

    $B.属性名$ENC$URLENC△

    $E.属性名$ENC$URLENC△

    属性値をUTF-8の文字列としてBase64でエンコード後，さらにURLエンコードして展開する。

    WWWページアプリケーションの引数（URLパラメーター）としてJP1イベントの属性値のBase64値を渡す場合に使用する。

    （例）<a href="http://host/page?msg=$B.MESSAGE$ENC$URLENC△">
    注

    $URLENC，または$ENCを指定する場合は，DESC_VERSIONの値に2を指定する必要があります。

EV_FILE=イベントガイドメッセージファイル名

イベントガイドメッセージファイル名には，［イベント詳細］画面に表示されるイベントガイドメッセージの内容を記述したファイルの名称をフルパスで指定します。このパラメーターは，[EV_GUIDE_イベントガイド番号]と[END]の間に一つしか記述できません。なお，イベントガイドメッセージファイル名に何も記述していない場合，次のファイル名を指定したと見なされます。

表2‒26　イベントガイドメッセージファイル名

OS

イベントガイドメッセージファイル名

Windows

Consoleパス\conf\guide\EV_GUIDE_イベントガイド番号.txt

共有フォルダ\jp1cons\conf\guide\EV_GUIDE_イベントガイド番号.txt

UNIX

/etc/opt/jp1cons/conf/guide/EV_GUIDE_イベントガイド番号.txt

共有ディレクトリ/jp1cons/conf/guide/EV_GUIDE_イベントガイド番号.txt

ファイル名は，パスを含めて1,024文字以内にしてください。1,024文字を超えた場合，JP1/IM - Managerの起動時またはJP1/IM - Viewおよび統合オペレーション・ビューアーからのイベントガイドメッセージファイル呼び出し時にエラーとなります。

ガイドメッセージファイルとして指定できるファイルの名称，拡張子はユーザー任意です。ファイル名称には管理しやすい名称を，拡張子は表示するイベントガイドメッセージがTXT形式であれば.txtを，HTML形式であれば.html，.htmを使用することをお勧めします。

（例）jco_guidemes001_AJS2.txt，またはjco_guidemes001_AJS2.htm

イベントガイドメッセージファイル

イベントガイドメッセージファイルには，［イベント詳細］画面から表示させたい情報をTXT形式またはHTML形式で記述します。記述できる内容は，イベントガイド情報ファイルのEV_GUIDEで記述できる内容と同じです。つまり，HTMLタグを使用したり，JP1イベントの属性を変数として記述したりできます。メッセージ中に\を記述する場合は\\，$を記述する場合は\$と記述します。メッセージに改行を入れる場合は，\nと記述します。

なお，1行でメッセージを記載するEV_GUIDEと違い，イベントガイドメッセージファイルの場合，改行を挿入して体裁を整えることができます。

作成したイベントガイドメッセージファイルは，任意のフォルダに格納できます。

イベントガイドメッセージファイルの最大サイズは，1メガバイトです。1メガバイトを超えた場合，JP1/IM - Viewおよび統合オペレーション・ビューアーの［イベント詳細］画面からのイベントガイドメッセージファイル読み込み時にエラーとなります。

HTML形式のイベントガイドメッセージファイルを作成する場合に使用できるHTMLタグおよび属性を次に示します。なお，このほかのHTMLタグについては動作保証していません。

表2‒27　イベントガイドメッセージとして使用できるHTMLタグ

タグ

属性

説明

HTML

−

HTML文章であることを宣言します。このタグは必須です。

HEAD

−

HTML文章のヘッダーを宣言します。

このタグは必須です。

BODY

−

HTML文章の本文を宣言します。

このタグは必須です。

A※1

HREF="URL"

リンク先URLを指定します。※2，※3「http://」，または「https://」で始まるURLが指定できます。

それ以外は動作保証されません。

ここで指定したリンクは［イベント詳細］画面（HTML形式）に表示されます。クリックするとWWWブラウザーが起動し，指定したURLにアクセスできます。エンコードできる文字数は2,083文字までです。

TARGET※5

HREFで指定したURLが示すページの表示先ウィンドウの名前を指定します。

［統合オペレーション・ビューアー］画面を表示しているWWWブラウザーの同一セッションの範囲に，同名の表示先ウィンドウがある場合は，そのウィンドウを表示先とします。

表示先ウィンドウが無い場合は，新しくウィンドウを開いて表示先とします。

次の文字を指定できます。

  • 半角英大文字，半角英小文字

  • 半角数字

  • 空白

  • 記号（!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~）

なお，半角数字，空白，記号は先頭の文字には指定できません。ただし，_blankを指定する場合は，先頭の文字に「_」を指定できます。

次の名前は，使用できません。大文字・小文字は区別しません。

  • _parent

  • _self

  • _top

  • JP1IM_で始まる名前

  • target=""のような長さ0の名前

H1，H2，H3，H4，H5，H6

−

見出しを指定します。

FONT

SIZE="文字サイズ"

文字サイズを指定します。指定できる値は1〜7です。

COLOR="文字色"

文字色を指定します。指定できる色は次の16色です。

black，silver，gray，white，maroon，red，purple，fuchsia，green，lime，olive，yellow，navy，blue，teal，aqua

これ以外の文字色は動作保証されません。

B

−

文字を太字にします。

I※4

−

文字を斜体にします。

HR

−

けい線を引きます。

BR

−

強制的に改行します。

（凡例）　−：なし

注※1　AタグのURLの解釈および表示される画面は，WWWブラウザーなどの環境に依存します。

注※2　JP1/Navigation Platformと連携する場合のURLを次に記述します。

【記述例】

http://hostA:8080/ucnpBase/portal/screen/Home/action/PLoginUser?contentId=f24077e7-0136-1000-8000-00000ad20b6f-0

JP1/Navigation Platformとの連携については，JP1/Navigation PlatformのマニュアルのJP1製品からナビゲーションプラットフォームを呼び出すためのURLについて説明されている個所を参照してください。

注※3　JP1/AJSと連携する場合のURLについては，JP1/AJSのマニュアルを参照してください。

注※4　［統合オペレーション・ビューアー］画面の場合，日本語にIタグを指定しても斜体になりません。

注※5　［統合オペレーション・ビューアー］画面の場合にだけ，使用できる属性です。

[END]

イベントガイド情報の終了タグです。小文字，大文字の区別はしません。

ページの先頭へ

定義例

# JP1/IM-CC Guide Information File.
 
DESC_VERSION=1
[EV_GUIDE_001]
EV_COMP=B.ID:00004107:00000000
EV_COMP=E.SEVERITY:Error
EV_GUIDE=ジョブが異常終了しました。\n$E.C0 のホストで異常が発生していないか確認してください。
[END]

ページの先頭へ

Copyright (C) 2019, 2021, Hitachi, Ltd.

Copyright (C) 2019, 2021, Hitachi Solutions, Ltd.