Chapter 6: Viewing Items

Chapter 6 describes viewing the details of the following using respective Search pages.

View Equipment

View Equipment allows you to view the Configured Equipment in the application. Equipment can be filtered for a particular Location, Asset Category, Equipment Template, Interface, Alarmed Equipment, Equipment with alarm disabled and Equipment for which the Sub System Communication is disabled.

Path Settings icon🡪 View section🡪 View Equipment

Or App Home page🡪 Equipment tab

  1. Click the Settings icon and select Equipment under View section. Equipment Search page will appear.

  2. Type the name of the Equipment in the Search Equipment input box to search for the Equipment you want.

  3. Refine search using given Search filters;

    1. Location: Clear the current location by pressing. You will observe that all the Equipment are displaying. Click on the Location text box and type in a new location to filer or select one from the drop-down list.

    2. Asset Category: Select the required asset category of Equipment asset to filter by the category.

    3. Equipment Template: Select Equipment Template to filter by the selected Equipment Template.

    4. Interface: Select the required Interface. By default “Any” will be selected which refers to all the configured Interfaces.

    5. Alarmed Equipment: Selecting the Alarmed Equipment check box will further filter the Equipment at the above Location only to display the ones that are in alarmed status.

    6. Alarm Disabled: Selecting this check box will display the Equipment with alarm process disabled.

    7. Subsystem Communication Disabled: Selecting this check box will filter and display the Equipment with sub system communication is in disabled state.

  4. Sort: Used to sort the search result in ascending or descending order as per the fields given in the drop-down box.

    1. Select the required field based on which you need to sort the search records (e.g. “Equipment” field to sort the records as per Equipment) and then click the toggle icon accordingly.

    2. : Shows that the records are in ascending order as per the selected field from the drop-down box.

    3. : Shows that the records are in descending order as per the selected field in the drop-down box.

  5. Generate Report: This is used to generate the current report in PDF/Word/Excel/Excel Raw formats.

    1. In Format, select the type of format you want.

    2. Click Generate Report.

  6. Once you get the search results, click the Quick Info icon to view important information of the respective Equipment on the quick information window.

  7. Click the Real-time Values icon, to view the Point details associated with respective Equipment’s real-time monitoring. For details on Equipment Real-Time Values page go to Equipment Real-Time Values page section.

  8. Click the Real-time GUI icon to view the real-time graphical user interface of the respective Equipment.

  9. System Pages icon opens a pop-up window with a list of associated System Pages.

    1. Click name of System Page to go to the respective System page’s detailed page.

    2. System GUI icon opens the GUI page of the System. System GUI icon will be visible only if the System has an uploaded GUI page.

  10. To navigate to Equipment detail page:

    1. Click the name of the Equipment or

    2. Click the quick info icon of the respective Equipment to get the quick info window. The click on the required Equipment name on the quick information window, to go to its detailed page.

Note –If no Real-Time GUI page is uploaded for a selected Equipment, Real-Time GUI icon will not be displayed, which gives a link to the respective Real-time GUI page.

View Equipment Details

Equipment’s detail page consists of 5 tabs.

  1. Details tab: Allows you to make changes to Equipment details

  2. Points tab: Shows the Equipment Point details

  3. Links tab: Shows links from the respective Equipment to any other such as system pages, URL, etc.

  4. Alarms tab: All the Alarms associated with Equipment Points (including Point Template name, Alarm Date Time, Cleared Date Time (if Alarm is already cleared), Alarm Class and Alarm Message) will be listed under the Alarms tab.

    1. Go to Equipment Details page🡪Alarms tab, click on an Alarm to go to its ‘Alarm Details’ page.

      1. Alarm tab – displays general details of the selected Alarm

      2. Transactions tab – displays all transactions related to the Alarm

      3. CWO tab –

      4. Incidents tab –

      5. Operator Notes tab – displays Operator Notes entered for the Alarm

      6. Assignees tab – displays the Alarm’s Assignees details

  5. Trend tab: Shows Trend Data of interested points of the Equipment.

This is explained under Register New Equipment section.

Note: When modifications in configurations (e.g. equipment is disabled, point properties are changed, alarm/trend properties changed ) happen in the following areas, an exclamation mark will be displayed next to the respective point/points in the App, until the configurations are downloaded to SSIF.

  • Equipment Details tab >> Alarm Configuration >>

  • Equipment Details tab >>Details Section >> Disable/ enable sub system communication

  • View >> Point template>> Trend and Alarm related modifications

  • View >> Equipment >> Select Point >>Point, Trend and Alarm related modifications

e.g. If Subsystem Communication is disabled for an equipment with 5 points, exclamation marks will be displayed for all the points of the equipment.

Note –If SSIF is inactive for a point, you will not see an exclamation mark.

Equipment - Details Tab

Details tab allows you to edit Equipment details and provides the links to the following. The right pane on the Details tab provides links to the following;

Equipment - Points Tab Points Tab

This section shows the configured Subsystem points and allows user to edit the configured subsystem point details.

Points Points section shows the Subsystem points and the following details of the configured points:

  • Point name

  • Point Description

  • Point Address

  • Point Status – Enabled or Disabled

    • Point Enabled: Enabled means in each poll cycle, SSIF will read the point for a new value.

    • Point Disabled: Data would not be polled for the respective point.

  • Alarm enabled or not

    • This icon denotes that the respective Alarm is enabled

    • This icon denotes that the respective Alarm is disabled

  • Trend enabled or not

    • This icon denotes that the respective Trend is enabled

    • This icon denotes that the respective Trend is disabled

  • Edit icon - Clicking on Edit icon will open the respective Point’s Point Details page which lets you edit the details of the selected Point. Selected Point’s name will be displayed on the top of the “Point Details” point configuration page.

To search for a specific Point, type the name of the Point in the Search Points box. Points will be filtered according to the entered Point name.

Disable Alarms of all Points in a Selected Equipment

To disable all the alarms of points in a selected Equipment at once;

  1. Click the Settings icon on the Home page and select Equipment under View section. Equipment Search page will appear.

  2. Click the name of the equipment you require to go to its detail page.

  3. Under the Details tab, go to the Alarm Configuration section.

  4. Click the Edit icon that appears.

  5. Select Disable All Alarms check box. It will disable all the alarms of Points associated with the respective equipment.

To Enable or Disable Alarm/Trend of a Single Point

This function will help you to override the global alarm/trend status of points of equipment. This helps to enable or disable an alarm/trend of a single point by overriding the global status.

To enable/disable alarm or trend of a point;

  1. Click the Settings icon on the Home page and select Equipment under View section. Equipment Search page will appear.

  2. Click the name of the equipment you require to go to its detail page.

  3. Under the Points tab, select the Point you want and click the Edit icon . Point Details page will appear.

  4. To Enable/Disable Point Status

    1. To enable point status, select the Enabled check box.

    2. To disable point status, deselect the Enabled check box.

  5. Enable/Disable Alarm

    1. To enable alarm, select the Enable Alarm check box.

    2. To disable alarm, deselect the Enable Alarm check box.

  6. Enable/Disable Trend

    1. To enable trend, select the Enable Trend check box.

    2. To disable alarm, deselect the Enable Trend check box.

  7. Click Update.

Equipment- Real-Time Values Page

To view Equipment Real-Time Values page, which shows real-time points with its present values;

  1. Click the Settings icon and select Equipment under View section. Equipment Search page will appear.

  2. To go to the Real-Time Values page of Equipment;

    1. Click on the required Equipment name to go to the detail page of the required equipment and click the Real-Time Values link on the Side bar on the Details tab. Real-Time values page will show the details of already configured Subsystem Points. Or

    2. On the Equipment Search page, click the Real-Time Values icon. Or

    3. Go to View🡪Points🡪 Point Detail page🡪Details tab🡪 Real-Time Values link on the Side bar.

  3. Subsystem Points : The following details of Subsystem points will be displayed;

    • Alarm Status: Denotes when a Point is in an Alarmed status

    • Point : Name of the Subsystem point

    • Point Description: A description about the Point

      Setting under App Configuration If the check box “Merge Point name and Point Description in Real-Time value page” under Manage🡪App Configuration🡪General is selected, Point Name and Point Description will be displayed one after the other in one column. To have two columns for Point name and Point Description, deselect the check box.

    • : This green icon shows that the respective Point is online.

    • : This red icon shows that the respective Point is offline.

    • : This grey icon shows that the respective Point is expired. When a point is expired, no data appear on Real-Time GUI page.

    • Value: The value of the Point displayed at the last updated time. The Value is editable.

    • : After entering a new Value manually for the Point, ‘Set’ button should be clicked to write the new value. A window will pop up to enter comments.

      Setting under App Configuration A window to enter comments will pop up after the ‘Set’ button is clicked. The comment box will appear ONLY if the “Comment required for write commands” check box is selected under the General section of App Configuration” page (Settings🡪Manage🡪App Configuration).

    • : Reset button will be displayed if Reset value is configured under Point detail page🡪 Details tab🡪 Reset Value Configuration section. This Reset button is used to apply the default value (reset value) to the respective Point.

    • Point Write History icon: This icon shows that the Value of the respective Point has been manually overridden. Icon will be red when the Value of the Point is changed manually.

    • Icon denotes that the Point value is not manually overridden. The icon opens a pop-up window which shows the point value overridden details.

      • Manually Overridden by: Shows the name of the user who manually changed the Value of the Point

      • Previous Value: This shows the previous Point Value

      • Reset Value: The default value of Point

      • History link: Opens the Point Write History page

    • Unit: Unit of the Point

    • Updated Time: The last time stamp of the time that the value was read from the respective point.

    • Alarm (Yes): Alarm –Yes means that you have enabled alarms for the respective Point.

    • Trend (Yes): Trend – Yes means that you have enabled trends for the respective Point.

    • Advanced Point Configuration (…): Click the icon to open the Advance Point Configuration page of the respective Point.

    • : Click to enable auto refresh alarms feature on Real-Time Point Value page.

    • : This shows that the Auto refresh feature has been enabled. Click to disable auto refresh alarms feature on Real-Time Point Value page.

    • Hard Refresh: Click this icon to clear cache in Subsystem Interface.

    • : On Real-Time Point Value page of Equipment, an exclamation icon will appear in front of Point name, if the respective Point configuration is modified by the user and the new Point configuration has not been downloaded by the SSIF. Clicking on the icon pops up a Quick Info page with related details. (See the screen below)

