2.4 Email notification definition files (mailDefinition_ja.conf, mailDefinition_en.conf, mailDefinition_zh.conf)
These are the definition files used for email notification in the event of a failure or if an abnormality is detected in a task.
Edit mailDefinition_ja.conf in a Japanese environment, mailDefinition_en.conf in an English environment, and mailDefinition_zh.conf in a Chinese environment.
Format
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <mail xmlns="http://www.hitachi.com/products/it/software/xml/automation/conf/mailDefinition"> <title>email-title</title> <body>email-body</body> </mail>
Installation folder
- For non-cluster systems:
-
JP1/AO-installation-folder\conf
- For cluster systems:
-
shared-folder-name\jp1ao\conf
Trigger for applying definitions
Starting JP1/AO
Description
The email notification definition file is edited in XML format. The locations you can edit are email-title and email-body.
When editing the file, note the following points.
-
A read error occurs if the email notification definition file is missing, or is not well-formed XML. In this case, the email is sent with the default title and body.
-
If you specify tags other than <mail>, <title>, and <body>, even if the tags are well-formed XML, the tags and their content are ignored.
-
An empty string will be specified for the value of a <title> or <body> tag that is omitted.
-
The <mail> tag cannot be omitted. If it is omitted, the format is invalid and a read error occurs.
-
The tag entries are case sensitive.
Settings
|
Settings |
XML element |
Character string length |
|---|---|---|
|
Title of email to be used in email notifications |
title |
Character string of 0-9,999 bytes |
|
Body of email to be used in email notifications |
body |
|
Settings for: |
Default title of email to be used in email notifications |
Default body of email to be used in email notifications |
|---|---|---|
|
Japanese environment |
|
|
|
English environment |
[Automatic Operation]$TASK_NAME$ has changed to $TASK_STATUS$ |
Resource Group Name:$ RESOURCE_GROUP_NAME$ Task Name:$TASK_NAME$ User Name:$USER_NAME$ Task Detail:$TASK_DETAIL_URL$ |
|
Chinese environment |
|
|
![[Figure]](GRAPHICS/KG020420.GIF)
![[Figure]](GRAPHICS/KG020430.GIF)
![[Figure]](GRAPHICS/KG020400.GIF)
![[Figure]](GRAPHICS/KG020410.GIF)
If you want to use characters that are not valid in XML syntax in the title or body of the email, use XML entity references.
|
Character you want in the email |
Character string to be entered |
|---|---|
|
& |
& |
|
< |
< |
|
> |
> |
|
" |
" |
|
' |
' |
The following embedded characters can be used in the title or body of the email.
|
Embedded characters |
Item |
Remarks |
|---|---|---|
|
$RESOURCE_ GROUP_NAME$ |
Resource group name |
Set to the character string representing the resource group name. |
|
$TASK_NAME$ |
Task name |
Set according to the format in the task properties. |
|
$TASK_ID$ |
Task ID |
|
|
$TASK_KIND$ |
Task type |
|
|
$SERVICE_NAME$ |
Service name |
|
|
$SERVICE_CATEGORY$ |
Service category |
|
|
$TASK_STATUS$ |
Task status |
|
|
$EXECUTION_DATE$ |
Date and time the operation was executed |
|
|
$PLANNED_ START_DATE$ |
Planned date and time of start |
|
|
$START_DATE$ |
Actual date and time of start |
|
|
$END_DATE$ |
Date and time of end |
|
|
$SCHEDULE_PERIOD$ |
Scheduled execution period |
|
|
$SCHEDULE_TIME$ |
Scheduled execution time |
|
|
$SCHEDULE_ START_DATE$ |
Date execution was scheduled to start |
|
|
$USER_NAME$ |
User who executes the operation |
|
|
$TASK_DETAIL_URL$ |
URL of the Task Details window |
Set to a URL starting with http or https. |
Depending on the state of the relevant task, the values of some properties might be empty. In these cases, the embedded characters will be blank values.
Example definitions
- Example notification that the status of a task has changed, giving the resource group name, task name, user, and task details
<?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$ has changed to $TASK_STATUS$</title> <body> Resource Group Name:$RESOURCE_GROUP_NAME$ Task Name:$TASK_NAME$ User Name:$USER_NAME$ Task Detail:$TASK_DETAIL_URL$ </body> </mail>
Related topics