Messages
Messages define the templates used by the platform to generate notifications and external communication payloads.
They are used by Dispatchers to deliver information generated by monitoring events and automata transitions.
Messages do not send notifications by themselves.
They only define the content structure of a notification.
Message Structure
A message is composed of the following main elements:
| Field | Description |
|---|---|
| Code | Unique identifier of the message template |
| Description | Human readable description |
| Mask Mime Type | Format of the main message body |
| Mask | Main message template |
| Additional Mask Mime Type | Format of the additional payload |
| Additional Mask | Optional secondary payload |
The template format can be:
- HTML
- JSON
- Text
Message Masks
The Mask field defines the main template used to generate the message.
It can contain dynamic placeholders that are replaced at runtime using values coming from the monitoring context.
Example:
<b>Issue on:</b> {{object_name}} <br>
Object severity: low <br>
Last Alarm Date: {{last_value_timestamp_CET}}<br>
Description:
<<automaton_wildcard::description>>
<hr>
Automation Code:
<<automaton_wildcard::instanceId>>
````
When the message is generated, the system replaces these placeholders with the corresponding values.
---
## Additional Mask
The **Additional Mask** provides a secondary payload that can be sent together with the main message.
It is typically used when integrating with external systems such as ticketing platforms or APIs.
Example:
```json
{
"customerCode": "042781",
"shortDescription": "[CHECKMK] {{object_name}}"
}
Scopes and Dynamic Variables
When editing a mask, administrators can insert dynamic variables from different scopes.
Scopes represent data contexts available during message generation.
Examples include:
- Customer
- Site
- Group
- Virtual Domain
- Object
These scopes provide the values that populate template placeholders.
Dispatchers
Messages are connected to Dispatchers.
A dispatcher defines:
- when the message should be triggered
- which notification provider should deliver it
- the calendar controlling its activation
This separation allows the same message template to be reused across multiple dispatching rules.
Typical Workflow
- Monitoring systems generate events or metrics.
- Xautomata automata evaluate these events.
- When a transition occurs, a dispatcher is triggered.
- The dispatcher generates a message using its template.
- The message is sent through a notification provider.
This mechanism allows the platform to automate notifications, ticket creation, and external integrations.