Note –If the Equipment is offline due to a failure in SSIF, exclamation marks in red will be displayed. Mouse hover Tooltip text will be displayed stating ‘There is a communication failure between iviva and Subsystem Interface'.

Note –If you try to set Point value for an offline Equipment Point on Real-Time Values page using Set command, a pop-up message will appear to state that the Point is offline.

: This button on the Equipment Real-Time Values page opens the Real-Time GUI page of the respective Equipment.

: System Pages button on the Equipment Real-Time Values page opens a pop-up page which lists the Systems related to the respective Equipment.

  • System Name navigates to System Real-Time Values page

  • System GUI icon navigates to System Real-Time GUI page. This icon will be visible only when System has an uploaded GUI page.

Equipment - Real-Time GUI Page

If a GUI page is configured for Equipment, it can be viewed.

To view real-time GUI of the Equipment;

  1. To go to the Real-Time GUI page,

    1. On the Equipment Search page, click the Real-time GUI icon of the required Equipment. Or

    2. Go to the detailed page of the required Equipment🡪Details tab and click the Real-Time GUI link on the Side bar. Or

    3. Go to View🡪Points🡪 Point Detail page🡪Details tab🡪 Real-Time GUI link on the Side bar.

  2. Right-click on a Point to open the popup window with the following links:

    1. Equipment Details –This link opens the respective Equipment’s detail page.

    2. Point Alarm History –This link opens the respective Point Alarm History page.

    3. Point Write History –This link opens the Point Write History page.

    4. Reset –This link will reset the point value. If point is offline, it will display error message.

    5. Point Configuration –This link opens the respective Point’s Configuration page. Point Configuration page allows to update the following;

      • General details related to the selected Point

      • Point Properties

      • States text

      • Trend related data

      • Alarm related configuration including Add new alarm, priority

      • Hover over a point cell to see the Tooltip which contains the details related to the selected Point such as Equipment, Point name, Value, States text, Unit, Address, Error, etc.

Note –If you try to set Point value for an offline Equipment Point on Real-Time GUI page using Set command, a pop-up message will appear to state that the Point is offline.

Note –If the Equipment is offline due to a failure in SSIF, the following will be displayed on GUI page;

Exclamation marks in red will be displayed.

Mouse hover Tooltip text will be displayed stating “Error There is a communication failure between iviva and Subsystem Interface”.

Full View icon

Click to go to the full view of the Real-Time GUI page. To go back to the normal view, click the icon at the top right corner.

Navigates to the Real-Time GUI Values page of the Equipment.

Opens a pop-up window with System Pages of the respective Equipment. System Name navigates to System Real-Time Values page System GUI icon navigates to System Real-Time GUI page. This icon will be visible only when System has an uploaded GUI page.

Override Point Values Manually on Real-Time GUI Page

Note –To write Values to Points and override Point Values manually, the following prerequisites should be available;

Point’s Read/Write status should be ‘Write’ (Point detail page🡪Details tab🡪 Properties section)

