イベント拡張属性定義ファイル（拡張ファイル）

〈このページの構成〉

形式
ファイル
格納先ディレクトリ
説明
作成契機
定義の反映時期
記述内容
記述内容（文字コードの指定）
記述内容（ファイル内ステートメントの生成規則）
記述内容（イベント拡張属性定義ファイルのブロックの生成規則）
記述内容（イベント拡張属性定義ブロック内のステートメント生成規則）
定義例

形式

[@encode 文字コード]
@file type="extended-attributes-definition", version="0300";
@define-block type="event-attr-def";
attr name="属性名", title="項目名";
・・・
@define-block-end;

ページの先頭へ

ファイル

template_extend_attr_ja.conf（日本語の拡張ファイル）

template_extend_attr_ja.conf.model（日本語の拡張ファイルのモデルファイル）

template_extend_attr_en.conf（英語の拡張ファイル）

template_extend_attr_en.conf.model（英語の拡張ファイルのモデルファイル）

template_extend_attr_zh.conf（中国語の拡張ファイル）

template_extend_attr_zh.conf.model（中国語の拡張ファイルのモデルファイル）

ページの先頭へ

格納先ディレクトリ

Windowsの場合

物理ホストのとき: Consoleパス\conf\console\attribute\extend
論理ホストのとき: 共有フォルダ\JP1Cons\conf\console\attribute\extend

UNIXの場合

物理ホストのとき: /etc/opt/jp1cons/conf/console/attribute/extend
論理ホストのとき: 共有ディレクトリ/jp1cons/conf/console/attribute/extend

ページの先頭へ

説明

イベント拡張属性定義ファイル（拡張ファイル）は，項目名でJP1/IM - Viewおよび統合オペレーション・ビューアーの画面に表示したり，項目名でイベントレポート出力したりする固有の拡張属性を定義します。

JP1/IM - Managerに同梱する定義ファイルは，ファイル名の先頭に「template_」が付いています。「extend_attr_ja.conf」のようにリネームしてから設定してください。

拡張ファイル以外のイベント拡張属性定義ファイルの詳細については，「イベント拡張属性定義ファイル」（2.　定義ファイル）を参照してください。

ページの先頭へ

作成契機

JP1/IM - Managerインストール時に作成します。

ページの先頭へ

定義の反映時期

次のどちらかが成立する場合に，イベント拡張属性定義ファイル（拡張ファイル）の記述内容を反映します。

JP1/IM - Managerを起動した場合
jco_spmd_reloadコマンドを実行した場合

なお，JP1/IM - Viewまたは統合オペレーション・ビューアーに接続中に定義を反映した場合は，JP1/IM - Viewまたは統合オペレーション・ビューアーの再起動が必要です。

ページの先頭へ

記述内容

イベント拡張属性定義ファイル（拡張ファイル）は，項目名で画面に表示したり，項目名でイベントレポート出力したりする固有の拡張属性を定義します。拡張ファイルはJP1/IM - Managerの定義ファイルで，JP1/IM - Managerの動作言語ごとに定義します。

複数の言語の拡張ファイルをJP1/IM - Managerに配置する場合は，すべての拡張ファイルに指定する属性名を一致させる必要があります。JP1/IM - Viewおよび統合オペレーション・ビューアーに表示する属性はシステム全体で一意に決まるため，JP1/IM - Viewおよび統合オペレーション・ビューアーの言語ごとに異なる属性は表示できません。

すべての拡張ファイルに指定した属性名に不一致がある場合は，jcoattrfcheckコマンドで拡張ファイルをチェックした際，KAVB5820-Wの警告メッセージを出力します。また，拡張ファイルに指定していない属性がJP1/IM - Viewまたは統合オペレーション・ビューアーに表示される場合があります。例えば，英語の拡張ファイルにだけ「E.SYSTEM」という属性名を指定している場合，日本語や中国語のJP1/IM - Viewにも「E.SYSTEM」が表示されます。このとき，日本語や中国語のJP1/IM - Viewに表示される「E.SYSTEM」の項目名は，属性名と同じ「E.SYSTEM」となります。

なお，JP1/IMには，イベント拡張属性定義ファイル（拡張ファイル）の記述内容をチェックするためのコマンド「jcoattrfcheck」が用意されています。このコマンドの詳細については，「jcoattrfcheck」（1.　コマンド）を参照してください。

イベント拡張属性定義ファイル（拡張ファイル）には，次のステートメントとブロックを記述できます。

表2‒26　イベント拡張属性定義ファイル（拡張ファイル）に記述できるステートメントおよびブロック
ステートメントまたはブロック	意味
@encodeステートメント	定義ファイルで使用している文字コードを指定する
@fileステートメント	定義ファイルタイプおよびバージョンを宣言する
イベント拡張属性定義ブロック	イベント属性の表示について定義する

