Difference between revisions of "V2/Digital Twin Tutorial/Viewing Alarm"

From Senfi Docs
Jump to: navigation, search
(Created page with "<h1 class="main-heading">View Alarms</h1> Once alarms have been created in the CMS, they can subsequently be...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<h1 class="main-heading">View Alarms</h1>
 
<h1 class="main-heading">View Alarms</h1>
  
Once alarms have been created in the [[V2/CMS_Tutorial/User_Tools/Creating_Content/Automation/Alarm|CMS]], they can subsequently be viewed in the Digital Twin when triggered. This section provides tutorials on how to:  
+
Once alarms have been created in the [[V2/CMS_Tutorial/User_Tools/Creating_Content/Automation/Alarm|CMS]], they can subsequently be viewed in the Digital Twin when triggered.  
* [[#View Activity Log|View Alarm Activity Log]]
+
 
 +
<div class="important">Note: The following steps assume that the user is already logged in to the [https://app.senfi.io/twin/ Digital Twin] and [[V2/Digital_Twin_Tutorial/Viewing_Site/Select_Site|selected a site]]. </div>
 +
 
 +
This section provides tutorials on how to:  
 +
* [[#View Alarms|View Alarms]]
 
* [[#Focus on a Single Alarm|Focus on a single alarm]]
 
* [[#Focus on a Single Alarm|Focus on a single alarm]]
 +
* [[#View Alarm Activity Log|View Alarm Activity Log]]
 
* [[#Display Related Assets|Display related assets of an alarm]]
 
* [[#Display Related Assets|Display related assets of an alarm]]
 
* [[#Set Status and Flags|Set status and flags of an alarm]]
 
* [[#Set Status and Flags|Set status and flags of an alarm]]
* [[#Search for an Alarm|Search for an alarm]]
+
* [[#Search for Alarms|Search for alarms]]
 
* [[#Filter Alarms|Filter alarms]]
 
* [[#Filter Alarms|Filter alarms]]
 
* [[#Show/Hide Dismissed Alarms|Show/Hide dismissed alarms]]
 
* [[#Show/Hide Dismissed Alarms|Show/Hide dismissed alarms]]
 +
 +
=== View Alarms ===
 +
[[File: View_alarms_digital_twin.png|thumb|center|600px|"ALARM" tab to view all alarms|link=]]
 +
# Select [[File:Alarm_Tab_Dropdown.png|30px|link=]] '''Alarm dropdown''' on the "ALARM" tab ('''top left corner''' of the 3D Model).
 +
#* A '''red''' tab signifies presence of unacknowledged alarms. The number on the tab represents the number of unacknowledged alarms.
 +
 +
=== Focus on a Single Alarm ===
 +
# [[#View Alarms|View Alarms]].
 +
# Select [[File:Focus.png|30px|link=]] '''Focus''' beside the alarm you want to focus on. [[File:Focus_on_alarm.png|thumb|center|400px|Focus on 'Chiller Equipment Malfunctioned' alarm|link=]]
 +
#* You will be redirected to the 3D Model where the alarm's related assets are focused on.
 +
#* The alarm information will also be displayed.
 +
 +
=== Display Related Assets ===
 +
There are two ways to display an alarm's related assets:
 +
* Method 1:
 +
# [[#View Alarms|View Alarms]].
 +
# Select [[File:Alarm_Tab_Dropdown.png|30px|link=]] '''Info dropdown''' beside the alarm you want to view. [[File:Alarm_related_assets.png|thumb|center|600px|Display related assets of alarm|link=]]
 +
#* The alarm's related assets will be shown in the first panel.
 +
* Method 2: See [[#Focus on a Single Alarm|Focus on a Single Alarm]].
 +
 +
<div class="important">Tip: Navigate to a related asset by selecting [[File:Go_to_asset.png|30px|link=]] '''Go''' beside the relevant asset (Method 1) or selecting the asset displayed on the 3D Model (Method 2).</div>
 +
 +
=== View Alarm Activity Log ===
 +
There are two ways to view an alarm's activity log:
 +
* Method 1:
 +
# [[#View Alarms|View Alarms]].
 +
# Select [[File:Alarm_Tab_Dropdown.png|30px|link=]] '''Info dropdown''' beside the alarm you want to view. [[File:Alarm_Activity_Log.png|thumb|center|600px|Display alarm's activity log|link=]]
 +
#* The alarm's activity log will be shown in the second panel.
 +
* Method 2:
 +
# [[#Focus on a Single Alarm|Focus on a Single Alarm]].
 +
# Select [[File:Alarm_Tab_Dropdown.png|30px|link=]] '''Info dropdown''' beside the alarm's last recorded activity.
 +
 +
=== Set Status and Flags ===
 +
There are two ways to set the status and/or flags of an alarm:
 +
* Method 1:
 +
# [[#View Alarms|View Alarms]].
 +
# Choose a status (Acknowledged, Unacknowledged, Dismissed) from the [[File:Alarm_status.png|100px|link=]] '''Alarm Status''' dropdown list under the "Status" column.
 +
# Set the flag by modifying the value under the "Flag" column.
 +
* Method 2:
 +
# [[#Focus on a Single Alarm|Focus on a Single Alarm]].
 +
# Choose a status (Acknowledged, Unacknowledged, Dismissed) from the [[File:Alarm_status.png|100px|link=]] '''Alarm Status''' dropdown list.
 +
# Set the flag by modifying the value of the "Flag".
 +
 +
=== Search for Alarms ===
 +
# [[#View Alarms|View Alarms]].
 +
# Search for alarms using the [[File:Search_Alarm.png|120px|link=]] '''Search''' bar (top of screen).
 +
 +
=== Filter Alarms ===
 +
The Digital Twin currently supports filtering of alarms by '''time period''' (i.e. Only alarms that were triggered within the selected time period will be displayed).
 +
 +
To do so:
 +
# [[#View Alarms|View Alarms]].
 +
# Set time period using [[File:Alarm_Filter_Start_End.png|200px|link=]] '''Time Period''' bar (top of screen). [[File:Set_Date_Time_Alarm_Filter.png|thumb|center|450px|Set Time Period for filtering alarms|link=]]
 +
# Use the pop-up that appears when the field is selected to set the required date and time.
 +
#* Set '''date''' by choosing from the '''calendar'''.
 +
#* Set '''time''' by clicking on the '''clock'''.
 +
# Select "OK" once done.
 +
 +
=== Show/Hide Dismissed Alarms ===
 +
# [[#View Alarms|View Alarms]].
 +
# '''Check''' the "Show Dismissed" box (top of screen) to '''show''' dismissed alarms or '''uncheck''' to '''hide''' dismissed alarms.

Latest revision as of 17:27, 6 August 2021

View Alarms

Once alarms have been created in the CMS, they can subsequently be viewed in the Digital Twin when triggered.

Note: The following steps assume that the user is already logged in to the Digital Twin and selected a site.

This section provides tutorials on how to:

View Alarms

"ALARM" tab to view all alarms
  1. Select Alarm Tab Dropdown.pngAlarm dropdown on the "ALARM" tab (top left corner of the 3D Model).
    • A red tab signifies presence of unacknowledged alarms. The number on the tab represents the number of unacknowledged alarms.

Focus on a Single Alarm

  1. View Alarms.
  2. Select Focus.pngFocus beside the alarm you want to focus on.
    Focus on 'Chiller Equipment Malfunctioned' alarm
    • You will be redirected to the 3D Model where the alarm's related assets are focused on.
    • The alarm information will also be displayed.

Display Related Assets

There are two ways to display an alarm's related assets:

  • Method 1:
  1. View Alarms.
  2. Select Alarm Tab Dropdown.pngInfo dropdown beside the alarm you want to view.
    Display related assets of alarm
    • The alarm's related assets will be shown in the first panel.
Tip: Navigate to a related asset by selecting Go to asset.pngGo beside the relevant asset (Method 1) or selecting the asset displayed on the 3D Model (Method 2).

View Alarm Activity Log

There are two ways to view an alarm's activity log:

  • Method 1:
  1. View Alarms.
  2. Select Alarm Tab Dropdown.pngInfo dropdown beside the alarm you want to view.
    Display alarm's activity log
    • The alarm's activity log will be shown in the second panel.
  • Method 2:
  1. Focus on a Single Alarm.
  2. Select Alarm Tab Dropdown.pngInfo dropdown beside the alarm's last recorded activity.

Set Status and Flags

There are two ways to set the status and/or flags of an alarm:

  • Method 1:
  1. View Alarms.
  2. Choose a status (Acknowledged, Unacknowledged, Dismissed) from the Alarm status.pngAlarm Status dropdown list under the "Status" column.
  3. Set the flag by modifying the value under the "Flag" column.
  • Method 2:
  1. Focus on a Single Alarm.
  2. Choose a status (Acknowledged, Unacknowledged, Dismissed) from the Alarm status.pngAlarm Status dropdown list.
  3. Set the flag by modifying the value of the "Flag".

Search for Alarms

  1. View Alarms.
  2. Search for alarms using the Search Alarm.pngSearch bar (top of screen).

Filter Alarms

The Digital Twin currently supports filtering of alarms by time period (i.e. Only alarms that were triggered within the selected time period will be displayed).

To do so:

  1. View Alarms.
  2. Set time period using Alarm Filter Start End.pngTime Period bar (top of screen).
    Set Time Period for filtering alarms
  3. Use the pop-up that appears when the field is selected to set the required date and time.
    • Set date by choosing from the calendar.
    • Set time by clicking on the clock.
  4. Select "OK" once done.

Show/Hide Dismissed Alarms

  1. View Alarms.
  2. Check the "Show Dismissed" box (top of screen) to show dismissed alarms or uncheck to hide dismissed alarms.