2.4 メール通知定義ファイル(mailDefinition_ja.conf,mailDefinition_en.conf,mailDefinition_zh.conf)
タスクが異常検出または失敗の状態になった場合に,メールで通知するための定義ファイルです。
日本語環境の場合はmailDefinition_ja.conf,英語環境の場合はmailDefinition_en.conf,中国語環境の場合はmailDefinition_zh.confを編集します。
形式
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <mail xmlns="http://www.hitachi.com/products/it/software/xml/automation/conf/mailDefinition"> <title>メールタイトル</title> <body>メール本文</body> </mail>
格納先フォルダ
- 非クラスタシステムの場合
JP1/AOのインストール先フォルダ\confまたは/opt/jp1ao/conf
- クラスタシステムの場合
共有フォルダ名\jp1ao\confまたは共有フォルダ名/jp1ao/conf
定義の反映契機
JP1/AOの再起動
記述内容
メール通知定義ファイルをXML形式で編集します。編集する個所は「メールタイトル」と「メール本文」の部分です。
記述するときは次の点に注意してください。
メール通知定義ファイルがない場合や,XMLとして形式が誤っている場合は読み込みエラーとなります。この場合,デフォルトのタイトルと本文でメールが送信されます。
XMLとして正しい形式で<mail><title><body>以外のタグを指定しても,その要素は無視されます。
<title>や<body>のタグを省略した場合は,それぞれ空文字が指定されます。
<mail>タグは省略できません。省略した場合,形式不正で読み込みエラーとなります。
タグの大文字と小文字は区別されます。
設定項目
設定項目 |
XMLエレメント |
文字列長 |
---|---|---|
メール通知で使用するメールのタイトル |
title |
0~9,999バイトの文字列 |
メール通知で使用するメールの本文 |
body |
設定項目 |
メール通知で使用するメールのタイトルのデフォルト値 |
メール通知で使用するメールの本文のデフォルト値 |
---|---|---|
日本語環境用 |
||
英語環境用 |
[Automatic Operation]$TASK_NAME$ has changed to $TASK_STATUS$ |
Service Group Name:$SERVICE_GROUP_NAME$ Task Name:$TASK_NAME$ User Name:$USER_NAME$ Task Detail:$TASK_DETAIL_URL$ |
中国語環境用 |
メールタイトルおよびメール本文に,XMLの文法上使用できない文字を使用したい場合は,XMLの実体参照を使用します。
使用したい文字 |
置き換えて使用する文字 |
---|---|
& |
& |
< |
< |
> |
> |
" |
" |
' |
' |
メールタイトルおよびメール本文には,次の埋め込み文字を使用できます。
埋め込み文字 |
項目 |
備考 |
---|---|---|
$SERVICE_GROUP_NAME$ |
サービスグループ名 |
サービスグループ名を表す文字列が設定される。 |
$TASK_NAME$ |
タスク名 |
タスクのプロパティの形式に従って設定される。 |
$TASK_ID$ |
タスクID |
|
$TASK_KIND$ |
タスク種別 |
|
$SERVICE_NAME$ |
サービス名 |
|
$TASK_TAGS$ |
タスクのタグ |
|
$TASK_STATUS$ |
タスクの状態 |
|
$EXECUTION_DATE$ |
実行操作日時 |
|
$PLANNED_ START_DATE$ |
開始予定日時 |
|
$START_DATE$ |
開始日時 |
|
$END_DATE$ |
終了日時 |
|
$SCHEDULE_PERIOD$ |
定期実行周期 |
|
$SCHEDULE_TIME$ |
定期実行時刻 |
|
$SCHEDULE_ START_DATE$ |
定期実行適用開始日 |
|
$USER_NAME$ |
実行者 |
|
$TASK_DETAIL_URL$ |
[タスク詳細]画面のURL |
httpまたはhttpsから始まるURLが設定される。 |
該当するタスクの状態によって,プロパティの値が空となる場合があります。この場合,埋め込み文字が取得する値は空白になります。
定義例
- タスクの状態が変更された場合に,サービスグループ名,タスク名,実行者,およびタスク詳細を通知する例
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <mail xmlns="http://www.hitachi.com/products/it/software/xml/automation/conf/mailDefinition"> <title>[Automatic Operation]$TASK_NAME$が$TASK_STATUS$に変更されました。</title> <body> サービスグループ名:$SERVICE_GROUP_NAME$ タスク名:$TASK_NAME$ 実行者:$USER_NAME$ タスク詳細:$TASK_DETAIL_URL$ </body> </mail>