To create emails more efficiently, create an email template definition file and then use an email template to create emails from the Execute Action window. You can also create emails that contain Ops Center Analyzer-managed resource data. For example, you can create an email template that provides information on how to troubleshoot a resource failure. When a failure occurs, email templates allow you to create emails from the Execute Action window to quickly notify the system administrator.
- Prerequisite
-
-
To send email messages from Ops Center Analyzer, configure the email server for Ops Center Analyzer.
-
- Format
- specified-key-name=specified-value
- File
-
-
Use any file.
-
Save the file in UTF-8 format.
-
A maximum of 1,000 files can be set in Ops Center Analyzer. Files are loaded in alphabetical order by file name, and any files after the 1,000th file are not loaded.
-
- Folder
-
Ops-Center-Analyzer-installation-folder/Analytics/conf/template/mail
The default installation folder is /opt/hitachi.
- Update frequency
- When Ops Center Analyzer is started or the reloadtemplate command is run.
- Content to specify
-
Specify each key name and value on a single line. When you create the email template definition file, the following rules apply:
-
A line starting with # is treated as a comment line
-
Blank lines are ignored
-
The entered values are case-sensitive
-
If the same key is specified more than once in the same file, the last specification is valid
-
To display \, specify \\
-
To display %, specify %%
-
If the filter condition SE.template.filter.xxxxxxx.string is specified more than once, settings will be displayed when all of the conditions are met
-
If you specify "LFCR" for the setting value, it displays in a new line in a preview window
-
- Setting description
-
Key name
Setting description
Specifiable values
Default value
Optional or required
SE.template.name.string
Specify the action name.
Values of no more than 127 bytes that do not include control characters
Null character
Required
If this key is omitted, the processing to read files will fail.
The name of this key is the same as the name specified in a command template definition file.
SE.template.description.string
Specify a description of the action.
Values of no more than 255 bytes that do not include control characters
Null character
Optional
If this key is omitted, the default value will be used.
SE.mail.template.title.string
Specify the subject of the email template.
Values of no more than 255 bytes that do not include control characters
Null character
Optional
If this key is omitted, the default value will be used.
SE.mail.template.body.string
Specify the body of the email template.
Values of no more than 4,096 bytes that do not include control characters
Null character
Optional
If this key is omitted, the default value will be used.
SE.mail.template.address.string
Specify the address of the email template
Values of no more than 255 bytes that do not include control characters
Null character
Optional
If this key is omitted, the default value will be used.
SE.template.filter.resourceName.string
Specify conditions for the names of the resources that are starting points and that display in the action list during resource selection.1
Values of no more than 255 bytes that do not include control characters
Null character
Optional
If this key is omitted, the default value will be used, and the key will not be used as a filter condition.
SE.template.filter.resourceType.string
Specify conditions for the types of resource that are starting points and that display in the action list during resource selection.1
Values of no more than 32 bytes that do not include control characters
Null character
Optional
If this key is omitted, the default value will be used, and the key will not be used as a filter condition.
SE.template.filter.vmHostname.string
Specify conditions for the virtual machine names that display in the action list during resource selection.1
Values of no more than 64 bytes that do not include control characters
Null character
Optional
If this key is omitted, the default value will be used, and the key will not be used as a filter condition.
SE.template.filter.ipaddress.string
Specify conditions for the IP addresses that display in the action list during resource selection.1
Values of no more than 255 bytes that do not include control characters
Null character
Optional
If this key is omitted, the default value will be used, and the key will not be used as a filter condition.
SE.template.filter.upperResourceName.string
Specify conditions for the names of higher-level resources of a starting point that display in the action list during resource selection.1
Values of no more than 512 bytes that do not include control characters
Null character
Optional
If this key is omitted, the default value will be used, and the key will not be used as a filter condition.
SE.template.filter.upperResourceType.string
Specify conditions for the types of higher-level resources of a starting point that display in the action list during resource selection.1
Values of no more than 32 bytes that do not include control characters
Null character
Optional
If this key is omitted, the default value will be used, and the key will not be used as a filter condition.
1Settings display only when the Execute Action window is called from a resource that matches the specified conditions. By using variables, you can set information about a selected resource as the value of a setting.
Variable name
Description
Remarks
%ANALYTICS_RESOURCENAME%
Name of the selected resource
Not applicable
%ANALYTICS_UPPERRESOURCENAME%
Name of the higher-level resource of the selected resource
Not applicable
%ANALYTICS_IPADDRESS%
IP address
Not applicable
%ANALYTICS_VIRTUALMACHINENAME%
Name of the virtual host
Displays only when the resource is a virtual machine.
%ANALYTICS_RESOURCETYPE%
Resource type
Not applicable
%ANALYTICS_UPPERRESOURCETYPE%
Type of the higher-level resource
Not applicable
If no value is set for the selected resource, a null character displays.
To display information about virtual hosts and IP addresses, VMware Tools must be installed on virtual hosts.
The email template definition file restricts the maximum number of characters that can be displayed in the email editor.
If the maximum number of specifiable characters is exceeded in an email template's address, subject, and body, clicking Launch Mailer in the Execute Action dialog box might not start the email editor normally.
If the email editor does not start normally, manually start the email editor, and then copy the contents of the preview to use them.
The maximum number of specifiable characters depends on the web browser. As a guideline, the maximum number of characters for web browsers is 2059 for the Firefox browser, and 200 for the Internet Explorer 11 browser.