What’s here?

In this tutorial you’ll learn how to use the MyAlerts widget to create, edit, and delete alert profiles.

The MyAlerts widget allows for the creation, modification, and deletion of alert profiles. When an alert is triggered, it is posted to the Dashboard and a notification is sent to a configured email recipient list, also managed through the MyAlerts widget.

Alerts can be created to monitor Packet, SMS, Voice, Cellular Registration, Deregistration, or SwitchHopping.

All parameters are customizable, including threshold values, time periods, and the action that occurs when an alert is triggered. Your Neo connectivity service includes two (2) pre-configured alerts (which can be customized), and you can purchase an additional ten (10) if desired.

Alerts are used to monitor traffic and activity for individual devices or a group of devices. Users are able to define thresholds for certain behaviors and are notified if the device’s activity stays below or exceeds those thresholds.
Streaming Events are used to record individual registration, deregistration, or roaming instances, and can be created for a single device or a group of devices. All Streaming Events are published to Aeris IoT Management in real time.

Create an Alert

To create a new alert, click Quicklinks and select Setup MyAlerts.

alerts_setup

You’ll see this pop-up window with options to customize the new alert. An asterisk (*) indicates a required field.

Alert info
Device info
Threshold and trigger info
Action info

Alert Info

Identify an alert Name and add a Description if desired. This name will also identify the alert in the AerAlerts section of the Dashboard Tab.

create alert form

Device Info topics

Identify the devices to be monitored in the alert. Begin by selecting a category from the Devices drop-down menu.

create alert select devices

Additional options will then be displayed based on the category selected:

Entire Account

All devices in the account will be included in the alert. No additional device information is required.

Report Group

Enter a valid report group into the Report Group field. All devices in the indicated report group will be included in the alert.

Specific Devices

Use the Device Id Type drop down menu to choose a Device ID Type (ICCID, IMSI, MSISDN). Then, enter the device ID(s) in the text field, one line per device. Up to 100 devices can be specified.

Threshold and Trigger Info topics

This section defines the type of activity to be monitored as well as the threshold criteria and time period for the alert.
Time periods Time periods are based on Greenwich Mean Time (GMT)

Per Hour

Time period between :00 and :59. ‘Resets’ at the top of each hour.

Per Day

Time period between 00:00 and 23:59 GMT of one calendar day.

Month to Date

Time period between the 1st of the month and ‘today.’

Device activity will only be tracked from the time that the alert becomes effective. For example, if a monthly alert is defined on the 12th day of a month, the applicable devices’ counts will be tracked for the purpose of alert generation starting midnight GMT following the time of alert definition on the 12th.

Entering Minimum and Maximum values

You are required to enter at least one threshold parameter. It is valid to leave a threshold ‘blank’ (e.g. to detect if a device exceeds a specific amount of packet usage, enter a maximum value and leave the minimum value blank).

If specifying both minimum and maximum values, you must ensure that the minimum value does not exceed the maximum value.

Specifying a minimum threshold of one (1) could generate unnecessary email traffic.

Specifying a threshold value of zero (0) will result in an error.

Details for each Alert Type:

Packet Alerts

Threshold Type: Usage

Threshold Unit: KB, MB, or GB

Time Period: Daily or Monthly

Example

Packet Alert with a minimum threshold of one (1) KB, per day. An alert will be generated for a device that transmits less than one (1) KB of data in one day.

create alert set threshold
Packet-Roaming Alerts

Threshold Type: Usage

Threshold Unit: KB, MB, or GB

Time Period: Daily or Monthly

Example

Packet-Roaming Alert with a maximum month to date threshold of five (5) KB. Any packet usage that occurs while a device is roaming will be totaled. If the total usage exceeds five (5) KB at any point during the current month, an alert will be generated for the device.

create alert packet roaming example
SMS Alerts

Threshold Type: Occurrence

Threshold Unit: Count (includes both MO and MT SMS)

Time Period: Daily or Monthly

Example

SMS Alert with a minimum threshold of five (5) messages and Maximum threshold of ten (10) messages, per day. An alert will be generated for a device that sends or receives fewer than five (5) messages OR more than ten (10) messages in one day.

create alerts sms frequency
Registration Alerts

Threshold Type: Occurrence

Threshold Unit: Count

Time Period: Daily or Monthly

Example

Registration Alert with a minimum count of one (1) cellular registration, per day. An alert will be generated for a device that registers less than one (1) time in one (1) day. In other words, if the device does not register on the network at any point during the day, the alert will be triggered.

create alert registration
Registration-roaming Alerts (Occurrence)

Threshold Type: Occurrence

Threshold Unit: Count

Time Period: Daily or Monthly

Example

Registration-roaming Alert for one (1) cellular registration occurrence, per day. An alert will be generated if a device registers to the network while roaming at least once within a day.

create alerts registration roaming
De-registration Alerts (Occurrence)

Threshold Type: Occurrence

Threshold Unit: Count

Time Period: Daily or Monthly

Example

De-registration Alert for one (1) deregistration occurrence, per day. An alert will be generated if a device deregisters at least once during the day. In other words, if the device loses its network connection at any point during the day, the alert will be triggered.

create alerts deregistration
SwitchHopping Alerts

Threshold Type: Occurrence

Threshold Unit: Count

Time Period: Hourly, Daily or Monthly

Example

SwitchHopping Alert for 10 occurrences, per day. An alert will be generated if a device switch hops at least 10 times in one day.

create alerts switchhopping

Action Info topics

Action Info refers to the action that occurs when an alert is triggered.

Email notification

Email Alerts provide a direct notification. An email is sent to the address associated with your account.

Block traffic

You can choose to block traffic if a device exceeds the specified threshold.

AerPort Dashboard