Point’s “Reset Value Configuration” (Point detail page🡪Details tab🡪 Reset Value Configuration section. Availability of Reset Value Configured Points

  1. On the Real-Time GUI page, type in a value for Equipment Point in the given box and click Set. Once the Set button is clicked, a popup window to enter Comment will appear, if the relevant setting is configured under Manage🡪App Configuration.

Setting under App Configuration A window to enter comments will pop up after the ‘Set’ button is clicked. The comment box will appear ONLY if the “Comment required for write commands” check box is selected under the General section of App Configuration_” page. (Settings🡪Manage🡪 App Configuration)

Delete Equipment

To delete Equipment;

  1. Go to the detailed page of the required Equipment.

  2. Click the Details tab.

  3. Click the Delete this Equipment link or Delete icon on the side bar.

  4. Confirmation message will appear. Click Delete to confirm deletion. You cannot delete equipment that are in use.

View Systems

Systems are useful when there is a requirement to show data from two or more Equipment on a single GUI page or on a report.

Path Settings icon🡪 View section🡪 Systems

Or App Home page🡪 Systems tab

  1. Click the Settings icon and select Systems under View section. Systems Search page will appear.

  2. Type the name of the System in to the Search Systems input box to search for the System desired.

  3. Refine search using given Search filters;

    1. Location: Clear the current location by pressing. You will observe that all the Systems are displaying. Click on the Location text box and type in a new location to filer or select one from the drop-down list.

    2. System Type: If you need to filter the Systems by System Type, select the required System Type from the drop-down box.

    3. Alarmed Systems: Selecting the Alarmed Systems check box will further filter the Systems at the above Location to only display the ones that are in an alarmed status.

  4. Once you get the search results, click the Quick Info icon to view important information of the respective System on the quick information window. Click the System Name to go to its detailed page.

  5. Real-Time Values icon: Click to go to the respective System’s Real-Time Values page.

  6. Real-Time GUI icon: This icon will be displayed only there is an uploaded Real-Time GUI page for the respective System. Click on it to go to the Real-Time GUI page of the respective System.

  7. Click on the required System name to go to its detailed page.

  8. Generate Report: This is used to generate the current report in PDF/Word/Excel/Excel Raw formats based on the filtered results.

    1. In the Format box, select the type of format you want.

    2. Click Generate Report.

System Real-Time Values Page

To view real-time points of a System with its present values and time stamps of the last data retrieval time;

  1. On the System Search page, click the respective Real-Time Values icon. Or go to the detailed page of the required System. Click the Details tab and click the Real-Time Values link on the Side bar.

The following details will be shown for System’s each Subsystem Point.

Feature

Description

Denotes the Status of Alarm. If System Point has an Alarm, red bell icon will be displayed.

This icon denotes that there is a communication failure between iviva and Subsystem Interface.

<Equipment Name>

Equipment of System Point. Clicking on it opens the detailed page of Equipment.

<Point>

Real-time Subsystem Point name. Clicking on it opens the detailed page of Point.

Point Description

Description about the Point

Denotes that the respective Point is offline

Denotes that the respective Point is online

Text box

Use to enter the new Value manually for the respective Point

After entering a new Value manually for the Point, ‘Set’ button should be clicked to write the new value. A window will pop up to enter comments.

Note –If you try to set Point value for an offline Point on a System Real-Time Values page using Set command, a pop-up message will appear to state that the Point is offline.

Reset button will be displayed if Reset value is configured under Point detail page🡪 Details tab🡪 Reset Value Configuration section. This Reset button is used to apply the default value (reset value) to the respective Point.

Point Write History

Shows that the Value of the respective Point has been manually overridden. Icon will be red when the Value of the Point is changed manually.

The icon opens a pop-up window which shows the point value overridden details.

  • Manually Overridden by: Shows the name of the user who manually changed the Value of the Point

  • Previous Value: This shows the previous Point Value

  • Reset Value: The default value of Point

  • History link : Opens the Point Write History page

This icon denotes that the Point value is not manually overridden.

Unit

Unit of the Point

Updated Time

The last time stamp of the time that the value was read from the respective point.

Point Configuration

Opens the respective Point’s Configuration page

Historical Trend

Opens the Historical Trend tab on the respective Point’s detail page

Alarm History

Opens the Alarm History tab on the respective Point’s detail page

Auto Refresh -disabled

Click to enable auto refresh alarms feature on Real-Time Value page.

Auto Refresh -enabled

This shows that the Auto refresh feature has been enabled. Click to disable auto refresh alarms feature on Real-Time Point Value page.

Hard Refresh

Click this icon to clear cache in Subsystem Interface.

Click to open the System’s Real-Time GUI page.

Opens a pop-up window, which lists all Equipment associated with the System

  • Equipment Name opens Equipment’s Real-Time Value page

  • Equipment GUI icon opens the Real-Time GUI page of Equipment. The icon will be visible only if the Equipment Template has an uploaded GUI page.

Setting under App Configuration A window to enter comments will pop up after the ‘Set’ button is clicked. This window will appear ONLY if the “Comment required for write commands” check box is selected under the General section of App Configuration” page (Settings🡪Manage🡪 App Configuration).

System Real-Time GUI Page

  1. On the System Search page, click the respective Real-Time GUI icon. Or go to the detailed page of the required System. Go to the Details tab and click the Real-Time GUI link on the Side bar.

  2. On the Real-Time GUI page, enter the relevant point value to override the current value and click Set. A window will pop up to enter comments.

    Setting under App Configuration A window to enter comments will pop up after the ‘Set’ button is clicked. The comment box will appear ONLY if the “Comment required for write commands” check box is selected under the General section of App Configuration” page (Settings🡪Manage🡪 App Configuration).

  3. Right click on the Point Values on the GUI page. A popup window will appear with some links. The links will populate according to the status of the respective Point.

    • Equipment Details link : Opens the respective Equipment detail page

    • Real-Time Values link: Opens the respective Equipment’s Real-Time Value page

    • Point Alarm History link: Opens the respective Point’s Alarm History tab on Point Detail page

    • Point Write History: Opens the respective Point’s Point Write History page

    • Reset link: Allows to reset the Point Value, if the Point is online.

    • Point Configuration link. Opens the respective Point’s Point Configuration page

Full View icon

Click to go to the full view of the Real-Time GUI page. To go back to the normal view, click the icon at the top right corner.

Navigates to the Real-Time GUI Values page of the System.

Opens a pop-up window which lists Equipment of the respective System. Equipment Name navigates to Equipment Real-Time Values page Equipment GUI icon navigates to Equipment Real-Time GUI page. This icon will be visible only if Equipment has an uploaded GUI page.

Note –If you try to set Point value for an offline Point on a System Real-Time GUI page using Set command, a pop-up message will appear to state that the Point is offline.

Delete System

To delete a System;

  1. Click the Systems link under the View section on the Settings menu.

  2. Search for the required System and click on the System name to go to its detailed page.

  3. On the Details tab, click the Delete this System link or the Delete icon on the side bar.

  4. Confirmation message will appear. Click Delete to confirm. You will not be able to delete the Systems in use.

View Configured Subsystem Points

  1. Click the Systems link under the View section on the Settings menu.

  2. Search for the required System and click on the System name to go to its detailed page.

  3. Go to the Points tab.

  4. Subsystem Point Search

    • In the Search Points box, type the required Equipment name or part of it. Points will be filtered by the typed Equipment name.

    • In the Search Points box, type the required Point name or part of it. Points will be filtered by the typed Point Name.

View Dashboards

‘View Dashboards’ navigates to the Dashboard Search page. Preconfigured Dashboards will be listed and can be filtered using the given search filters.

Path Settings icon🡪 View section🡪 Dashboards

  1. Click the Settings icon and select Dashboards under View section. Dashboards Search page will appear.

  2. Type the name of the Dashboard in to the Search Dashboards input box to search for the Dashboard desired.

  3. Use the Location search filter to filter by Location.

  4. Search results can be sorted by ascending or descending order of Dashboard Name/Location.

    1. Select the field used to sort the results by. (Dashboard name or Location).

    2. Click the toggle icon to sort the records in ascending or descending order accordingly.

  5. To generate a report of the filtered Dashboards in selected format (PDF/Word/ Excel/Excel-Raw), select the Format and click Generate Report.

View Points

View Points allows you to view the Configured Points in the application. Points can be filtered for a particular location and the Equipment it belongs to.

Path Settings icon🡪 View section🡪 Points

  1. Click the Settings icon and select Points under View section. Points Search page will appear.

  2. Type the name of the Point in to the Search Points input box to search for the Point desired.

  3. Refine search using given Search filters;

    1. Location: Clear the current location by pressing. You will observe that all the Points are displaying. Click on the Location text box and type in a new location to filter or select one from the drop-down list.

    2. Equipment Template: Click on the Equipment Template text and type in a new Equipment Template name or select one from the drop-down list. This will further filter the points by Equipment Template.

    3. Equipment: Click on the Equipment text and type in a new Equipment name or select one from the drop-down list. This will further filter the points by Equipment.

    4. Interface: Click on the Interface text and type in a new Interface name or select one from the drop-down list. This will further filter the points by Interface.

    5. Data Type: Used to filter the Points based on the Data Type of the Points.

      By default, the Points search page shows the Points without filtering based on Alarm Enabled/Disabled, Trend Enabled/Disabled or Value Subscription Enabled/Disabled. You can select the given check boxes to filter Points accordingly. Note: Alarm Enabled/Disabled, Trend Enabled/Disabled and Value Subscription Enabled/Disabled features are described under the ‘Details tab on the Point Details page” section below.

  4. Historical Trend icon opens the Historical Trend tab on the Point detail page of the respective Point.

  5. Alarm History icon opens the Alarm History tab on the Point detail page of the respective Point.

  6. Quick Info icon opens the pop-up window with the important features of the respective Point.

  7. Click on the required Point name to go to its detailed page.

  8. Details tab shows the important details of the respective Point along with its alarm and trend details.

  9. On the Point Detail page, click the Alarm History tab to view the alarms generated by the point.

    1. Alarms can be filtered by Start Time –End Time, Alarm Class and Alarm Severity.

    2. To generate reports in PDF/Word/Excel/Excel Raw formats, select the required report format and click Generate Report.

  10. Click the Historical Trend tab to view trend history.

  11. Click the Real Time Trend tab to view the graphical representation of real time trend. This will be refreshed automatically with the current values.

Point Details Page

Detail page of a Point has the following tabs;

  1. Details tab

  2. Alarm History Tab

  3. Historical Trend Tab

  4. Real Time Trend Tab

  5. Write History – This tab will be visible only for the Points with ‘Write’ state.

  6. States Text Details – Only for Binary and Multi-State Points

  7. Subsystem Event History Tab – This tab will be visible only for BACnet Controller Points.

Details Tab on Point Details Page

Section on Details Tab

Details

Shows the details of the respective Point. Clicking on the Edit icon allows user to edit the Point details. Note: You can select the “Disable comments in Command” checkbox to disable the requirement of comments when resetting Point Values (e.g. On Real-time GUI page, etc.)

Properties

Shows the properties of the respective Point. Clicking on the Edit icon allows user to edit the Point Properties.

Reset Value Configuration

This section is to enter the consultant recommended default Point value. When resetting, the current Point Value will be reset by the Value entered under this. The section captures the User who configured the Value, Date/Time and the previous Point Value and display under this section.

Trend

This section shows the trend details of the respective Point. Clicking the Edit icon allows user to edit the trend details.

Alarm

This section shows the alarm details of the respective Point.

Alarm Instructions

Alarm Instructions added under this section will be displayed in the respective Alarm’s Operator Note window.

Details Section on Details Tab

Type: On the Edit mode of Point Detail page, you get 3 options (Subsystem, Calculated and Custom) in the ‘Type’ box to select the relevant Point Type.

“Disable Comments in Command” checkbox

You can select the “Disable comments in Command” checkbox to disable the requirement of comments when resetting Point Values (e.g. On Real-time GUI page, etc.)

App Configuration has a setting named “Comment required for Write commands”. If this checkbox is selected, you need to enter Comment, whenever a point value is reset manually on Real-time value pages and Real-time GUI pages. Since this is a global configuration, this setting will be applied to all the Points associated with “Write” commands. “Disable Comments in Command” checkbox on Point detail page🡪Details tab, can override the above Global configuration and disable the Comment popup when Point value is reset.

Note –“Disable Comments in Command” checkbox will be available on Point Detail page, only for the ‘Writable Points’ (Read/ Write State = Write). This checkbox is not available for “Read Only” Points.

Alarm Enable checkbox – If Alarm is disabled (if the checkbox is not selected), and if there are no Alarms, the Alarm History tab on the Point detail page will be hidden.

Trend Enable checkbox – If Trend is disabled (if the checkbox is not selected), and if there are no trends, the Real Time Trend tab will be hidden.

Point Enable – If the respective Point is disabled, Point communication will not happen.

Enable Value Subscription - If enabled, SSIF will update the respective point value (RT value) frequently based on its polling frequency. Users are allowed to enable or disable this checkbox according to their requirement. Purpose of this feature is to update the database frequently which helps to return real-time point data when API calls or Lucy models request data from SSIF. Enable Trigger Event for Value Changes –This option will be displayed only if Enable Value Subscription is enabled in point details. If Enable Trigger Event for Value Changes option is enabled, SSIF will send that flag with value changes to trigger an event in Lucy.

Enable Override –

Alarm History Tab on Point Details Page

All the alarms associated with the respective Point will be displayed under the Alarm History tab on the Point Details page.

Note: If the Alarm Enable check box is not selected (Alarm is disabled) and if there are no Alarms, the Alarm History tab on the Point detail page will be hidden.

Use the filters on the right side panel to filter alarms as required (e.g. Alarm Class).

Group by Date: If you enable this filter, it will group alarms by Today Alarms, Yesterday Alarms and Older Alarms in the alarm history.

Generate Report: This is used to generate the current report for point alarm history in PDF/Word/Excel/Excel Raw formats.

  1. In the Format box, select the type of format you want.

  2. Click Generate Report.

Historical Trend Tab

Historical Trends associated with the respective Point will be displayed under this tab.

Real-Time Trend Tab

Real- Time trends of the respective Point will be displayed under this tab.

Note: If the Trend Enable check box is not selected (Trend is disabled) and if there are no real-time trends, the Real Time Trend tab on the Point detail page will be hidden.

Write History Tab

Points with ‘Write’ state will have an extra tab named ‘Write History’ on Point Detail page.

Write History tab will display the previous Write- values of the respective Point and the details related to it.

States Texts Details

Binary and Multi-State Points will have a tab named ‘States Text Details’. This is used to configure the properties of the States which are displayed on RT pages.

To configure State Texts;

  1. Configure State Text Display Format

    States Text Display Format: This field is used to configure the format of the State text displayed on RT pages.

    Under State Text Configuration Section,

    1. Click the Edit icon and select the required format of the State text from the State Texts Display Format box.

    2. Click Save.

  2. Configure a new State Text

    Under State Text section,

    1. Click the Add icon to open the State Text configuration window

    2. In the State Text Value box, type the value of the State.

    3. In the State Text box, type the text to show the State. E.g. ON

    4. Click Add.

  3. Enable States Text

    1. Under State Text Configuration section, Click the Edit icon.

    2. Select the Enable States Text check box, to enable State Text feature.

    3. Click Save.

State Text Display Format
Description
E.g.

Value Only

Only the value of the State displayed

1

Text Only

State will be displayed as a text

ON, OFF

Value and Text

First Value and then Text will be displayed

1 ON

Text and Value

First Text and then Value of the State will be displayed

ON 1

Note – If you need to disable the State Text Feature, clear the Enable States Text check box.

Subsystem Event History tab

This tab will be displayed only on the detail page of BACnet Controller Points.

The alarm event history details of BACnet controller based alarms will be displayed on this tab.

Add Alarms at Point Level

  1. Go to the Point Search page and click the required Point name to go to its detailed page.

  2. On the Details tab, go to the Alarm section.

  3. Click the Add icon to go to the Add Alarm window.

  4. Follow the ‘’Add Alarm to Point Template” section for details on Adding an Alarm.

Change Alarm Severity at Point Level

This allows you to override the Alarm Severity configured at Point Template level and have a different Alarm Severity for the selected Point/Points at Point level.

  1. Go to the Point Search page and click the required Point name to go to its detailed page.

  2. On the Details tab, go to the Alarm section.

  3. Select the Alarm you need and click the respective Edit icon.

  4. Enter the data as required.

  5. Select the Disable checkbox to disable the alarm.

  6. Select Disable Alarm Escalation checkbox to stop alarm getting escalated and sending escalation messages to users.

  7. Click Update to save the changes.

View Point Templates

Path Settings icon🡪 View section🡪 Point Templates

  1. Click the Settings icon and select Point Templates under View section. Point Templates Search page will appear.

  2. Use the Search Point Templates search box on the top to filter required point templates.

  3. To view point templates for a selected Equipment template, use the Equipment Template filter box on the right-side panel.

  4. Generate Report: This is used to generate the current report in PDF/Word/Excel/Excel Raw formats based on the filtered point templates.

    1. In the Format box, select the type of format you want.

    2. Click Generate Report.

  5. Click a point template name to open its detail page.

  6. If you need to edit details of the Point Template, click the Edit icon on relevant sections on Details tab.

For more details on editing a Point Template, please refer to Edit Point Template section.

Note –Alarms and Trends can be enabled or disabled only after the Points get added to the IBMS Points and respective Point Template is used.

Enable/Disable Alarms

  1. Go to the detail page of the required Point Template.

  2. Go to the Alarm section🡪Alarm Status. Current status of the alarm (Enabled or Disabled) will be displayed.

  3. Select the Alarm you want and click the Edit icon. Update an Alarm page appears.

    1. To Disable Alarm: Select the Disable checkbox to disable the respective alarm.

    2. To Enable Alarm: If Alarm is not enabled (disabled), you will see a text named Disabled under Alarm Status. Click the Edit icon . Update an Alarm page appears. Deselect the Disable check box and click Update.

Note –Once an Alarm in a Point Template is disabled, respective alarm associated with all the points in the point template will be cancelled and removed from the following;

Alarm will be removed from;

  • Alarm Viewer

  • Alarm Bell

  • Weblets

Enabling/ Disabling alarms in Point Template will affect all the points in the respective Point Template. If you need to override alarm status of a selected Point in a Point Template it can be done under View🡪Equipment🡪Equipment Detail Page🡪Points Tab🡪Edit Point🡪 Point Details page.

  1. Go to the detail page of the required Point Template. (Settings🡪View🡪Point Templates)

  2. Select the Point Template you want and click to go to its detail page.

  3. Go to the side bar on the right.

    1. Disable Trend: If Trend is already enabled, a link named Disable Trend will be displayed on the right side bar, under Trends. Click Disable Trend link. A confirmation message pops up. Click Ok to disable all the trends of all equipment associated with the selected Point Template.

    2. Enable Trend: If Trend is not enabled, you will see a link named Enable Trend under Trends section, on the right-side bar. Click Enable Trend link to enable the respective Trend.

Note –Enabling/ Disabling Trends will be applied to all equipment associated with the respective Point Template.

Path Settings icon🡪 View section🡪 Link Templates

  1. Click the Settings icon and select Link Templates under View section. Link Templates Search page will appear.

  2. Use the Search Link Templates search box on the top to filter required Link templates.

  3. To view Link templates for a selected Equipment template, use the Equipment Template filter box on the right-side panel.

  4. Generate Report: This is used to generate the current report in PDF/Word/Excel/Excel Raw formats.

    1. In the Format box, select the type of format you want.

    2. Click Generate Report.

  5. Click a Link template name to open the detailed page.

This describes how to view Trends of Equipment points/ System Points. This Trend search first allows you to filter the equipment trend points or System trend points using the following search criteria.

Path Settings icon🡪 View section🡪 Trends

Or App Home page🡪 Trends tab

  • Click the Equipment check box to filter only the Equipment with trends.

  • Click the System check box to filter only the Systems with trends.

  • You can also filter trends using Site and Location options.

Search for Required Trend Equipment/Systems

First you need to find the required Equipment/System(s) of which you need to view trends. The system allows you to view Historical Trends and Real-Time Trends of the selected trend Equipment or System.

To view the required Equipment or System(s) which have Trends;

  1. Click the Settings icon and select Trends under View section. Trend Search page will appear. (or go to the Trends tab on the App home page)

  2. Use the given search criteria to filter Equipment/ Systems (that have trends) as required.

  3. Click the Quick Info icon of a Trend, to view the main information of the selected Trend. A pop-up window will appear with the information of the respective Trend.

  4. Generate Report: This is used to generate the current report in PDF/Word/Excel/Excel Raw formats.

    1. In the Format box, select the type of format you want.

    2. Click Generate Report.

Historical data of Equipment/ System is recorded based on the change of Point values or based on configured elapsed time.

To view Historical Trends of Equipment/Systems;

  1. On the Trend Search page, click the required Equipment or System name in the search results, to open the historical trend view of the respective Equipment / System. Trend tab will be opened showing the historical trends.

Select All check box: On Equipment, System and Trend Group charts, Select All check box is displayed to select/deselect all the points shown on the chart. When the chart is refreshed, only the points that are currently selected will be refreshed.

Filter Historical Data

Use the filter to filter as per the trend duration.

To filter trends by trend duration;

  1. Click the Filter icon .

  2. Set date range to filter Trends for a selected date range.

    1. Under From Date Time, click Calendar icon and select the start date that you want to start plotting data. Click the Clock icon and select the start time to plot data.

    2. Under To Date Time, click Calendar icon and select the end date that you want to stop plotting data. Click the Clock icon and select the end time to stop plotting data.

    3. c. Click Apply Filter for Graph to plot the graph based on the time range selected.

Generate Reports

Filtered Trend Data can be exported to PDF, Word, Excel, Excel-Raw formats and view as reports.

  1. Click the Filter icon and select the appropriate time range.

  2. Click the drop-down box under the text Format.

  3. Select the type of format you need.

  4. Click Generate Report.

Real-time trending functionality is found in the trend charts, where users can view real-time trend values of Equipment/System. The system opens Real-Time trends on a pop-up page or on a Full page view.

  1. Click the Settings icon and select Trends under View section. Trend Search page will appear.

  2. Use the given search criteria to filter the Equipment/System points (that have trends) as required.

  3. Real-Time Trend Full view

    • Click the Full View icon of the required Equipment/System to view the Real-Time trends on a full page; Or

    • Click the icon on the Real-Time Trend pop-up view to go to the Full View of Real-Time Trend page.

  4. Real-Time Trend pop-up view:

    • Click the name of the required Equipment/System on the Trend Search page to go the Historical Trend page.

    • On the Historical Trend page, click the Real Time Trends link on the top right corner to see the Real-Time Trend pop-up view.

    • Turn On/ Off OnDemand Data refresh feature: User is allowed to On/Off OnDemad Data fresh

      • icon shows that the Auto Refresh feature is ON (OnDemand Data refresh is On).

      • To OFF the OnDemand Data refresh feature, click the icon.

      • icon shows that the OnDemand Data Refresh feature is Off (Disabled). Click it to ON the Auto Refresh feature.

Trend Chart Other Options

The following functionalities can be used in Real-Time and Historical Trend Charts.

  1. Zoom Trend Charts

    Built-in Pan and Zoom functionality is found in Trend charts. To zoom-in a Trend chart along with X axis which has Trend Time periods;

    • Click on the chart with mouse pointer and drag out a rectangle in the chart.

    • To undo all the zooming steps, click Reset Zoom.

  2. Print Charts

    To print a chart;

    • Click the Chart Context menu and select Print chart menu option.

  3. Download PNG/JPEG/SVG Vector image/PDF document

    • Click the Chart Context menu and select the required option.

View Trend Groups

A Trend Group is a collection of Trend Points with same unit of measurement. View->Trend Groups allows you to view configured Trend Groups. All the points on a Trend Group will be plotted on a single chart. It will give you the ability to select which points to be plotted selectively, zoom in and out of sections of trends, select the end date and time, etc.

Path Settings icon🡪 View section🡪 Trend Groups

Or App Home page🡪 Trends Groups tab

  1. Click the Settings icon and select Trend Groups under View section. Trend Groups Search page will appear.

  2. Select the required Site from the Site drop-down box.

  3. Select the Location for which you want to see the Trend Groups for;

    1. Clear the current Location by clicking. You will observe that all the Trend Groups are displaying.

    2. Click Location text box and type in a new location to filter or select one from the drop-down list.

  4. To filter by the User who created the Trend Group, select the required User from the Created By box.

  5. Trend Groups will be listed according to the filters used. Click the Quick Info icon of a Trend Group, to view the main information of the selected Trend Group. A quick information window will appear with the information of the respective Trend Group.

  6. Generate Report: This is used to generate the current report in PDF/Word/Excel/Excel Raw formats based on the filtered Trend Groups.

    1. In the Format box, select the type of format you want.

    2. Click Generate Report.

  1. Click the Settings icon and select Trend Groups under View section. Trend Groups Search page will appear.

  2. Search for the required Trend Group using the given filters.

  3. Click on the required Trend Group name to view the Trends plotted on a chart. By default, all Trend Points in a Trend Group are plotted on the chart.

  4. Filter Trend data as required.

    1. Click the Filter icon.

    2. Set date range to filter Trend for a selected date range.

      1. Under From Date Time, click Calendar icon and select the start date that you want to start plotting data. Click the Clock icon and select the start time to plot data.

      2. Under To Date Time, click Calendar icon and select the end date that you want to stop plotting data. Click the Clock icon and select the end time to stop plotting data.

      3. Click Apply Filter for Graph to plot the graph based on the time range selected.

  5. To view data plotted only for a particular point, click the unwanted trend point to remove them from display area.

    e.g. Point 2 trend data have been removed from the data plot

  6. Hover over trend points on the chart to see the value of the point in a tooltip.

  7. Generate Report: Filtered Trend Data can be exported to PDF, Word, Excel, Excel-Raw formats and view as reports.

    1. Click the Filter icon and select the appropriate time range.

    2. Click the drop-down box under the text Format.

    3. Select the type of format you need.

    4. Click Generate Report.

View Alarms and Alarm History

This section describes how to view and attend to Alarms and how to view alarm history. The section consists of the following sub topics.

Path Settings icon🡪 View section🡪 Alarms

Or App Home page🡪 Alarms tab

Alarm Search is used to search for alarms using the given search criteria and to view alarms.

  1. Click the Settings icon and click the Alarms link under View section or go to Alarms tab on the App Home page.

  2. To filter the alarms by a location;

    1. In the Location box, clear the current location by clicking. Click on the Location text box and type in a new location to filter or select one from the drop-down list.

  3. In the Alarm Class box, select the required Alarm Class or multiple Alarm Classes to filter Alarms by the selected Alarm Class or Alarm Classes.

  4. If you need to view Alarms associated with an Asset Group or multiple Asset Groups, select the required Asset Group or Asset Groups.

  5. In the Alarm Severity box, select the required Alarm Severity or multiple Alarm Severities to filter Alarms by Alarm Severity. Alarm Severity legend shows the respective color codes of severities.

  6. In the Asset Category box, select the required Asset Category to filter alarms associated with Assets of the selected Asset Category.

  7. To filter by a user who acknowledged alarms, select the required user from the Acknowledged by box.

  8. To filter alarms confirmed by a particular user, select the required user from the Confirmed by box.

  9. If you need to filter by Equipment, select the required equipment in the Equipment box.

  10. Use the following filter conditions accordingly.

    1. Show Active Alarms Only: Shows the active alarms

    2. Show Unacknowledged Alarms Only: Shows the alarms, which are unacknowledged.

    3. Show Acknowledged Alarms Only: Shows the acknowledged alarms.

    4. Show Confirmed Alarms Only: Shows the confirmed alarms.

    5. Show Cleared Alarms Only: Shows the alarms that are not in alarmed status and have been cleared.

    6. Show Disabled Alarms Only: Shows the alarms that have been disabled manually. When the active alarms with the status of “Alarm” are disabled manually, their status will be changed to “Cancelled” and will be removed from the weblets & Alarm Viewer as they become cancelled alarms. To see disabled alarms – Select “Show Disabled Alarms Only” check box

    7. Select the Date and Time range to filter the alarms which are alarmed between a given time period.

  11. Sort: Used to sort the search result in ascending or descending order as per the fields given in the drop-down box. Select the required field based on which you need to sort the search records (e.g. Alarm Time field to sort the records as per Alarm Time) and then click the icon accordingly.

    1. : Shows that the records are in ascending order as per the selected field in the drop-down box.

      : Shows that the records are in descending order as per the selected field in the drop-down box.

  12. On the Alarm search page, click the icon of an alarm record, to view the alarm history of the respective alarm.

  13. On the Alarm search page, click the icon to add an Operator note for the particular alarm for the first time.

  14. Alarms with added Operator Notes will be shown with the icon. Click the icon to view/edit Operator note.

  15. Click Equipment name to view Alarms tab of the respective Equipment.

  16. Click Point name to view Alarm History tab of the respective Point.

  17. Click the Alarm icon or Alarm Message to view the respective Alarm details page.

  18. Alarm icon’s color will vary according to the Alarm Severity of the respective Alarm. Alarms of a particular Alarm Severity will display its color which shows the Priority of Alarm. Color is configurable under the Alarm Severity Configuration.

  19. Generate Report: This is used to generate the current report in PDF/Word/Excel/Excel Raw formats.

    1. In the Format box, select the type of report format you want.

    2. Click Generate Report.

Note – Since it is illogical to be able to select both Show Acknowledged Alarms Only and Show Unacknowledged Alarms Only check boxes at the same time, you will notice the following.

  • When you select Show Acknowledged Alarms Only check box, Show Unacknowledged Alarms check box will be invisible.

  • When you select Show Unacknowledged Alarms Only check box, Show Acknowledged Alarms check box will be invisible.

Alarm Details Page

To access the Alarm details page of a selected Alarm;

  1. Go to Alarms Search page and click on the required Alarm icon/ Alarm Message. Or click Alarm Bell 🡪Alarm🡪Alarm detail page.

Alarm Details page consists of the following tabs;

Tab

Description

Alarm

Tab contains 2 sections named General and Confirmation

General: Displays the following general details related to the respective Alarm; Equipment, Point Name, Alarm Class, Alarm Severity, Alarm Message, Alarm Value and Clear Value ( Value when Alarm is cleared)

Confirmation: Displays the details related to alarm confirmation such as User who confirmed the alarm (Confirmed by), Comment and date commented (Commented on).

Alarm Tab’s side bar

  • Alarm Details: Shows the Alarm Status

  • View Map: link to the respective Equipment Alarm map

  • Real-Time Value: link to the Real-Time Value page

  • Real-Time GUI: link to the Real-Time GUI page

  • Send a Message: Use to send alarm related messages to recipients

  • Activities: Activity log related to the alarm

  • Report: Use to generate crystal reports based on the alarm details including alarm transactions. Report format can be PDF/MS Word/ MS Excel.

Transactions

Transactions tab displays the details of alarms that have been triggered. Transaction Time, Point Value and Transaction Message and Alarm Status of particular alarm will be displayed.

CWOs

CWOs tab will be displayed only if the IBMS-CWO bridge app is enabled.

A link named “Register CWO” is found on the Side bar on the right, which allows user to create a CWO for the respective alarm.

Job Cards

Job Card tab will be displayed only if the IBMS-Job Card bridge app is enabled. A link named “Register Corrective Job Card” is found on the Side bar, which allows user to create a Corrective Job Card for the respective alarm.

Incidents

Incident tab will be displayed only if the IBMS-Incident bridge app is enabled.

A link named “Register an Incident” is found on the Side bar on the right, which allows user to register an Incident for the respective alarm.

Operator Notes

Displays the Operator Notes entered by users related to the respective Alarm along with the time (timestamp) for each Operator Note added.

Assignees

Assignees tab on Alarm detail page is used to re-assign alarms and display the users who are assigned to the respective Alarm along with the following details;

  • Assigned Time

  • Assignee

  • Comment

  • Assigned by

Manage Assignees link on the side bar opens Assignee page to add assignees to Alarms.

Note: Re-assigning alarms can be done on Alarm Viewer as well using the Assignee icon .

Attention – CWOs/ Job Cards/Incidents tabs will be displayed only if the respective bridge apps are enabled. If any of these tabs are not displayed, please refer to the iviva Installation Guide’s Prerequisites🡪 iviva Apps 🡪 Bridge Applications section.

Re-Assign Alarms from Alarm Detail Page – Assignee Tab

  1. Go to the Alarm Detail page 🡪Assignee tab.

  2. Click the Manage Assignee link on the side bar. Assignee pop-up will appear.

  3. Click in the Assignee drop-down box and select a User to assign Alarms.

  4. On the Comment box add a comment which is mandatory.

  5. Click Add Assignee. New Assignee record will be displayed bottom of the page along with Assignee, Assigned Time and Comment.

  6. Close the Assignee pop-up page. Assignee record will be displayed under the Assignee tab, including the person who did the assignment. ( Assigned by)

Note: To delete an Assignee, click Manage Assignee link. On the Assignee window, click the Delete button of the respective Assignee which you need to remove from the Assignees tab.

Accessing Equipment Map from Point Detail Page

Point Detail page gives links to respective Real Time GUI page and Real-Time Values page.

Access Real Time GUI page:

  1. Go to Alarm Detail page (View🡪Alarms🡪Alarm Detail page of a selected Alarm🡪Alarm Tab🡪Side Bar.

  2. Click Real Time GUI link on the Side bar on the right.

Access Real Time Values page:

  1. Go to Alarm Detail page (View🡪Alarms🡪Alarm Detail page of a selected Alarm🡪Alarm Tab🡪Side Bar.

  2. Click Real Time Values link on the Side bar on the right.

Alarm Viewer

Alarm Viewer consists of three tabs which help to group the alarms as New Alarms, Acknowledged Alarms and Confirmed Alarms.

Note – Filtered Alarm Count as a fraction Each tab on Alarm Viewer shows the tab name along with the alarm count on the respective tab as a fraction based on the filter used. E.g. 12/25, where 12 is the count of the filtered records shown on the tab and 25 is the total alarms.

  1. Click the Settings icon and select Alarm Viewer under View section. Alarm Viewer page will appear.

  2. Search Alarms box can be used to search for a specific alarm as per Equipment ID, Alarm Message and Point name.

  3. “New Alarms” tab:

    New alarms (alarms that are not acknowledged) generated by Equipment and Systems in diverse locations. (Even alarms that have been cleared before acknowledging will be displayed under New Alarms)

  4. “Acknowledged Alarms” tab:

    Alarms that are acknowledged will be displayed under this tab.

  5. “Confirmed Alarms” tab:

    Alarms that are confirmed by users will be displayed under this tab.

  6. "Alarm Summary” tab:

Alarm Filter

Setting under App Configuration

Filter will be displayed at the top right corner of the New Alarms tab on Alarm Viewer, only if the “Apply filters for New Alarms” check box is selected on App Configuration page.

  1. Use the Filter to filter groups of alarms using Location, Alarm Class, Alarm Severity, Asset Group, Occupant, Unit, Asset Category and alarmed time range etc.

  2. Click the Filter icon.

  3. Use Location search criteria as required.

    1. Clear the current location by clicking.

    2. Click location text box and select a location from the drop-down to filter the alarms for that particular location. You may type in a new location as well.

  4. Use Alarm Class search criteria as required.

    1. By default, "Any" option will be selected. You will observe that all the alarms belonging to different alarm classes for the selected location are displaying.

    2. Click Alarm Class filter and select an Alarm Class or multiple Alarm Classes from the drop-down to filter the alarms for a particular Alarm Class or multiple Alarm Classes.

  5. Use Alarm Severity and Asset Group search criteria as required.

  6. Use Occupant and Unit search criteria as required. These fields help to filter alarms, related to locations occupied by different tenants.

  7. Use Asset Category search criteria as required:

    1. Select the required Asset Category to filter alarms generated for the Assets belong to the respective Asset Category.

  8. Select the Date and Time accordingly to filter the alarms which are alarmed between the required time period. Use Alarmed Between filters.

  9. Select the following filters accordingly

    1. Cleared Alarms Only checkbox – to view only the cleared alarms

    2. Escalated Alarm Only – to view only escalated alarms

    3. Non-Escalated Alarms Only – to view only the alarms which are not escalated

    4. Assigned Alarms Only – to view only the Assigned alarms

    5. Operator Note Added Alarms Only – to view only the Alarms with Operator Notes

    6. Repeated Alarms Only– to view only the Alarms that are repeated

  10. Click Apply to apply the selected search criteria and filter records.

  11. If you need to clear the current filter, click Clear Filter.

Alarm Viewer – GUI details

Feature on Alarm Viewer page
Description

Alarm Time

Time that the alarm triggered

Equipment

The equipment which is associated with the specific alarm. Clicking on Equipment Name will open the respective Quick info window.

Point & Point Description

The point which triggers the specific alarm and its description. Clicking on Point Name will open the Alarm History page of the respective Point.

Alarm Class

The class to which the alarm belongs Setting under App Configuration:

Alarm Class column will be displayed in this Alarm Search page only if the “Display Alarm Class in Weblets and Search Pages” checkbox under App Configuration is selected. (Settings🡪Manage🡪App Configuration)

Alarm Value

Alarm Value denotes whether the alarm is in alarmed status or cleared status. 1= Alarm 0 = Cleared

Alarm Message

Shows the respective alarm message. Clicking on Alarm Message will open Alarm detail page.

Alarm Status

Denotes the status of the alarm, whether it is in alarmed status (Alarm) or cleared (Cleared).

User Actions

Shows the immediate user action taken upon the respective alarm. E.g. Acked, Confirmed

Feature on Alarm Viewer page

Description

Filter is used to filter alarms using the given search criteria. Found on Alarm Viewer Toolbar.

This will open the legend that contains the Priority of Alarm Severities. Found on Alarm Viewer Toolbar.

Alarm Viewer with this icon shows all alarms. Clicking this icon will show only the active alarms. Found on Alarm Viewer Toolbar.

Alarm Viewer with this icon shows only the active alarms. Clicking this icon will show all the alarms.

Alarm Auto Refresh is enabled. Click to disable ‘Auto Refresh’.

Alarm Auto Refresh is disabled.

When multiple users are using alarm viewer simultaneously or when new alarms come frequently, alarm viewer tends to refresh frequently making users losing their focus on alarm viewer. Making “Auto Refresh disabled” helps in this.

Note: When logged in user takes actions on the Alarm Viewer items, Alarm Viewer should refresh the alarm list even if Auto Refresh is disabled.

Click to enable ‘Auto Refresh’.

This icons is displayed when Auto Refresh is disabled & new alarm updates have been received,

System Pages icon opens a pop-up window which lists System Pages related to the respective Alarm.

System Name navigates to System Real-Time Values page

System GUI icon navigates to System Real-Time GUI page. This icon will be visible only when System has an uploaded GUI page.

Opens Alarm History

-Alarm History icon will be displayed in ‘red’ for many occurrences today and yesterday with alarm occurrence count.

-Alarm History icon will be displayed in ‘amber' for more than one alarm (many occurrences) for today only with alarm occurrence count.

- Alarm History icon will be displayed in ‘grey’ (normal) when only one alarm generated for the current day (Today). It can have older alarms and also cleared alarms.

Assignee icon can be found on New, Acknowledged and Confirmed Alarms tabs on Alarm Viewer. This icon opens a page which allows adding assignees with comments to the relevant alarm.

Note:

  • If an Assignee is added to an Alarm, the respective Assignee icon’s color will be changed from grey to dark black.

  • Assignee icon will be shown only for the Alarms which are not cleared.

Opens Operator Note window to enter Operator Notes for the first time. Once an operator note is entered, the icon will be changed to icon.

Opens Operator Note window to view/edit Operator notes.

This icon is used to send messages manually using the preconfigured Message templates.

Clicking this will open the respective Quick Info window which contains important info of the respective alarm and links to Real-Time Values, Real-time GUI and View Map.

Ack button will be displayed only for New Alarms as they have to be acknowledged. To acknowledge an Alarm click the respective Ack button.

Confirm button will be displayed only for Acknowledged alarms. To confirm an Alarm, click Confirm. NOTE: Confirm button is displayed only if the Alarm Confirmation Required checkbox is selected under App Configuration.

Color of the icon denotes the Severity of the Alarm.

Sort icon on each tab on Alarm Viewer is used to sort the Alarms in ascending or descending order according to the selected field in the drop-down box.

Alarm Time filter– To sort the alarms on New Alarms, Acknowledged Alarms and Confirmed Alarms tabs, according to the time that the alarm triggered.

Cleared Time filter – To sort the alarms on New, Acknowledged and Confirmed Alarms tabs, according to the Alarm Cleared Time.

Acknowledged Time filter – To sort the already acknowledged alarms according to the time the alarms acknowledged.

Found on Acknowledged Alarms and Confirmed Alarms tabs.

Confirmed Time filter - To sort the confirmed alarms according to the time that the alarms confirmed. Found on Confirmed Alarms tabs.

You can also sort alarms by additional filters such as Equipment, Point, Alarm Class, Alarm Severity and Message.

Select Preferred Alarm Severities appearing on Alarm Bell icon

The system provides an option for the users to select the type of alarm severities each user needs to view and to be notified on their Alarm Bell icon. Once the user’s preferred Alarm Severities are selected, the respective user (logged-in User) will be notified only the alarms belong to the preferred Alarm Severities.

This feature will provide the following benefits to individual users

  • Filter preferred Alarm Severities (e.g. High) appearing on their own Alarm Bell icon and to restrict rest of the alarms (not preferred alarms) appearing on Alarm Bell.

  • Logged in User’s Alarm Viewer will be updated only with the alarms belong to preferred Alarm Severities.

To configure the preferred Alarm Severities;

  1. Go to your User Profile page. (Click 🡪 Edit Profile)

  2. Go to Preferences tab🡪Preferred Alarm Severities section.

  3. Click Add icon and add your preferred Alarm Severities.

  4. Select the “Enable preferred Alarm Severities” check box to enable the preferred Alarm Severity filtering feature.

Disable Alarm Escalation (Alarm Silencing)

The system has a functionality which allows authorized users to disable alarm escalation of active alarms and to stop sending out escalation messages to relevant users. This action will help the user to stop alarms getting escalated while keeping the alarms active.

Users can disable alarm escalation in 2 ways;

  1. For a selected Point: Disable alarm escalation for all the alarms associated with a Point at once.

  2. For specific alarm/alarms of a Point: Disable alarm escalation of selected alarm/alarms associated with a Point.

1. To disable alarm escalation of a selected Point;

  1. Go to the Settings icon 🡪View🡪Points.

  2. Select the Point which you need and click the Point name to go to the Point detail page.

  3. Go to the Details tab of the Point detail page.

  4. Click the Disable Alarm Escalation link on the side bar on the right. A message to confirm the operation will pop up.

  5. Click OK to confirm the operation. The action will disable alarm escalation of the selected Point. It will avoid alarms getting escalated for the selected Point and sending the escalation messages to the respective users. A message will appear stating that the alarm escalation is being disabled and the name of the link on the sidebar will be changed to “Enable Alarm Escalation”.

  6. After the alarm escalation is disabled, an exclamation icon will appear in the relevant alarm record next to the Alarm icon.

Note –To enable Alarm escalation of the Point again, (if alarm escalation is already disabled )

  • Go to the Point Detail page🡪 Details tab

  • Click the Enable Alarm Escalation link on the side bar on the right.

2. To disable alarm escalation of a selected Alarm of a Point

Note: This will only disable the Alarm Escalation of the selected Alarm of the respective Point.

  1. Settings🡪View🡪Points🡪Point Detail Page of the respective Point🡪Details tab

  2. Go to the ‘Alarm’ section on the Details tab of Point details page.

  3. Select the required alarm and click the Edit icon.

  4. Select the ‘Disable Alarm Escalation’ check box.

  5. Click Update. User will be directed to the Alarms section on Point Details page. A red exclamation mark will be displayed at the beginning of the respective Alarm record in the Alarm section, to denote that alarm escalation is disabled.

Acknowledge Alarms

Alarm Viewer allows an operator with certain login credentials to acknowledge new alarms. Acknowledging an alarm is a user action and it will not change the alarm status (Alarm or Cleared). After an alarm is acknowledged, the respective alarm will be displayed under the Acknowledged Alarms tab with the User Action named “Acked”.

You can either acknowledge individual Alarms or multiple number of alarms at once.

Acknowledge a single alarm

  1. Go to the New Alarms tab and click on Ack button of the respective alarm. After acknowledging an Alarm, its status will not be changed. Acknowledged alarm will be displayed under Acknowledged Alarms tab.

    e.g. (1) Status: Alarm Action: Ack

    (2) Status: Cleared Action: Ack

Acknowledge multiple/all alarms at once

  1. On the Alarm Viewer, go to the New Alarms tab.

  2. Select the check boxes of the required multiple Alarms you need to acknowledge and click Ack All. If you need to acknowledge all the alarms under New Alarms tab at once, click the Select All check box and then click Ack All button.

Setting under App Configuration Acknowledged alarms will not be displayed under the “Acknowledged Alarms” tab in Alarm Viewer, if the “Show acked alarms in Alarm History Viewer” checkbox is selected in Settings🡪Manage🡪App Configuration page. If that checkbox is selected, the acked alarms will be displayed in Alarm History Viewer.

Add Operator Notes

Alarm Viewer has an option named “Operator Notes” for the operators to add notes when taking actions upon alarms. E.g. when acknowledging an alarm, operator can add an important note on alarm for the users to see. These notes are not specific to any particular users. This option allows to add multiple notes on one alarm.

To add an Operator Note;

  1. Go to the Alarm Viewer and click on the Operator Note icon. Operator Note window will appear.

  2. Type a note in the Operator Note box.

  3. Click Add Operator Note. Added Operator Note will be displayed on the bottom of the window along with the time entered and the name of the operator.

  4. Click the icon displayed next to the name of the operator to view the Quick info page of the respective operator.

  5. To delete the added note, click the respective Delete icon.

  6. To add more operator notes, follow the steps from 2 to 3.

  7. Operator Notes page: Expand the Alarm Instructions section to view the instructions added related to Alarm on the respective Point’s Point Details page.

  8. To close the window, click.

Note –Alarm Instructions are added in the Alarm Instructions section on the Details tab in the respective Point Detail page. Added Alarm Instructions will be displayed in the Operator Note page.

Add Assignees on Alarm Viewer

Alarm Viewer has “Assignee” option to assign alarms to specific users.

  • This option allows to add one or multiple assignees to a selected alarm.

  • Adding a comment on each assignment of assignee is mandatory.

  • After an alarm is assigned to a user (Assignee), it will be displayed under the respective assignee’s “Alarms assigned to me” Weblet.

To assign a user as an Assignee;

  1. Go to the Alarm Viewer and click on the Assignee icon . Assignee window will appear.

  2. In the Assignee list box, select the required user to be selected as Assignee.

  3. In the Comment box, type a comment required.

  4. Click Add Assignee. Added Assignee will be displayed on the bottom of the window along with the time entered, name of the Assignee and the comments entered.

  5. Click the icon displayed next to the name of the Assignee to view his/her Quick info page.

  6. To delete the added note, click the respective Delete icon .

  7. To close the window, click.

Confirm Alarms

After an alarm is acknowledged, it can to be confirmed by an authorized user (Only if required setting is applied under App Configuration by selecting the Alarm Confirmation Required checkbox). When confirming alarms, individual alarms can be confirmed or else multiple alarms can be confirmed together.

Setting under App Configuration Acknowledged alarms can be confirmed only if the “Alarm Confirmation Required” checkbox is selected which is under the Alarm Viewer Settings section on App Configuration page.

To confirm a single alarm;

  1. On the Acknowledged Alarm tab, search for the required Alarm.

  2. Click Confirm. The system will pop-up a window with several options.

    • Register a CWO: To create a Corrective Work Order for the respective alarm

    • Register a Corrective Job Card: To create a new Job Card for the respective alarm

    • Register an Incident: To create an Incident for the alarm

    • Add Comment: To add comments for the respective alarm

To confirm multiple alarms/ all alarms together;

  1. On the Acknowledged Alarms tab, select the check boxes of the required alarms. To select all the alarms, click ‘Select All’ check box.

  2. Click Confirm All to confirm all the selected alarms.

Confirmed Alarms

Alarms that are confirmed will be displayed under the Confirmed Alarms tab. Once a ‘Confirmed alarm’ is cleared from the device, its status will be changed to Cleared and the alarm will be removed from the Confirmed Alarms tab and will be displayed under the Alarm History Viewer.

Alarm History

Alarm History option allows you to view list of alarms and search for alarms. It also allows you to filter the new alarms that are not acknowledged and alarms with pending actions.

  1. Click the Settings icon and select Alarm History under View section. Alarm History search page will appear.

  2. Apply the following Search filters to filter the alarms using;

    • Location:

      1. Clear the current location by clicking. You will observe that all the alarms from diverse locations are displaying.

      2. Click location text box and select a location from the drop-down to filter the alarms for that particular location. You may type in a new location as well.

    • Asset Category:

      1. Select the required Asset Category to filter alarms by the selected Asset Category.

    • Alarm Class:

      1. By default, "Any" will be selected.

      2. Select the required alarm class or multiple alarm classes to filter alarms by the selected alarm class or alarm classes.

    • Alarm Stage:

      1. Select the required Alarm Stage to filter alarms by the selected Alarm Stage.

    • Alarm Severity:

      1. Select the required Alarm Severity to filter alarms by the selected Alarm Severity.

    • Equipment:

      1. Select the Equipment of the equipment that triggered alarms, to filter alarms by Equipment.

    • From –To Alarm Date: Select the Date range to filter alarms generated during the selected Time period.

    • Pending Action: Used to filter the Alarms with pending actions.

    • Show Only Active Alarms: Used to filter the alarms that are New/Acked/Confirmed/Escalated.

Alarm History Viewer

This shows the alarms that have been confirmed and cleared from the devices.

  1. Click the Settings icon and select Alarm History Viewer under View section. Alarm History Viewer page will appear.

  2. Click the Filter icon and use the given filters as required.

  3. To clear the already selected Location, Alarm Class and Asset Category filters, click the Clear Filter button.

Alarm Bell Icon on Toolbar

Event
Appearance of the Alarm Icon on Toolbar

Alarm Bell icon on Toolbar (Default icon)

When a new alarm is triggered

Icon becomes red and blinks to make the Users aware of any new alarms

The alarm icon provides links to Alarm Viewer pop-up and Alarm Map. (On the Alarm Viewer, click a bell icon of respective alarm record in the list 🡪Alarm tab 🡪 Click the View Map on the sidebar).

Note – When you click the Alarm Bell icon on Toolbar (Default icon), the Alarm Viewer pop-up will open only if Show Pop-up Alarm Viewer check box is selected under Settings🡪 Manage🡪 App Configuration.

Note –When a new alarm is triggered, desktop beep sound will be emitted and flash notification will be popped-up. This will work for https connections, when Enable desktop sound/flash notification for new alarms” checkbox is enabled.

Alarm Viewer Pop-up

To open Alarm-Viewer pop-up;

  • Click the Alarm icon on the toolbar. By default, it shows all the un-acked alarms (cleared alarms + alarms currently at “Alarm” state) and the Bell icon on Alarm Viewer pop-up will be .

Icon on Alarm Viewer pop-up
Description

If the Bell icon is , the page shows all the un-acked alarms (Cleared alarms + alarms currently at “Alarm” status) Click to view only the Active alarms. (alarms currently at “Alarm” status)

If the Bell icon on the Alarm viewer is , the page shows only the active alarms. Click this icon to go to the default mode to view all the un-acked alarms.

Filter Icon

This opens the filter pop-up to filter the alarms by Location, Alarm Class, Asset Category, etc.

Legend Icon

This opens the Legend of alarm severity.

Click this to acknowledge the alarm.

Alarm History Icon

Clicking this will open the Alarm History page of the respective alarm.

Assignee Icon

Used to assign the respective alarm to specific users.

This option allows to add one or multiple assignees to a selected alarm.

Adding a comment on each assignment of assignee is mandatory.

After an alarm is assigned to a user (Assignee), it will be displayed under the respective assignee’s “Alarms assigned to me” Weblet.

Operator Note Icon

Click this icon to open the Operator Note page to add operator notes regarding the alarm.

Notification Icon

Click this icon to select a Message Template and send notifications manually.

Alarm History Viewer link

This link opens the page which shows the alarm history details.

How to view only the alarms at “Alarm” status (Active Alarms)

Click the Bell icon on the Alarm viewer pop-up. Cleared alarms displayed on the screen will be removed and only the active alarms at “Alarm” status will appear. The Bell icon will become red.

Point Write History

Point Write History is a report, which shows all the Equipment Point value changes that have occurred along with the user who performed the action. Whenever equipment point value changes, it will be logged and can be viewed under Point Write History.

Path Settings icon🡪 View section🡪 Point Write History

To view Point Write History;

  1. Click the Settings icon and select Point Write History under View section.

  2. By default, the location of the logged-in user will be selected as the Location in the Location filter box and data will be filtered according to the respective Location.

  3. If you need to filter by the person who took actions, select the required user under “Action Taken By”.

  4. Data can be filtered by Equipment and Point Template as well.

  5. You can use the Commands filtering option to filter data using Point Override and Point Reset.

    • Point Override: used to filter the Points which were manually changed

    • Point Reset: used to filter the Points in which the values were reset to the configured default value.

  6. Set duration filters.

    1. Under Written between, click Calendar icon and select the start date of the duration. Click the Clock icon and select the start time.

    2. Under and, click Calendar icon and select the end date of the duration. Click the Clock icon and select the end time.

  7. Generate Report: This is used to generate the current report in PDF/Word/Excel/Excel Raw formats based on the filtered data.

    1. In the Format box, select the type of format you want.

    2. Click Generate Report.

  8. In the ‘Point Write History ‘search results page, each Point name is clickable, which navigates to the Details page. Then you can navigate to Write History tab of the respective Point.

View Real-time Reports

Real Time Reports page lists the Real Time Reports configured by users in the IBMS application.

Real-Time Reports allow you to view Real-Time point values of a selected set of equipment. Before you view a Real-Time report, you need to configure the required Real-Time Report, by selecting the required set of equipment points.

Refer to the Real Time Reports section for a detailed explanation.

Path Settings icon🡪 View section🡪 Real Time Reports

View Interface Gateways

This is used to view the Interfaces running Gateway servers.

Note –SubsystemInterfaceUpdater Service should be installed for you to view the data in Interface Gateways.

Path Settings icon🡪 View section🡪 Interface Gateways

  1. Click the Settings icon and select Interface Gateways under View section. Interface Gateways Search page will appear.

  2. Type the name of the Interface Gateway in the Search Interface Gateways input box to search for the Interface Gateway you want.

View Interface Transaction History

Interface Transaction History page lists the Interfaces which were activated/refreshed along with the Time stamp of each transaction, Description of transaction (either Activated or Refreshed) and User who took the action (If the action is taken manually, User who took the action may not be captured by iviva. So Action Taken by data will not be available).

Path Settings icon🡪 View section🡪 Interface Transaction History

  1. Click the Settings icon and select Interface Transaction History under View section. Interface Transaction History page will appear.

  2. Type the Interface ID in the Search Interface Transaction History input box to search for the transaction history of the Interface ID you want.

  3. Use the given search filters accordingly.

  4. Use the Sort option to sort the search results by the given fields.

View Overridden Points

Overridden Points search page lists the Points that have been manually overridden by authorized users on iviva Equipment Real-time Values page and System Real-time Values page. Each record on the Overridden Points search page shows each Overridden Point’s last overridden details as follows;

  • New Value Updated Time: Date & Time of latest Point Value update

  • Point Name

  • Equipment: Associated Equipment

  • New Value: Point’s new Value after overridden

  • Overridden By: By whom the overridden done

  • User Comment: Comment entered by user who did the override when the action was taken

  • Reset Button: used to reset the Point value back to the default value

Path Settings icon🡪 View section🡪 Overridden Points

  1. Click the Settings icon and select Overridden Points under View section.

  2. Type required Point/ Equipment/ Overridden by in the Search Overridden Points input box to search for the required Point(s) you want.

  3. Use the given search filters on the Side bar accordingly.

  4. Use the Sort option to sort the search results by the given fields.

View Health Status

Health Status window is used to monitor the status of the following:

  • Gateway server

  • SSIFs

  • Points

  • Alarms

  • Trends

  • Devices

Path Settings icon🡪 View section🡪 Health Status

User can expand and collapse nodes under Zones. Furthermore, users can navigate to SSIF details as well.

Alarm History Download from BACnet Controllers

Note – This section is applicable only for BACnet Controller based Alarms.

Alarm events initiated at Controllers will not be captured when there are situations such as;

  • Communication issues between Controllers and SSIFs

  • Unexpected shutdown of SSIFs

Due to ‘onetime Alarm Event transition’ from Controllers to SSIF, the alarm events occur during any alarm event transmission failure can cause losing them without being transmitted to SSIFs. This can create alarm discrepancies between iviva system (as SSIFs send captured data to iviva) and the real-time data from Controllers.

Possible Alarm Discrepancies between Controllers and iviva

  • New alarm in Controller but iviva does not indicate it.

  • Cleared alarm in Controller while iviva shows it as an event in the “alarmed” stage.

Troubleshooting

  1. ‘SSIF Restart’, which occurs after a transmission failure (between Controllers and SSIFs), will fetch Alarm history from Controller and update iviva system. This will happen automatically on each SSIF Restart.

  2. Download Alarm History Manually

    User can make an ‘Alarm History Download’ request using iviva system and send it to relevant SSIF to fetch Alarm History from each BACnet Controller device. SSIF will fetch data from BACnet controller and update the iviva system.

Download Alarm History Manually from BACnet Controllers

  1. Go to Settings 🡪Building Management System 🡪BACnet Devices.

  2. Select the relevant BACnet Device from the Search page and click the relevant Device ID to go to its detail page.

  3. Click the Download Alarm History link on the Side bar to download the alarm history manually from the Controller in order to update the iviva System.

After the Alarm History is downloaded from the BACnet Controller;

  • If any Alarm event in the downloaded Alarm History is still found in “Alarmed” state in the Controller, it will be shown as an Alarm on the Alarm icon/ Alarm Viewer in iviva system.

  • If the alarm events in the downloaded Alarm History are already cleared in the BACnet Controller, these details will be written under the Subsystem Event History tab of the respective Point’s detail page in iviva system. This tab will show all alarm events of Point, which are downloaded via “Alarm History Download” function. To view Subsystem Event History of a BACnet Controller Point, go to the respective BACnet Controller Point’s detail page 🡪 Subsystem Event History tab.

Note –The alarm events that are not associated with any existing data In iviva can be viewed by clicking on “Exceptions” checkbox on the side bar.

View BACnet Devices

This section describes how to view BACnet Devices.

Path Settings icon🡪 View section🡪 BACnet Devices

To view BACnet Devices;

  1. Click the Settings icon and select BACnet Devices under Building Management System section.

  2. Type the BACnet Device ID/BACnet Device Name/Description in to the Search BACnet Devices input box to search for the BACnet Device desired.

  3. To view BACnet Devices for a selected iViva BACnet Agent ID, use the iViva BACnet Agent ID filter box on the right-side panel.

  4. Click a BACnet Device ID to open the respective device’s detailed page.

  5. The following links will be available in the right-side panel:

    • Scan Devices:

    • Initialize Devices:

    • View Transactions:

    • Weekly Schedule Templates:

    • Export Schedule Upload Report:

  6. On the device’s detailed page, the following tabs will be available;

    • Scan Devices:

    • Details tab:

    • Trend Logs tab:

    • Schedules tab:

    • Alarms tab:

    • Transactions tab:

Last updated