SMTP Event Transport Configuration
The SMTP Event Transport Configuration acts as a bridge between anynode's event system and the SMTP server, ensuring that event notifications are delivered efficiently and securely to designated recipients. Without this configuration, anynode could not utilize SMTP to send alerts or status updates via email.
In the upper menu, navigate to Extras and Event Transport.
You will get the list of event transport objects.
Click on .
At Severity filter, configure which events should be transported depending on their severity.
Select the category of events that should be sent. By default, all categories are activated.
The options are:
Error
Warning
Information
Open the lock if you want to make some changes.
We recommend limiting email notifications as much as possible and focusing only on critical events.
In our example, the failure of the provider node is classified as an error, so we restrict notifications to error events only.
However, since we only want to receive an email in case of a provider failure and not for other node failures, we also uncheck the Error option. In the next step, we will set up a specific event filter.
Open the lock and deselect Error, Warning and Information.
Click .
At Included events you can configure which events should be transported regardless of their severity.
The filter function in the upper section provides a convenient and efficient way to narrow down and locate desired events quickly.
In our example, we want to receive an error message via email when the provider node is out of service. (ID 900) Select ID 900 or your desired IDs.
Click on .
To limit the email notification to only the "Provider" node when it fails, follow these steps:
Select the ID 900 event.
At the bottom right, you'll find the option.
Adjust the Condition:
In the Event filter, you can define the specific conditions under which the email will be sent.
Choose the default value: any of the conditions below must be met
Click on the +
Choose Node Name as Parameter.
Choose is equal to as comparison operator.
Make sure to adjust the condition so it only applies when the "Provider" node fails. Choose your provider node as comparison value.
Click on .
This way, you can target the notifications specifically to the "Provider" node, without receiving emails for failures on other nodes.
At Excluded events, you can configure which events should not be transported.
In our example, we don't want to exclude events.
Click on .
At Transport type, select a transport protocol.
Choose SMTP.
Select the SMTP client you previously configured. If you haven't configured it yet, you can click here to complete the setup as described in the previous chapter.
Click .
The Subject is created from a template and may contain any text and keywords. The default template for the subject is:
anynode {% $Severity %} message on {% $SystemName %}
Body
The email body may contain plain text or HTML. The format for default templates is automatically detected and the email content type is set accordingly. For custom templates the content type must be set accordingly. Any keyword can be at any position and the corresponding information will be inserted. Via conditions special formats in HTML content may be set. Via the configuration either the default template for text or HTML is used or a customized template is specified.
Default Text Body
System Name: {% $SystemName %} anynode Version: {% $Version %}
{% $Severity %} {% $EventId %} {% $MessageText *}
Default HTML Body
The default HTML body shows the same information as the default text body however the text is formatted. The layout would look like the following.
Use the default values.
Click to continue.
At Message template, you can select the frontend URL to include it in the message. In our example, we include the default frontend URL http://127.0.0.1:8088 in the message.
You can customize the template for messages. For quick editing in an external editor, you can use the "Copy to Clipboard"
button located at the top right. Within the template keywords can be used to embed event specific information. The keywords
are written like {% $Keyword %}
Valid keywords are:
dateTime: The date and time in the format ISO 8601 YYYYMM-DDTHH:MM:SS[time-offset]. Time-offset is Z or + / - HH:MM.
idThe numeric event identifier.
severity: The event severity as string. Valid values are:
-
informational
-
warning
-
error
message The message text includes all parameters.
param1 The first parameter of the event. If the message does not contain a parameter this field is not available.
param2 The second parameter of the event. If the message does not contain two parameters an empty string is inserted.
param3 The third parameter of the event. If the message does not contain three parameter this field is not available.
param4 The fourth parameter of the event. If the message does not contain four parameters this field is not available.
version The version of the installed anynode.
systemName The name of the computer anynode is running on.
systemId A unique identifier assigned to the system anynode is running on.
In most cases, accept the default values here.
Click .
At Message priority, you can configure the priority of the event messages. In most cases, the default values should suffice. Open the lock if you want to change the default value.
Click .
At Sender E-mail address, configure the e-mail address that is used to send event mails.
Click .
Under Receiver Email addresses, configure the recipients who will receive email notifications for events.
Click on the button.
Enter the E-mail address and click on .
You will receive a list of all configured addresses.
It is possible to add additional email addresses. In practice, this allows multiple departments within a company to be notified simultaneously in the event of a provider outage.
Click to include additional email addresses.
Click if you want to proceed.
The built-in Test function in the assistant allows you to quickly test email sending with the configured settings. This enables you to verify the functionality of your inputs during the configuration process. Select a desired Event ID and, if necessary, specify the Node name.
In our example, we want to send a test message when the provider node fails.
Click the button.
The status should then display "Success!".
Set a Name that helps you easily identify this event transport. In our example, we use the name suggested by the assistant.
Click .
You will get an overview of the configured event transport objects.
Click on to close the list.
Using the function is not required.
Congratulations! You have now learned everything about successfully sending emails via SMTP from anynode. This ensures you stay informed about important events, even remotely.