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

Application Alarm Rules

How to create Alarm Rule for the Application

  1. Navigate to the Tektelic Network Server –> Applications.

  2. Open the Application you want to add Alarm Rule to.

  3. Press the Alarm Rules tab in the Application 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:

    • “Device is Offline” will be triggered when Device goes Offline
    • “Device is Online” will be triggered when Device goes Online.
    • “Downlink Queue size exceeded the recommended threshold” the set threshold for Downlink Queue size has been exceeded
    • “Downlink Queue size is within the recommended range” the set threshold for Downlink Queue size is not exceeded
    • “Downlink Queue is full” new DLs are lost
    • “Downlink Queue is not full” can accept new DLs
    • “Integration is disconnected” will be triggered when Integration is disconnected.
    • “Integration is connected” will be triggered when Integration is connected.
    • “Decoder is banned” will be triggered when decoder is banned.
    • “Decoder is unbanned” will be triggered when decoder is unbanned.
    • “Encoder is banned” will be triggered when encoder is banned.
    • “Encoder is unbanned” will be triggered when encoder is unbanned. 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
  • $deviceId
  • $deviceName
  • $appEUI
  • $devEUI
  • $appId
  • $appName

How to create Alarm Rule for the Application with SMS Notification

  1. Navigate to the Tektelic Network Server –> Applications.

  2. Open the Application you want to add Alarm Rule to.

  3. Press the Alarm Rules tab in the Application 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:

    • “Device is Offline” will be triggered when Device goes Offline
    • “Device is Online” will be triggered when Device goes Online.
    • “Downlink Queue size exceeded the recommended threshold” the set threshold for Downlink Queue size has been exceeded
    • “Downlink Queue size is within the recommended range” the set threshold for Downlink Queue size is not exceeded
    • “Downlink Queue is full” new DLs are lost
    • “Downlink Queue is not full” can accept new DLs
    • “Integration is disconnected” will be triggered when Integration is disconnected.
    • “Integration is connected” will be triggered when Integration is connected.
    • “Decoder is banned” will be triggered when decoder is banned.
    • “Decoder is unbanned” will be triggered when decoder is unbanned.
    • “Encoder is banned” will be triggered when encoder is banned.
    • “Encoder is unbanned” will be triggered when encoder is unbanned. 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. 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 Application with MQTT Notification

  1. Navigate to the Tektelic Network Server –> Applications.

  2. Open the Application you want to add Alarm Rule to.

  3. Press the Alarm Rules tab in the Application 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:

    • “Device is Offline” will be triggered when Device goes Offline
    • “Device is Online” will be triggered when Device goes Online.
    • “Downlink Queue size exceeded the recommended threshold” the set threshold for Downlink Queue size has been exceeded
    • “Downlink Queue size is within the recommended range” the set threshold for Downlink Queue size is not exceeded
    • “Downlink Queue is full” new DLs are lost
    • “Downlink Queue is not full” can accept new DLs
    • “Integration is disconnected” will be triggered when Integration is disconnected.
    • “Integration is connected” will be triggered when Integration is connected.
    • “Decoder is banned” will be triggered when decoder is banned.
    • “Decoder is unbanned” will be triggered when decoder is unbanned.
    • “Encoder is banned” will be triggered when encoder is banned.
    • “Encoder is unbanned” will be triggered when encoder is unbanned. 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