表に示したステートメントおよびブロック以外を記述した場合は，記述内容は無視されます。また，イベント拡張属性定義ファイル（拡張ファイル）の記述に誤りがある場合は，誤りのある行を無視して有効な行だけで動作します。ただし，blockステートメント（block lang="";）のように，拡張ファイル以外のイベント拡張属性定義ファイルでは読み込むが，イベント拡張属性定義ファイル（拡張ファイル）では読み込まない定義の記述があり，それが不正だった場合はエラーとなります。拡張ファイル以外のイベント拡張属性定義ファイルの詳細については，「イベント拡張属性定義ファイル」（2.　定義ファイル）を参照してください。

ページの先頭へ

記述内容（文字コードの指定）

@encode

イベント拡張属性定義ファイル（拡張ファイル）で使用する文字コードを指定します。

項目名には，@encodeステートメントに指定した文字コードで表現できる文字を記載します。また，イベント拡張属性定義ファイル（拡張ファイル）は，@encodeステートメントに指定した文字コードで保存します。

次の場合，JP1/IM - Viewおよび統合オペレーション・ビューアーに表示される項目名が文字化けすることがあります。

項目名に，@encodeステートメントに指定した文字コードで表現できない文字を使用した場合
@encodeステートメントに指定した文字コード，ファイルを保存した文字コード，および@encodeステートメントに指定した文字コードが不一致の場合

@encodeステートメントがない場合，および@encodeステートメントのあとに指定した文字コードに誤りがある場合は，文字コードが自動判別されます。ただし，定義ファイルの内容によっては正しく判別できないおそれがあります。

指定できる文字コードは次のとおりです。

表2‒27　指定できる定義ファイルの文字コード
項番	ファイルの文字コード	指定可否
項番	ファイルの文字コード	Linux以外	Linux
1	C	○	○
2	EUCJIS	○	×
3	SJIS	○	○^※
4	UTF-8	○	○
5	GB18030	○	○

（凡例）

○：指定できる

×：指定できない

注※

SUSE Linuxの場合だけ指定できます。

注意事項: 定義ファイルをUTF-8で保存する場合は，BOM（byte order mark）が付与されないように保存してください。

次の場合，エラーが出力されます。

C，EUCJIS，SJIS，UTF-8，およびGB18030以外の文字コードを指定した場合
@encodeを定義ファイルの先頭以外に記述した場合
@encodeのあとに文字コードを指定しなかった場合

ページの先頭へ

記述内容（ファイル内ステートメントの生成規則）

@fileステートメント

この定義ファイルがイベント拡張属性定義ファイル（拡張ファイル）であること，および定義記述フォーマットのバージョンが0300であることを宣言します。このステートメントは必須です。

なお，このステートメントは，ファイルの先頭行に記述しなければなりません。記述しない場合，動作は保証できません。

構文: @file type="extended-attributes-definition", version="0300";

ページの先頭へ

記述内容（イベント拡張属性定義ファイルのブロックの生成規則）

イベント拡張属性定義ファイル（拡張ファイル）に記述できるブロックについて説明します。なお，それぞれのブロックに記述できるステートメント以外のステートメントを記述した場合は，エラー出力され，該当するステートメントだけが無視されます。

イベント拡張属性定義ブロック

イベント属性の属性名とその表示項目名を関連づけます。このブロックは，定義ファイル内に一つだけ記述できます。イベント拡張属性定義ブロックを複数記述した場合，エラーや警告は出力されず，二つ目以降のイベント拡張属性定義ブロックは無視されます。

記述できるステートメント種別

このブロックには，次のステートメントを記述できます。

・attrステートメント

ページの先頭へ

記述内容（イベント拡張属性定義ブロック内のステートメント生成規則）

attrステートメント

項目名で画面に表示したり，項目名でイベントレポート出力したりする固有の拡張属性の属性名と，属性名に対応する項目名を指定します。このステートメントはブロック内に100個まで指定できます。100個を超えるattrステートメントを指定した場合は，jcoattrfcheckコマンドでのチェック時にKAVB5803-Wのメッセージが出力されます。

構文

attr name=属性名, title=項目名;

name=属性名

拡張属性名を定義します。値の形式は次のとおりです。

"E.拡張属性名"

属性名は，先頭が英大文字で英大文字，数字，およびアンダーバー（_）から構成される32バイトまでの名称を指定できます。

32バイトを超える拡張属性名を指定した場合は，jcoattrfcheckコマンドでのチェック時やjcoevtreportコマンドの実行時にKAVB5803-Wのメッセージが出力されます。また，JP1/IM - Managerの起動時やjco_spmd_reloadコマンドの実行時にイベント拡張属性定義ファイル（拡張ファイル）を読み込んだ際，KAVB5822-Wのメッセージが出力されます。

