Permissions: Requires the "Edit Area configuration" Permission (included in the "Admin" user-role by default).
The Alarm Setup screen allows you to add and configure Standards based Alarms for your different areas. SureView supports Email / SMTP or JSON over HTTPS alarms
Each alarm has a unique identifier that can be used to trigger an alarm event in the SureView Alarm Processing Queue
Alarm Setup Fields
Properties
Below is a list of the available fields that can be entered when adding or editing an Alarm
| Field | Description |
| Alarm Name (Required) |
The friendly name for this alarm. This is the name that will be shown to the operator when it is triggered. |
| Area (required) |
What Area is this alarm associated with. |
| Linked Cameras (Optional) |
You can link this alarm with specific cameras so that the cameras you choose popup automatically when an Operator opens this alarm. (See Video Device Setup) |
| Action Plan (Optional) |
An alarm can (optionally) be associated with an Action Plan. This will provide the operator with a set of instructions that they will be required to follow when processing this alarm. |
| System Identifier (Http Alarms Only) |
The is a system generated unique identifier that can be used when triggering this specific alarm. You can Auto Generated
If you need to match the alarm using the "Response Code" you must first select a "Root Alarm" - this will be the root system identifier that you can use when sending the HTTP Alarms |
| Response Code |
Note: This is an Advanced Option so we recommend you speak to SureView Support so we can help with the initial setup. This is a customizable response code/identifier field that you can use to match alarms. |
| Alarm Decoder |
Note: This is an Advanced Option so we recommend you speak to SureView Support so we can help with the initial setup. This allows you to choose a preconfigured alarm decoder to associate with this alarm (see Alarm Decoder section below). This allows you to decode custom alarm formats. |
| Priority (Required) |
This is an indication of how important this alarm is. The higher the number, the more important the alarm. Note: Priority 1000 (one thousand) and above should be reserved for your most serious alarms that require immediate attention from your operators, any alarms set at 1000 or above cannot be masked and will always come into the system. |
| Grouping (Required) |
This allows you to decide how you want multiple instances of this alarm to be grouped when it goes into the Alarm Processing Queue. The options are:
|
| Service Level Agreement (SLA) in Seconds |
The Response Time SLA. How long an Alarm Event can remain in the alarm queue (in seconds) before it breaches it's given SLA |
Email / SMTP Alarms
Email Address
This is the unique email address that will trigger the alarm. Any emails sent to this address will automatically create the alarm in the Alarm Processing Queue (including any email attachments such as an alarm snapshot or clip).
It is important that the email is copied exactly into your alarm device. Any mistakes in the address will prevent the alarm from being triggered.
Email Configuration
From: Any email address. It does not matter,
To: Use the email address shown in the Alarm Setup "SMTP Alarms" screen. e.g. Ag34r8vwqt@us.sureviewops.com
Subject: The alarm message that will be shown to operators. e.g. "Motion Detected"
Body: The body is not displayed in the main alarm queue, but operators can open the full email to get the extra detail that would be in the body of the email. If the body contains Decimal GPS coordinates in the format latitude, longitude then the alarm will automatically be plotted on the SureView Alarm Map e.g. "51.650646,-3.914983"
Advanced SMTP Setup
For advanced users who need more detail on the SMTP (email) configuration. Please see our Advanced SMTP Alarming Configuration support page.
JSON over HTTPS Alarms
JSON over HTTP(s) is a common mechanism for devices and systems to send alarms. SureView can accept these alarms by setting the device/system to match the SureView JSON Alarm format below
Endpoints
https://us.sureviewops.com:443/receiver
https://eu.sureviewops.com:443/receiver
Header (required)
Authorization: {API Key}
You must provide your unique account API Key in the header of the HTTP POST request, you can find this key in the Alarm Setup - HTTP Alarms tab.
Note: The API Key must be converted to Base64 for transmission
| Field | Description |
| systemIdentifier (required) |
The unique System Identifier for the specific alarm (or root alarm) that you are triggering. You can find this code in the "System Identifier" field of the alarm in HTTP Alarms tab in Alarm Setup |
| text (optional) |
The text description of the alarm that will be shown to the operator. For example "Door Forced has occurred at Front Door" |
| location (optional) |
Latitude,Longitude - pinpointing the location of the alarm |
| responseCode (optional) |
Note: This is an Advanced Option so we recommend you speak to SureView Support so we can help with the initial setup. When combined with the "Root Alarm" system identifier you can use this to match on your own response code identifier rather than a separate system generated one for each point. |
| eventCode (optional) |
Note: This is an Advanced Option so we recommend you speak to SureView Support so we can help with the initial setup. When combined with a custom Alarm Decoder this lets you specify your own specific event types to decode. |
Example
Header
Authorization: 57B5456133DE143D8BA644CB56E908DE17F1381BDEB25F8A3541FA135616981FD3AFDD007A1B700F392603D9E582A84B72227A31A2AE6EE91D60CA16362AE741
Body
{
"text": "Door Forced - Front Entrance",
"systemIdentifier": "9z5138b9ak",
"location": "27.947380,-82.460741"
}This will trigger a "Door Forced - Front Entrance" alarm at location 27.947380,-82.460741 for the alarm point matching 9z5138b9ak in Alarm Setup - HTTP Alarms tab
Comments
0 commentsPlease sign in to leave a comment.