Alerts can also be viewed in the AerPort Dashboard on the MyAlerts tab, which displays devices that have triggered an alert within the past 24 hours.

Email Alerts

Hourly Email Alert is selected by default when creating a new alert; you cannot un-check this selection. When an alert is triggered, an email will be sent within 60 minutes of the event being detected. The email will be sent to the address associated with your account. See the Limitations section for more information regarding alert notifications.

create alerts email
Apply Traffic Policy

If a Traffic Policy is applied, devices that trigger the alert will have their services blocked as defined in the alert action. When this occurs, a Transaction ID for the Traffic Policy change will be included in the alert notification email.

To apply a Traffic Policy action, use the check boxes to select the services to be blocked. When a Traffic Policy box is checked, AerPort displays a pop-up to confirm the selection. It is important to set the threshold high enough to ensure that traffic is not blocked by mistake.

Traffic Policies

Block All

The device’s registration will be blocked to prevent incoming and outgoing Packet, SMS, and Voice services.

Block Packet

Prevents data from being transmitted to and from the device.

Block SMS

Prevent SMS from being sent to and from the device.

Save an Alert topics

Once all parameters are defined, click Save to create the alert.

The alert will be listed under the My Alerts widget with status ‘Pending Activation.’ At midnight GMT, the alert will become ‘Active.’

Access an Alert topics

Alerts will become effective at midnight GMT following the time of the alert’s creation.

When an alert is triggered an email notification is sent to all users defined in the alert recipient list within sixty (60) minutes.

For additional details regarding receiving alert information, please see the Limitations section.

Edit an Alert topics

Alerts can be modified at any time; however not all changes become effective right away:

  • Changes to Alert Info become effective immediately.
  • Changes to Device Info will take effect at midnight, GMT.
  • Changes to Action Info:
    • Modifications to “Publish Near Real-Time to AerCloud” will become effective at midnight, GMT.
    • Modifications to Traffic Policy settings will take effect immediately.
  • Changes to Device Info and Threshold & Trigger Info will become effective at midnight, GMT.

To edit an alert, select the desired alert profile from the My Alerts list.

edit alert

AerPort displays a pop-up window to edit the alert. Modify alert preferences as needed; note that the Alert Type cannot be changed for existing alert profiles. Click Save when your edits are complete.

Changes will immediately be reflected in the alert list. The alert will be listed with status ‘Pending Activation’ if the alert was not yet active or ‘Pending Change Activation’ if the alert was already in an active state. At midnight GMT, the alert will become ‘Active.’

Delete an Alert topics

To delete an alert, select the desired alert profile from the MyAlerts list and click the trash can icon in the right column. Click Delete to confirm the operation.

alerts delete

The event is immediately deleted from the alert list and will be removed from the system at midnight GMT.

Review additional details topics

When an alert is triggered, an email notification is sent to each user in the email recipient list. A maximum of ten (10) recipients is allowed per account.

Alerts

Roaming Alerts cannot be created for Coverage SIMs and Global SIMs.

It may take up to 4 hours after a device is provisioned before any of its activity is counted toward an alert.

Alerts are processed once every hour, therefore it can take up to 60 minutes after an event occurs before the user is notified. For example, an alert is defined to send an email notification if a device does not register within 15 minutes. The device deregisters at 6:05 and does not re-register by 6:20. Because alerts are analyzed at the top of the hour, the email alert notification for this device will be sent to the user at 7:00.

Minimum and maximum threshold alerts

For Maximum threshold alerts, there may be an additional latency of up to 20 minutes before an event is detected in the system. For example, if a device reaches a maximum threshold at 11:50, the system may not detect this event until 12:10. A notification for this alert will be sent to the user at 1:00, when alerts are processed at the top of the following hour.

For minimum threshold alerts, notifications are always sent at the end of the indicated time interval; the complete time duration must pass before determining whether usage was below the defined threshold.

For hourly minimum threshold alerts, the user will receive the alert after each full hour has passed. For daily minimum threshold alerts, the user will receive the alert after each full day has passed (GMT). For month to date minimum threshold alerts, the user will receive an alert at the end of the month (after the last day of the month, GMT).

Additional latency

There may be additional latency up to 15 minutes before an event is detected in the system; resulting in the trigger of invalid minimum alerts. For example, an alert is configured to detect a minimum threshold of 5 SMS per hour. At 11:55, the device receives a 5th SMS. At 12:00, the system has yet not detected the final SMS occurrence, therefore an alert notification is sent to the user even through the device has met the minimum threshold. This latency affects hourly minimum alerts only; daily and monthly minimum alerts are not affected.

Additional Use Cases topics

When an alert is triggered, an email notification is sent to each user in the email recipient list. A maximum of ten (10) recipients is allowed per account.

Case 1
Deregistration Alert for a duration of 30 minutes, per day

The device de-registers at 10:45 am.

The device does not register again until 12:30 pm.

Per the user’s specification, an alert would be generated at 11:15 AM.

Alerts are analyzed at the top of each hour, therefore an alert email is sent to the user at 12 PM.

The alert creation time in the notification, however, is set to the user specified trigger time, 11:15 AM.

Case 2

SwitchHopping alert for 5 occurrences, per day.

The device’s OPC determines the switch the device is currently registered on. If a device’s registration event has an OPC value different from the value of its last registration event, the device has registered on a different switch and this will be counted as 1 “hop.”

The device’s hop count is incremented even if it registers back on a switch that it had registered on before the previous event, within the same time period. If the hop count exceeds 5 occurrences in the same day, an alert is generated for this device.

The hop count is reset at the top of the next time period whether the alert is generated or not.

The first registration event occurring after a time period boundary starts will not cause the hop count to be incremented even if the last switch was different in the previous time window boundary.