指定できる属性は固有の拡張属性だけです。ただし，発生元ホスト名（E.JP1_SOURCEHOST）や監視名（E.JP1_TRAP_NAME）など，イベント拡張属性定義ファイルの標準ファイル（default.conf）に指定した拡張属性と重複する属性は指定できません。イベント拡張属性定義ファイルの標準ファイル（default.conf）と重複する拡張属性を指定した場合は，標準ファイルに指定した項目名が適用されます。

なお，イベント拡張属性定義ファイルの標準ファイル（default.conf）と重複する拡張属性を指定した場合，jcoevtreportコマンドの実行時やjcoattrfcheckコマンドの実行時にイベント拡張属性定義ファイル（拡張ファイル）を読み込んだ際，KAVB5802-W^※のメッセージが出力されます。jcoevtreportコマンドは，イベント拡張属性定義ファイル（拡張ファイル）に指定された重複する属性を無視して動作します。また，JP1/IM - Managerの起動時やjco_spmd_reloadコマンドの実行時にイベント拡張属性定義ファイル（拡張ファイル）を読み込んだ際，KAVB5822-Wメッセージが出力されます。JP1/IM - Managerは，イベント拡張属性定義ファイル（拡張ファイル）に指定された重複する属性を無視して動作します。

基本属性（B.属性名）やIM属性（E.@属性名）など，拡張属性（E.属性名）以外を指定した場合は，jcoevtreportコマンドの実行時やjcoattrfcheckコマンドの実行時にイベント拡張属性定義ファイル（拡張ファイル）を読み込んだ際，KAVB5821-W^※のメッセージが出力されます。また，JP1/IM - Managerの起動時やjco_spmd_reloadコマンドの実行時にイベント拡張属性定義ファイル（拡張ファイル）を読み込んだ際，KAVB5822-Wメッセージが出力されます。

注※　KAVB5802-WまたはKAVB5821-Wのメッセージが出力されていても，jcoevtreportコマンドでレポート出力に成功した場合，およびjcoattrfcheckコマンドで定義ファイルのチェックが完了した場合は，各コマンドの戻り値は0（正常終了）になります。

複数の言語の拡張ファイルをJP1/IM - Managerに配置する場合は，すべてのイベント拡張属性定義ファイル（拡張ファイル）に指定する属性名を一致させる必要があります。すべてのイベント拡張属性定義ファイル（拡張ファイル）に指定した属性名に不一致がある場合は，jcoevtreportコマンドの実行時やjcoattrfcheckコマンドの実行時にイベント拡張属性定義ファイル（拡張ファイル）を読み込んだ際，KAVB5820-Wのメッセージが出力されます。また，JP1/IM - Managerの起動時やjco_spmd_reloadコマンドの実行時にイベント拡張属性定義ファイル（拡張ファイル）を読み込んだ際，KAVB5822-Wメッセージが出力されます。

title=項目名

固有の拡張属性の項目名を定義します。項目名には，@encodeステートメントで指定した文字コードで表現できる文字を使用します。@encodeステートメントで指定した文字コードで表現できない文字を使用した場合，JP1/IM - Viewおよび統合オペレーション・ビューアーに表示される項目名が文字化けします。

また，jcoevtreportコマンドで出力するレポートの文字コードで表現できない文字を使用した場合，CSVファイルに出力される項目名が文字化けします。

項目名で画面に表示したり，項目名でイベントレポート出力したりする固有の拡張属性の項目名を文字列で指定します。このパラメーターには，指定文字列に半角仮名および「,（コンマ）」は使用できません。半角仮名および「,（コンマ）」がある場合，正常に出力できません。

項目名の最大長は255バイトです。255バイトを超える項目名を指定した場合は，jcoattrfcheckコマンドでのチェック時やjcoevtreportコマンドの実行時にKAVB5803-Wのメッセージが出力されます。また，JP1/IM - Managerの起動時やjco_spmd_reloadコマンドの実行時にイベント拡張属性定義ファイル（拡張ファイル）を読み込んだ際，KAVB5822-Wのメッセージが出力されます。

注意事項

イベント拡張属性定義ファイルの標準ファイル（default.conf）とイベント拡張属性定義ファイル（拡張ファイル）で重複する固有の拡張属性を指定した場合，［イベントコンソール］画面のイベント一覧やイベントレポート出力で出力されるCSVのヘッダーには，イベント拡張属性定義ファイルの標準ファイル（default.conf）に指定した固有の拡張属性の項目名が表示または出力されます。

ページの先頭へ

定義例

イベント拡張属性定義ファイル（拡張ファイル）の定義例を次に示します。

@encode UTF-8
@file type="extended-attributes-definition", version="0300";
@define-block type="event-attr-def";
attr name="E.SYSTEM",    title="システム名";
attr name="E.ROLE",     title="サーバ用途";
@define-block-end;

ページの先頭へ