You configure email notification settings so that when a task fails ("Failed" status) or a task detects an error ("In Progress (with Error)" status), you receive email notification. You can configure the email address, title, and type of information you receive about the failure or problem.
Note: To ensure that email notifications are enabled for the system, you must configure the system parameters in the Administration tab. For more detailed information, see the Hitachi Ops Center Automator User Guide.
The email definition file, mailDefinition, is in XML format and is located in the following folder:
Automation-software-installation-folder\conf
The definition file uses the following format:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <mail xmlns="http://www.example.com/products/it/software/xml/automation/conf/mailDefinition"> <title>email-title</title> <body>email-body</body> </mail>
When editing the file, take note of the following:
- A read error occurs if the definition file for email notification 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 outside of <mail>, <title>, and <body>, even if the tags are well-formed XML, the tags and their content are ignored.
- An empty string is specified if the value of a <title> or <body> tag is omitted.
- The <mail> tag cannot be omitted. If it is omitted, the format is not valid and a read error occurs.
- All entries are case sensitive.
To modify the settings, edit the email-title and email-body sections in the mailDefinition file.
| Setting | XML element | Character string length | Default value |
|---|---|---|---|
| Title of email to use for email notifications | <title> | Character string of 0-9,999 bytes | [Ops Center Automator] $TASK_NAME$ has changed to $TASK_STATUS$ |
| Body of email to use for email notifications | <body> | Character string of 0-9,999 bytes | Service Group Name:$SERVICE_GROUP_NAME$ Task Name: $TASK_NAME$ User Name: $USER_NAME$ Task Detail: $TASK_DETAIL_ URL$ |
| Character you want in the email | Character string to enter |
|---|---|
| & | & |
| < | < |
| > | > |
| " | " |
| ' | ' |
| Embedded characters | Item | Remarks |
|---|---|---|
| $SERVICE_GROUP_NAME$ | Service group name | Set to the character string representing the service group name. |
| $TASK_NAME$ | Task name | Set the task name according to the format in the task properties. |
| $TASK_ID$ | Task ID | |
| $TASK_KIND$ | Task type | |
| $SERVICE_NAME$ | Service name | |
| $TASK_TAGS$ | Tag of the task | |
| $TASK_STATUS$ | Task status | |
| $EXECUTION_DATE$ | Date and time the process was run | |
| $PLANNED_START_DATE$ | Planned date and time of start | |
| $START_DATE$ | Actual date and time of start | |
| $END_DATE$ | Date and time of end | |
| $USER_NAME$ | User who runs the process | |
| $SCHEDULE_PERIOD$ | Scheduled execution period | |
| $SCHEDULE_TIME$ | Scheduled execution time | |
| $SCHEDULE_TIME$ | Date execution was scheduled to start | |
| $TASK_DETAIL_URL$ | URL of the Task Detail window | Set to a URL starting with http. |