Create an Email-Alert Based Trigger for DeviceHub Devices
In this use case, you will set up an alert and a trigger for a Belden Horizon Data Operations (BHDO) device. Then you will simulate an error output so that an alert is triggered. When the alert is triggered, the email addresses specified in the trigger will receive an email with information about the alert and
Before You Begin
- You will have to enable SMTP from the Belden Horizon Data Manager (BHDM) Admin Console. See Email to learn more.
Step 1: Add Device
Follow the steps to Connect a Device. Select the Device Type Simulator and Driver Name Generator.
Step 2: Add Tag
After connecting the device, you can Add a Tag to the device.
Configure the following for the tag:
- Name: S - Random value generator
- Value Type: string
Step 3: Import Topic into Default Generic MQTT SSL Connector
You will next import the tag you've created as a topic into the generic MQTT SSL connector that connects BHDO to BHDM.
To import the tag into the generic MQTT SSL connector:
- Log in to Belden Horizon Data Operations.
- Navigate to Integration.
- Click the generic-mqtt-ssl connector tile.
Click the Topics tab.
Click the Import from DeviceHub tags icon. The DeviceHub Import dialog box appears.
Select the check box to import the tag from the device you created earlier and click Import.
Click the Enable all topics icon.
Return to the Integration pane and toggle the connect option and confirm the status is CONNECTED.
Step 4: Set Up an Email-Alert based Trigger
In this step you will create an email notification alert. Next, you will create a trigger that will use the email notification alert. See Alerts for additional details.
From Belden Horizon Data Manager, navigate to Alerts and follow the steps below.
Step 4a: Set Up an Email Alert
To set up an email alert:
From the Alerts pane, click the Add new Action icon. The Add new Action dialog box appears.
- From the Add new Action dialog box, enter the following details:
- Action Template: Select EMAIL.
- Action Name: Enter an action name.
- Enter email: Enter an email address that will receive the alert.
- Notifications Limit: Enter 1.
- Interval: Select minute.
- Click Add. The newly created action appears in the Action List.
Step 4b: Set Up a Trigger
To set up a trigger:
From the Alerts pane, click the Add new Trigger icon. The New Trigger pane appears.
- From the New Trigger pane, configure the following sections.
Trigger
- Name: Enter a name for the trigger.
- Active: Select the checkbox.
- Dashboard: Select the checkbox.
- Description: Enter a description for the trigger.
Scope
Select Edge Device and select the appropriate BHDO instance.
Source
- Select Metrics as the source of the trigger.
- Click Add new rule.
- Select Alert template: Select DH device data quality.
- For Target Value, msgs/minute, enter 1 minute.
- For Alert Delay, seconds, enter 60 seconds.
Action
- Action List: Select the action you previously created.
- Continuously: Select the checkbox to send notifications continuously.
- Notification Period, minutes: Enter 1.
When done, click Save. The alert trigger appears in the Trigger List.
Step 5: Simulate Invalid/Corrupted Data
From Belden Horizon Data Operations, you will simulate the DeviceHub driver sending invalid/corrupted data.
To simulate a disconnection:
- Log in to Belden Horizon Data Operations.
- From the navigation panel, navigate to DeviceHub > Tags. The Tags pane appears.
Click the Action menu for the tag you created and select Edit.
- For the Value Type field, select float64.
- For the Formula field, corrupt the Formula field by replacing the s in sin with 1 so that the final formula starts with 1in. Then, click Update Tag.
Step 6: Verify Successful Trigger and Alert
From Belden Horizon Data Manager, you will verify the simulated error rate.
To verify the successful trigger and alert:
- Log in to Belden Horizon Data Manager.
- Select the appropriate company and project. The Dashboard pane appears for the project.
- From the navigation panel, select Incidents. The Incidents pane appears. Review that the incidents display in the list.
The email address that was entered from Step 4a: Set up an Email Alert will also receive the respective alert email.