Implementation
To send Slack notifications when an alarm is triggered, drag and drop a Slack Recipient from the palette into the AlarmService Wiresheet and link the "Alarm" topic from the desired alarm classes to the "Route Alarm" action of the Slack Recipient.
Then configure the Slack Recipient
The Token and Channel Id slots are mandatory to send notifications:
- You can find the Token on this page: https://api.slack.com/custom-integrations/legacy-tokens in the "Legacy token generator" section (you have to be logged in to your Workspace first)
This token is associated to your account and a Workspace. You will only be able to write in public channels and private channels of this workspace where you have write rights.
Then ->
- You can find the Channel Id using Slack in a web browser, here's how: https://www.wikihow.com/Find-a-Channel-ID-on-Slack-on-PC-or-Mac.
Now, anytime an alarm associated to your Slack recipient is triggered, you should receive a Notification.
The notification
This is how a basic notification looks like (the name of the bot and the icon are default values) :
The notification follows this format: {AlarmSourceName + Hyperlink} ( {AlarmClass} ): { AlarmData.msgText }
If you click on the "Details" button, the following popup appears:
As you can see, this popup displays the Uuid, the Ack State, the Current Value, the Time and the priority of the alarm.
Customization
You can customize the appearance of the notification:
- You can change the name of the bot, just put the name you want in the "Bot name" slot.
- You can change the associated image, just put a valid url of an image in the "Bot Icon Url" slot.
The image must be square and its size must be between 512 x 512 and 2000 x 2000 pixels.
You can also customize the displayed information in the "Details" popup, simply add the information (contained in the "alarmData" field of an alarm) separated by semicolons. Example: building;floor;hyperlinkOrd
The text in the popup is limited to 280 characters.
Then it should look like this:
