As of December 15th, 2020, the creation of alerts will change to the following process. It is important to understand that an alert is the combination of an alarm and a notification. Creating only an alarm does not automatically create the corresponding notification that will alert an individual responsible for addressing concerns. That connection must be created using the framework described below.
The new framework requires the collection of alarms into assets, then grouping those assets, and finally subscribing contacts to those asset groups for notification of alarms. Most users will begin by creating the Alarms first and then bundling those alarms into Assets, while others prefer to create Assets and then attribute the Alarms afterward. Either process will work assuming that the Assets are placed into Groups and then Contacts are subscribed to those Groups to receive the alerts. The process described below will begin with Alarm creation.
To create an Alert, navigate to the Alert tab and click on the Alarm button.
The Alarm screen displays the alarms and status rules defined by the user.
User defined alarms can alert users via email or text notifications according to the latest conditions measured from the most recent push of data from the gateway controller.
To create a new Alarm:
- Click the + New Alarm button
- Enter a user-defined Alarm Name.
- Select the Alarm Type (Register, Connectivity, or Geofence).
- Select the Gateway that receives the data signal for this alarm.
- Select the Data signal that will trigger this alarm from the dropdown list.
- Select the Operator for comparison (equal, less than, greater than, less than or equal to, greater than or equal to).
**Pro Tip: In most cases when setting up a register alarm you will use greater than (>) or less than (<) not equal to (=)
- Enter the desired Comparison value(s) into the Warning and/or Critical text fields. The Warning value is optional, but the Critical value is required.
- If applicable, select a Modifier via the check box (Duration, Manual Clear)
- Assign this alarm to an asset by selecting a previously created Asset from the dropdown list or create one by clicking (new) and typing an Asset Name into the text field that appears. Click Save Asset to finish creating the asset and then choose it from the dropdown list. Assets can be created prior to alarms as described in the next section.
- Click Save to complete the alarm creation.
- Repeat the process above to create additional alarms, then proceed to the Asset section.
- More information regarding alarm parameters is included at the end of this guide.
All attributes of a created alarm can be modified by clicking the (Edit) button next to each Alarm.
To create an Asset, navigate to the Alert tab and click on the Asset button.
The Asset screen displays the list of Assets and the Alarms associated with those machines or processes. Also indicated are the Groups that contain each asset and any alarm status from the latest data push.
To create a new Asset:
- Click the + New Asset button
- Enter a user-defined Asset Name.
- Select the Gateway that receives the alarm signals for this asset.
- Select an Alarm signal from the dropdown list and click the Add button. The alarm will appear in the list of alarms for that asset. Repeat this step until all desired alarms are assigned to this asset.
Note: An alarm can only be associated with one asset. After the association is established, the alarm will no longer appear in the dropdown list. The alarm must be disassociated before it can be used with different asset.
- If a previously created group is available, select the Group from the dropdown list and click the Add button. The Group will appear in the list for this asset.
If a Group is not available, proceed to the next step. Group creation will be covered in the next section.
- Click Save to complete the asset creation.
- Repeat the process above to create additional assets, then proceed to the Group section.
All attributes of a created asset can be modified by clicking the (Edit) button next to each Asset.
**Pro Tip: The Edit Asset prompt window is the best tool to use for managing the association of alarms and assets. Simply add or remove the alarm signals as needed using this prompt window.
To create a Group, navigate to the Alert tab and click on the Group button.
The Group screen displays the list of Groups and the associated Assets. Also indicated are the Contacts currently subscribed to receive the Alerts from the alarms triggered in that group of assets. Asset alarms that have been triggered with the latest data push are also shown via the color of the Asset text.
To create a new Group:
- Click the + New Group button
- Enter a user-defined Group Name.
- Select an Asset from the dropdown list and click the Add button. The asset will appear in the list of assets for that group. Repeat this step until all desired assets are assigned to this group.
- If a previously created contacts are available, select the Contact from the dropdown list and click the Add button. The contact will appear in the list for this Group.
If a Contact is not available, proceed to the next step. Contact creation will be covered in the next section.
- Click Save to complete the group creation.
**Important Note: Now that the association of a Contact to a Group has completed with the last step, alert notifications will begin.
- Repeat the process above to create additional groups, then proceed to the Contact section.
All attributes of a created group can be modified by clicking the (Edit) button next to each Group.
To create a Contact, navigate to the Alert tab and click on the Contacts button.
The Contacts screen displays the list of Contacts and the associated Groups. Also indicated is the contact information currently entered for that individual (email or cellular phone number). If an individual has entered their schedule information into the system, that will also display.
To create a new Contact:
- Click the + New Contact button
- Enter a user-defined Contact Name.
- Select the Contact type from the dropdown list [Email or SMS (text)].
Email: Enter the email address for that individual.
SMS: Select the Cell Provider of the individual’s cellular device from the dropdown list, then enter the 10-digit cellular number for that individual in the text field next to Phone.
- If applicable, click the checkbox next to Schedule and select the days during the week and time period during those days that the individual is responsible for receiving alerts. If Schedule is not selected, the contact will receive alerts whenever an alarm is triggered from the latest data push.
Note: Schedules are based on the time zone selected for your company (Settings-> Companies-> Edit). If End Time is less than Start Time, the period will elapse overnight. If Start Time is the same as End Time or is left blank, the period will elapse all day.
- Select a Group from the dropdown list and click the Add button. The Group will appear in the list for this contact. This establishes responsibility for this individual to receive alerts due to alarm triggering within group of assets. Repeat this process as desired.
- Click Save to complete the Contact creation.
**Important Note: Now that the association of a Contact to a Group has completed with the last step, alert notifications will begin. This process of association can be done using the New/Edit Contact prompt or the New/Edit Group prompt described in the previous section.
All attributes of a created contact can be modified by clicking the (Edit) button next to each Contact.
Alarm parameters – Additional Information
User-defined field used to name the alarm.
Select how to compare values
= equal, != not equal, > greater than, >= greater or equal, < less than, <= less than or equal
Constant value to compare incoming data
Brief description of the Alarm rule comparison
Defines if the alarm is going to send an email when the alarm is active
Address defined in the alarm definition
Defines the error level of a Connectivity alarm. The Error Timeout value defines the amount of time before an error condition is reached. When an Error condition is reached an email will be sent. The Error Timeout value should be greater than the Warning Timeout value.
Duration—time (in minute) for which the rules must be true before the alarm becomes active
Manual Clear—this functions like latching, once it is in an alarm/error state it must be manually cleared by the user.
User-defined webserver name given to a DXM Controller
All references to the data will be through the Gateway Name
Current condition of the alarm: error or clear
Time at which the alarm changed state
Alarm types include Register, Connectivity, or Geo-fence.
- Register—Use to monitor register values and compare to user-defined values. Set based on the data sent to the website. A data comparison is made with the incoming data to create an email.
- Connectivity—Detects if the DXM Controller is no longer sending data to the website. If the DXM Controller is programmed to push data every 30 minutes, set the connectivity alarm to 2× to 3× that time plus some guard band, approximately 70–100 minutes. If network connectivity is expected to be poor, extend the alarm time to prevent false alarms.
- Geofence—Creates a fence based on a rectangular set of GPS coordinates. Any push data marked with GPS coordinates outside the Geo-fence creates an alarm condition.
Defines the warning level of a Connectivity alarm; defines the amount of time before a warning condition is reached. When the warning condition is reached an email is sent. Set the DXM Controller push time to be less than the Warning Timeout value.