Creating a Message Template
In AOM, you can create message templates to customize notifications. When a preset notification rule is triggered, notifications can be sent to specified personnel by email, SMS, HTTP, or HTTPS. If no message template is created, the default message template will be used.
Functions
- Message templates for emails, SMS, HTTP, and HTTPS are supported.
- Message templates can be customized. For details, see 3.c.
Precautions
- You can create a maximum of 100 message templates. If the number of message templates reaches 100, delete unnecessary ones.
- By default, two message templates are preset and cannot be deleted or edited. If there is no custom message template, notifications are sent based on a preset message template by default.
Creating a Message Template
- Log in to the AOM 2.0 console.
- In the navigation pane, choose Alarm Management > Alarm Action Rules.
- On the Message Templates tab page, click Create.
- Enter a template name, message template type, and description, and specify an enterprise project.
Table 1 Parameter description Parameter
Description
Template Name
Name of a message template. Enter up to 100 characters and do not start or end with an underscore (_) or hyphen (-). Only digits, letters, underscores, and hyphens are allowed.
Description
Description of the template. Enter up to 1024 characters.
Message Template
Type of the message template. Option: Metric/Event.
Enterprise Project
Enterprise project.
- If you have selected All for Enterprise Project on the global settings page, select one from the drop-down list here.
- If you have already selected an enterprise project on the global settings page, this option will be grayed and cannot be changed.
NOTE:
To use the enterprise project function, contact engineers.
- Select a language (for example, English).
- Customize the template content (default fields are automatically filled in when a message template is created). There are templates for emails and SMS. For details, see Table 2.
- In addition to the message fields in the default template, the message template also supports custom fields. You need to specify the fields when reporting event alarms. For details, see the alarm reporting structs in the following message template.
- Custom fields support the JSONPath format. Example: $event.metadata.case1 or $event.metadata.case[0].
- In the upper right corner of the Body area, click Add Variables to add required variables.
- If you select Emails, you can click Preview to view the final effect. On the Preview page, change the message topic if necessary.
Table 2 Variables in the default message template Variable
Description
Definition
Alarm Name
Name of the alarm rule that is triggered.
${event_name}
Alarm ID
ID of the alarm rule that is triggered.
${id}
Action Rule
Name of the alarm action rule that triggers notification.
${action_rule}
Occurred
Time when the alarm or event is triggered.
${starts_at}
Event Severity
Alarm or event severity. Options: Critical, Major, Minor, and Warning.
${event_severity}
Alarm Info
Detailed alarm information.
${alarm_info}
Resource Identifier
Resource for which the alarm or event is triggered.
${resources_new}
Custom tag
Extended tag.
$event.metadata.key1
Suggestion
Suggestion about handing the alarm. For non-custom reporting, "NA" is displayed.
${alarm_fix_suggestion_zh}
Custom annotation
Extended annotation.
$event.annotations.key2
- Click Confirm. The message template is created.
- Enter a template name, message template type, and description, and specify an enterprise project.
More Operations
After creating a message template, you can perform the operations listed in Table 3.
Operation |
Description |
---|---|
Editing a message template |
Click Edit in the Operation column. |
Copying a message template |
Click Copy in the Operation column. |
Deleting a message template |
|
Searching for a message template |
Enter a template name in the search box in the upper right corner and click . |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot