Alarm management docs

documentation/user-guide/alarm-management/index.md

@@ -0,0 +1,37 @@
+(alarm-management-doc)=
+
+# Alarm Management
+
+Hyperview has powerful alarm event management capabilities.
+
+The following subsystems can create alarm events and trigger an alarm notification.
+
+1. SNMP trap parsing and aggregation.
+2. Configured sensor thresholds.
+3. Asset Tracker (RFID asset tracking).
+4. Data collector health.
+5. Asset firmware updates (for supported vendors).
+6. Host reachability.
+
+## Alarm Events
+
+Alarm Events are created on assets and can be viewed from the Events tab of the asset. Furthermore,
+Alarm Events can change the status of an asset. The asset will have the status of the most critical
+Alarm Event triggered on it.
+
+## Alarm Policies
+
+An Alarm Event can trigger a notification. Notification can be sent to a user, a group or to a {ref}`Notification <notifications-doc>`
+Channel.
+
+
+```{toctree}
+:maxdepth: 2
+
+topics/types-of-events
+topics/viewing-alarm-events-and-statuses
+topics/asset-specific-events
+topics/global-events
+topics/sensor-threshold-management
+topics/administrating-alarm-policy-notifications
+```

documentation/user-guide/alarm-management/topics/administrating-alarm-policy-notifications.md

@@ -0,0 +1,95 @@
+# Administrating Alarm Policy Notifications
+
+Manage alarm policy notifications, ensuring that the right users receive timely alerts. Allows for tailored notifications based on asset types, severity, and user groups.
+
+```{raw} html
+<div class="pb-3"><iframe src="https://scribehow.com/embed/Administrating_Alarm_Policy_Notifications__vRLtQheETgmIx6j8h1cHMg?removeLogo=true&as=video" width="100%" height="640" allowfullscreen frameborder="0"></iframe></div>
+```
+
+1.  Navigate to the Alarm Policies page from the Settings &gt;
+    Notifications menu. The Alarm Policy page displays a list of
+    existing alarm policies and their Name, Asset Location, Asset Types,
+    Severity, Categories, Users, Groups, and Channels.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image1.jpeg
+:class: border-black
+```
+
+2.  Create a new Alarm Policy by clicking the Add button.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image2.jpeg
+:class: border-black
+```
+
+3.  Enter a Name for the alarm policy.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image3.jpeg
+:class: border-black
+```
+
+4.  Select a Location from the location picker.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image4.jpeg
+:class: border-black
+```
+
+5.  Toggle on/off the All Asset Types filter.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image5.jpeg
+:class: border-black
+```
+
+6.  Select multiple asset types from the picker as needed.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image6.jpeg
+:class: border-black
+```
+
+7.  Select a Severity.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image7.jpeg
+:class: border-black
+```
+
+8.  Select applicable alarm categories.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image8.jpeg
+:class: border-black
+```
+
+9.  Add the users who should receive the alarm notifications.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image9.jpeg
+:class: border-black
+```
+
+10.  Select the groups who should receive the alarm notifications.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image10.jpeg
+:class: border-black
+```
+
+11.  Select the channels that should receive the alarm notifications.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image11.jpeg
+:class: border-black
+```
+
+12.  Click the Add button when done configuring the notification policy.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image12.jpeg
+:class: border-black
+```
+
+13.  Any existing alarm policy can be configured by clicking the Edit
+    button.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image13.jpeg
+:class: border-black
+```
+
+14.  To remove an existing alarm policy click the Delete button.
+
+```{image} /user-guide/alarm-management/media/administrating-alarm-policy-notifications/image14.jpeg
+:class: border-black
+```

documentation/user-guide/alarm-management/topics/asset-specific-events.md

@@ -0,0 +1,56 @@
+# Asset Specific Events Page
+
+How to access, acknowledge, and close asset specific events, as well as utilize bulk actions for efficiency. Additionally, the ability to export event data to Excel enhances reporting and analysis capabilities.
+
+```{raw} html
+<div class="pb-3"><iframe src="https://scribehow.com/embed/Asset_Specific_Events_Page__eidCOEGlSSaJO4pZgUv-sw?removeLogo=true&as=video" width="100%" height="640" allowfullscreen frameborder="0"></iframe></div>
+```
+
+1.  The Asset Events page is accessed under the Events tab of the asset.
+    This page lists all events that have occurred for this asset within
+    Hyperview.
+
+```{image} /user-guide/alarm-management/media/asset-specific-events/image1.jpeg
+:class: border-black
+```
+
+2.  Expand additional event information by clicking the arrow icon for
+    that event. Event information includes the Asset Name, State, Event
+    Message, Severity, Location, Start and End Time, Event Category, and
+    Acknowledged state.
+
+```{image} /user-guide/alarm-management/media/asset-specific-events/image2.jpeg
+:class: border-black
+```
+
+3.  Clicking the Acknowledge button will set the event to the
+    acknowledged state. The event will display an acknowledgement state
+    and acknowledgement user for the event and remain Active or Closed.
+
+```{image} /user-guide/alarm-management/media/asset-specific-events/image3.jpeg
+:class: border-black
+```
+
+4.  Clicking the Close button will change the event state from Active to
+    Closed. This may be useful if alarm states cannot be automatically
+    closed by assets. Closing an event requires confirmation.
+
+```{image} /user-guide/alarm-management/media/asset-specific-events/image4.jpeg
+:class: border-black
+```
+
+5.  Bulk Actions are available from the Asset Events page. Select
+    multiple events to take action on and open the Bulk Actions menu to
+    Acknowledge, Unacknowledge, or Close events.
+
+```{image} /user-guide/alarm-management/media/asset-specific-events/image5.jpeg
+:class: border-black
+```
+
+6.  The Asset Events page can be saved to file by clicking the Export
+    button. This will download the full list of the asset alarm events
+    as an Excel document.
+
+```{image} /user-guide/alarm-management/media/asset-specific-events/image6.jpeg
+:class: border-black
+```

documentation/user-guide/alarm-management/topics/global-events.md

@@ -0,0 +1,62 @@
+# Global Events Page
+
+Manage global events within Hyperview, enabling users to efficiently acknowledge, close, and export any event data. Users can easily navigate the Global Events page, access detailed event information, and utilize bulk actions for streamlined event management. Additionally, the ability to export event data as an Excel document enhances reporting and analysis capabilities.
+
+```{raw} html
+<div class="pb-3"><iframe src="https://scribehow.com/embed/Global_Events_Page__R5c1O7ZbROSmY1G5vIdWBQ?removeLogo=true&as=video" width="100%" height="640" allowfullscreen frameborder="0"></iframe></div>
+```
+
+1.  The Global Events page is accessed under the Assets section of the
+    main menu. This page lists all events that have occurred for the
+    environment within Hyperview.
+
+```{image} /user-guide/alarm-management/media/global-events/image1.jpeg
+:class: border-black
+```
+
+2.  Expand additional event information by clicking the arrow icon for
+    that event. Event information includes the Asset Name, State, Event
+    Message, Severity, Location, Start and End Time, Event Category, and
+    Acknowledged state.
+
+```{image} /user-guide/alarm-management/media/global-events/image2.jpeg
+:class: border-black
+```
+
+3.  Clicking the Acknowledge button will set the event to the
+    acknowledged state. The event will display an acknowledgement state
+    and acknowledgement user for the event and remain Active or Closed.
+
+```{image} /user-guide/alarm-management/media/global-events/image3.jpeg
+:class: border-black
+```
+
+4.  Clicking the Close button will change the event state from Active to
+    Closed. This may be useful if alarm states cannot be automatically
+    closed by assets.
+
+```{image} /user-guide/alarm-management/media/global-events/image4.jpeg
+:class: border-black
+```
+
+5.  Closing an event requires confirmation.
+
+```{image} /user-guide/alarm-management/media/global-events/image5.jpeg
+:class: border-black
+```
+
+6.  Bulk Actions are available from the Global Events page. Select
+    multiple events to take action on and open the Bulk Actions menu to
+    Acknowledge, Unacknowledge, or Close events.
+
+```{image} /user-guide/alarm-management/media/global-events/image6.jpeg
+:class: border-black
+```
+
+7.  The Global Events page can be saved to file by clicking the Export
+    button. This will download the full list of alarm events as an Excel
+    document.
+
+```{image} /user-guide/alarm-management/media/global-events/image7.jpeg
+:class: border-black
+```

documentation/user-guide/alarm-management/topics/sensor-threshold-management.md

@@ -0,0 +1,103 @@
+(sensor-threshold-management-doc)=
+
+# Sensor Threshold Management
+
+Manage sensor thresholds effectively within Hyperview, ensuring users can customize alerts based on specific asset and sensor types. Enable or disable default thresholds, add new ones, and configure alarm severity and comparison conditions. Optimize the monitoring systems and enhance responsiveness to critical changes in sensor data.
+
+```{raw} html
+<div class="pb-3"><iframe src="https://scribehow.com/embed/Sensor_Threshold_Management__XgcCvKMzQUepWZXC_kwPkg?removeLogo=true&as=video" width="100%" height="640" allowfullscreen frameborder="0"></iframe></div>
+```
+
+1.  Open the Sensor Thresholds configuration page from the Settings &gt;
+    Sensors &gt; Thresholds menu option.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image1.jpeg
+:class: border-black
+```
+
+2.  Hyperview has many default thresholds already configured. Users may
+    not Edit or Delete these thresholds.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image2.jpeg
+:class: border-black
+```
+
+3.  Default thresholds can be turned on or off by toggling the Enabled
+    setting for the threshold.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image3.jpeg
+:class: border-black
+```
+
+4.  Start adding a new Sensor Threshold by clicking the Add button.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image4.jpeg
+:class: border-black
+```
+
+5.  Choose an asset type to configure the threshold for. All supported
+    asset types are available in this list.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image5.jpeg
+:class: border-black
+```
+
+6.  Choose a sensor type to setup the threshold for. This list of sensor
+    types is limited based on the asset type selected.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image6.jpeg
+:class: border-black
+```
+
+7.  Define the severity of the alarm which should be escalated to the
+    asset when the threshold is met.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image7.jpeg
+:class: border-black
+```
+
+8.  Select a comparison type. This allows the sensor value of the chosen
+    type to be compared to either a constant static value, or a property
+    from the asset.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image8.jpeg
+:class: border-black
+```
+
+Note that some sensor types do not have asset property comparison
+options as there are no related asset properties to compare the value
+against.
+
+9.  Set the condition for the comparison. This is typically defined as
+    the high or low threshold limit.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image9.jpeg
+:class: border-black
+```
+
+10.  Set a comparison value or select the comparison property and click
+    Add to finish configuring a sensor threshold.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image10.jpeg
+:class: border-black
+```
+
+11.  The new threshold will appear in the sensor thresholds list.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image11.jpeg
+:class: border-black
+```
+
+12.  Any user defined sensor threshold options can be reconfigured by
+    clicking the Edit button.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image12.jpeg
+:class: border-black
+```
+
+13.  User defined sensor thresholds can also be removed by clicking the
+    Delete button.
+
+```{image} /user-guide/alarm-management/media/sensor-threshold-management/image13.jpeg
+:class: border-black
+```