Documentation (Beta)
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Gateway Group Alarm Rules

How to create Alarm Rule for the Gateway Group with EMAIL Notifications

  1. Navigate to the Tektelic Network Server –> Gateway Groups.

  2. Open the Gateway Group you want to add Alarm Rule to.

  3. Press the Alarm Rules tab in the Gateway Group menu.

  4. In the opened Alarm Rules tab press the “+” button.

    Figure 1. ADD button

  5. Fill in the Name and Description fields with any data.

  6. Press the Add Alarm Trigger button.

    Figure 2. ADD Alarm Trigger

  7. Select the desired option from the Alarm Triggers drop-down list:

    • “Gateway stopped reporting data” and “Gateway lost mqtt connection” will be triggered when Gateway goes Offline
    • “Gateway started reporting data” and “Gateway established mqtt connection” will be triggered when Gateway goes Online.
    • “GW Alarm” and “Gateway Fault” for the corresponding events. Please Note: you have to add 1 alarm trigger to 1 Alarm Rule for the alarm to work correctly.

    Figure 3. ADD button

  8. Click the Add Notification button.

    Figure 4. ADD button

  9. Fill in the Enter Recipients field with the email address to which you wish to receive notifications and press Enter.

  10. Fill in Subject and Body fields with any data.

  11. Press ADD button.

    Figure 5. ADD button

Please note: For easy reading of the notification, you can add a reference that is used in the body or/and subject. Placeholder could be added by double-clicking on the one in the list (in this case it would appear in the body right after the cursor current location)

Available references to use in body and subject:

  • $eventId
  • eventType
  • eventSeverity
  • eventState
  • eventDesc
  • gatewayId
  • gatewayName
  • gatewayMAC
  • gatewayDesc
  • gatewayModel
  • gatewayBand
  • gatewayCustomer
  • groupId
  • groupName
  • groupDesc

How to create Alarm Rule for the Gateway Group with SMS Notifications

  1. Navigate to the Tektelic Network Server –> Gateway Groups.

  2. Open the Gateway Group you want to add Alarm Rule to.

  3. Press the Alarm Rules tab in the Gateway Group menu.

  4. In the opened Alarm Rules tab press the “+” button.

    Figure 1. ADD button

  5. Fill in the Name and Description fields with any data.

  6. Press the Add Alarm Trigger button.

    Figure 2. ADD Alarm Trigger

  7. Select the desired option from the Alarm Triggers drop-down list:

    • “Gateway stopped reporting data” and “Gateway lost mqtt connection” will be triggered when Gateway goes Offline
    • “Gateway started reporting data” and “Gateway established mqtt connection” will be triggered when Gateway goes Online.
    • “GW Alarm” and “Gateway Fault” for the corresponding events. Please Note: you have to add 1 alarm trigger to 1 Alarm Rule for the alarm to work correctly.

    Figure 3. ADD button

  8. Click the Add Notification button.

    Figure 4. ADD button

  9. Press on Type drop-down and select SMS.

    Figure 5. ADD button

  10. Fill in the Enter Recipients field with the desired phone number for receiving notifications and press Enter.

  11. Fill in Body field with any data.

  12. Press ADD button.

Figure 5. ADD button

Please note: For easy reading of the notification, you can add a reference that is used in the body or/and subject. You do this by adding one of the references below in the body or/and subject with a $ sign in the beginning.

Available references to use in body and subject:

  • $eventId
  • eventType
  • eventSeverity
  • eventState
  • eventDesc
  • gatewayId
  • gatewayName
  • gatewayMAC
  • gatewayDesc
  • gatewayModel
  • gatewayBand
  • gatewayCustomer
  • groupId
  • groupName
  • groupDesc

How to create Alarm Rule for the Gateway Group with MQTT Notifications

  1. Navigate to the Tektelic Network Server –> Gateway Groups.

  2. Open the Gateway Group you want to add Alarm Rule to.

  3. Press the Alarm Rules tab in the Gateway Group menu.

  4. In the opened Alarm Rules tab press the “+” button.

    Figure 1. ADD button

  5. Fill in the Name and Description fields with any data.

  6. Press the Add Alarm Trigger button.

    Figure 2. ADD Alarm Trigger

  7. Select the desired option from the Alarm Triggers drop-down list:

    • “Gateway stopped reporting data” and “Gateway lost mqtt connection” will be triggered when Gateway goes Offline
    • “Gateway started reporting data” and “Gateway established mqtt connection” will be triggered when Gateway goes Online.
    • “GW Alarm” and “Gateway Fault” for the corresponding events. Please Note: you have to add 1 alarm trigger to 1 Alarm Rule for the alarm to work correctly.

    Figure 3. ADD button

  8. Click the Add Notification button.

    Figure 4. ADD button

  9. Press on Type drop-down and select MQTT.

    Figure 5. ADD button

  10. Fill in the MQTT Broker Address field with the MQTT Broker for receiving notifications.

  11. Fill in the Port field with the valid MQTT port.

  12. Fill in Push Topic field with desired push topic.

  13. Press ADD button.

Figure 5. ADD button