System Activity - Metasys - LIT-12011953 - Server - Metasys UI - 7.0.50

Metasys UI Help

Brand
Metasys
Product name
Metasys UI
Document type
User Guide
Document number
LIT-12011953
Version
7.0.50
Revision date
2024-03-19
Product status
Active
Language
English

What is the System Activity feature?

You can view and manage all audits and alarms that are forwarded from an engine to the Site Director directly in Metasys UI with System Activity. The data is presented in the form of a timeline in System Activity. Every audit and alarm instance appears in chronological order in System Activity, including alarms that do not require acknowledgment. The alarms are not rolled up, as is the case in Alarm Manager. The feature helps you understand changes that have occurred in the Metasys system over a period of time, whereby you can display audits and alarms as far back as the data set.

Note: For MVE on Metasys UI, see Alarms and audits for MVE on Metasys UI for more information.
Note: System Activity is available in Metasys UI only.
Note: When an alarm is triggered due to a user action, for example, an Override command, System Activity may show the alarm as occurring before the audit for the user action. This occurs because the audit record generates only after the system confirms the action successfully completed, which may be slightly after the alarm has already been triggered.

Who can access and use System Activity?

You do not require special authorization or licensing to access System Activity. To view alarms, you need the View permission for the alarm's authorization category. In addition, the content of the feature is subject to authorization. For example, the feature excludes space and equipment context for audits created for points that belong to an equipment serving one or several spaces that the user is not authorized for, or for points that belong to a piece of equipment for which the user does not have View permission. For example, if the point on which the audit is generated is mapped to two pieces of equipment (equipment A and equipment B) and the logged in user has the View permission of the equipment A authorization category but not equipment B authorization category, equipment A and the space that equipment A serves are displayed.

You also require appropriate authorization to complete actions such as annotating or discarding an audit. The following table outlines the actions and the required system access privileges.

Table 1. System Activity privileges
Action Required category-based or system privilege
Viewing audits View Metasys Status system privilege.
Viewing alarms View permission for the alarm’s Authorization Category.
Annotating audits View Metasys Status and Manage Audit History system privileges.
Annotating alarms permission for the alarm’s Authorization Category.
Discarding audits View Metasys Status and Clear Audit History system privileges.
Discarding alarms

Manage Item Events permission for the alarm’s Authorization Category and one or both of the following system privileges:

  • Discard All Events (any alarm)

  • Discard Acknowledged Events (acknowledged alarms only)

Filtering with Building Network tree filter User Can View The Item Navigation Tree (Default Tree) setting enabled for the user account (User Details tab in the User Management feature).
Acknowledging alarms Manage Item Events permission for the alarm’s Authorization Category
Note: At the time an object goes into alarm, the Authorization Category of the alarm occurrence is set to the object’s Authorization Category. Later changes to the object’s Authorization Category will not affect the Authorization Category of past alarm occurrences.
Note: You can annotate when you perform an action without the Manage Audit History privilege. For example, you can select an audit to discard and annotate that action without the Manage Audit History privilege but with the Clear Audit History privilege. However, you cannot perform any action on an alarm without Manage Item Events privilege.

How can I access System Activity?

  1. Open the User menu.
  2. Tap or click System Activity.
Note: You can also open System Activity in a pre-filtered state from another feature. For example, the Involvement widget provides a link to System Activity, whereby System Activity is filtered to the alarms and audits of the primary object.
Note: When using Metasys UI for engines or MVE sites, you can also access System Activity through an icon in the Alarm Notification Bar. See Alarm Notification Bar for details.

What is the layout of System Activity?

The following figure and table outline the System Activity feature in more detail.
Figure 1. System Activity layout
Table 2. System Activity callouts
Number Name Description
1 All This is the default tab. You can view and manage audits and alarms in this tab.
2 Audits You can view and manage audits in this tab.
3 Alarms You can view and manage alarms in this tab.
4 Actions Acknowledge, discard, or annotate one or several alarms. Discard or annotate one or several audits. See What actions can I perform in System Activity? for more information about actions.
5 Filter Apply a filter to see specific data. See How do I use filters in System Activity? What filters are available? for more information about filters.
6 Data columns Shows the audits and alarms listed by:
  • Icon: see What do the icons in System Activity represent? for more information about System Activity icons.
  • Annotation: annotated audits or alarms have an Annotation icon in this column.
  • Graphic: alarms with an associated graphic have a graphic icon in this column. Click the graphic icon to view the graphic.
  • Date/Time: shows when the activity occurred.
  • User: shows the user responsible for the audit. Only an administrator user can see the full list of users.
  • Type:
    • For audits: indicates the type of action that initiated the audit message.
    • For alarms: displays the status of the item associated with the alarm message.
  • Space(s): shows the spaces associated with the audit or alarm.
  • Equipment: shows the equipment associated with the audit or alarm.
  • Item: shows details about the item affected by the audit or alarm.
  • Description: provides more information about an activity. The description is generated by the system.
  • Previous Value: shows the value before the activity was completed.
  • Activity Value: shows the value provided when the activity was completed.
  • Priority: shows the alarm priority.

You can resize columns in the column header row.

7 Results Shows you the number of results. The results number is dynamically updated.
8 Export icon Exports the list of audits or alarms to a .csv or .pdf file.
Note: The export functionality is not supported on tablets and smartphones. The .csv export includes a maximum of 10,000 results, and is affected by filtering in the UI. The .csv export does not include all activities in the system.
9 Load More Loads more system activities (audits, alarms, or both). 10,000 is the maximum number of audits and alarms that can appear in System Activity on a desktop platform. On a mobile platform the limit is 1,000. As new alarms and audits come in, older alarms and audits are pushed out of view. To view specific time frames of audits and alarms, use date range filters.

What actions can I perform in System Activity?

You can perform actions through the ACTIONS button in the upper left of the screen. The following table outlines the available actions.
Table 3. Actions available in System Activity
Action Description
Acknowledge You can acknowledge one or bulk acknowledge several alarms. You can acknowledge an alarm if it has not been acknowledged already and if it is authorized for acknowledgment by the user. Acknowledged alarms still appear in the timeline. See also How do I acknowledge an alarm? How do I acknowledge multiple alarms?
Discard You can discard one or bulk discard several audits or alarms. You can discard an audit or alarm if it has not been discarded already and if it is authorized for discard by the user. Discarded audits and alarms still appear in the timeline. See also How do I discard an audit or alarm? How do I discard multiple audits or alarms?
Annotate You can annotate one or bulk annotate several audits or alarms. You can annotate an audit or alarm if it is not discarded and if it is authorized for annotation by the user. The Annotation icon and text also appears in the Equipment Activity widget if the audit or alarm is tied to a point that has spaces or equipment configured. See also How do I annotate an audit or alarm? How do I annotate multiple audits or alarms?

How do I acknowledge an alarm? How do I acknowledge multiple alarms?

To perform a single acknowledgment or bulk acknowledgment of an alarm, complete the following steps:
  1. Select a single alarm or multiple alarms, by tapping or clicking the check box next to the alarms.
  2. Tap or click ACTIONS in the upper left of the screen.
  3. Select Acknowledge. The Single Acknowledge window opens when you select one alarm. The Bulk Acknowledge window opens when you select multiple alarms.
  4. To annotate your action, select a predefined annotation or enter your own comment in the text box.
    Note: It is best practice to annotate your actions. When an Administrator chooses to enforce all annotations in the system settings, you have to annotate your actions.
  5. Tap or click ACKNOWLEDGE.
    Note: After a bulk action on a large number of items in System Activity, you may experience one or more of the following:
    • A delay in annotation icon updates
    • A delay in activity icon status updates
    • The Metasys UI becomes unresponsive for a time
    • The System Activity feature does not properly display after selecting a new tab

    If you experience any of the issues listed above, wait for 10 to 20 seconds after any bulk operation such as bulk annotation, acknowledge, or discard. If the issues do not resolve after a short time, refresh your browser.

You can also perform a single acknowledgment of an alarm in the details flyout pane:
  1. Tap or click on an alarm. The details flyout pane opens.
  2. Tap or click ACKNOWLEDGE at the bottom of the pane. The Single Acknowledge window opens.
  3. To annotate your action, select a predefined annotation or enter your own comment in the text box.
    Note: It is best practice to annotate your actions. When an Administrator chooses to enforce all annotations in the system settings, you have to annotate your action.
  4. Tap or click ACKNOWLEDGE.

How do I discard an audit or alarm? How do I discard multiple audits or alarms?

To perform a single discard or bulk discard of an audit or alarm, complete the following steps:
  1. Select a single audit or alarm, or multiple audits or alarms, by tapping or clicking the check box next to the audits or alarms.
  2. Tap or click ACTIONS in the upper left of the screen.
  3. Select Discard. The Single Discard window opens when you select one audit or alarm. The Bulk Discard window opens when you select multiple audits or alarms.
  4. To annotate your action, select a predefined annotation or enter your own comment in the text box.
    Note: It is best practice to annotate your actions. When an Administrator chooses to enforce all annotations in the system settings, you have to annotate your actions.
  5. Tap or click DISCARD.
    Note: After a bulk action on a large number of items in System Activity, you may experience one or more of the following:
    • A delay in annotation icon updates
    • A delay in activity icon status updates
    • The Metasys UI becomes unresponsive for a time
    • The System Activity feature does not properly display after selecting a new tab

    If you experience any of the issues listed above, wait for 10 to 20 seconds after any bulk operation such as bulk annotation, acknowledge, or discard. If the issues do not resolve after a short time, refresh your browser.

You can also perform a single discard of an audit or alarm in the details flyout pane:
  1. Tap or click on an audit or alarm. The details flyout pane opens.
  2. Tap or click DISCARD at the bottom of the pane. The Single Discard window opens.
  3. To annotate your action, select a predefined annotation or enter your own comment in the text box.
    Note: It is best practice to annotate your actions. When an Administrator chooses to enforce all annotations in the system settings, you have to annotate your action.
  4. Tap or click DISCARD.

When you discard an audit or alarm, the discarded time appears in the details flyout pane. For example, Discarded at: 05/25/2020 4:34:26 PM.

How do I annotate an audit or alarm? How do I annotate multiple audits or alarms?

To add a single annotation or bulk annotations to an audit or audit, complete the following steps:
  1. Select a single audit or alarm, or multiple audits or alarms, by tapping or clicking the check box next to the audits or alarms.
  2. Tap or click ACTIONS in the upper left of the screen.
  3. Select Annotate. The Single Annotate window opens when you select one audit or alarm. The Bulk Annotate window opens when you select multiple audits or alarms.
  4. Select a predefined annotation or enter your own comment in the text box.
  5. Tap or click ADD.
    Note: After a bulk action on a large number of items in System Activity, you may experience one or more of the following:
    • A delay in annotation icon updates
    • A delay in activity icon status updates
    • The Metasys UI becomes unresponsive for a time
    • The System Activity feature does not properly display after selecting a new tab

    If you experience any of the issues listed above, wait for 10 to 20 seconds after any bulk operation such as bulk annotation, acknowledge, or discard. If the issues do not resolve after a short time, refresh your browser.

You can also add a single annotation to an audit or alarm in the details flyout pane:
  1. Tap or click on an audit or alarm. The details flyout pane opens.
  2. Tap or click the Annotations hyperlink. The Annotations window opens.
  3. Tap or click the Add Annotation icon in the Annotations window.
  4. Select a predefined annotation or enter your own comment in the text box.
  5. Tap or click ADD.

What do the icons in System Activity represent?

The following table outlines the different icons present in System Activity. You can hover over the icons in the UI to see the icon names.
Table 4. Audit and alarm icons
Icons Description
This icon represents a discarded audit.
This icon represents a non-discarded audit.
This icon represents an alarm.
Note: You can specify colors in the Metasys Preferences.
This icon represents an alarm that requires acknowledgment.
This icon represents an acknowledged alarm.
This icon represents a discarded alarm.
This icon represents a discarded alarm that requires acknowledgment.
This icon represents an acknowledged and discarded alarm.

Can I sort data in System Activity?

Yes, you can sort data in System Activity. With the exception of the Priority column, the sorting occurs on the rows that appear in the UI, and not on the entire data set. For Priority, the entire data set is sorted by priority.

How do I use filters in System Activity? What filters are available?

You can filter the content displayed in System Activity.
  1. Tap or click the FILTER button in the upper left of the screen.
  2. Select the filters that you want to apply.
  3. Tap or click APPLY.
Note: If you apply several filters, the filters are applied as AND statements. If you apply one filter with several conditions, the filters are applied as OR statements. For example, if you filter audits for Action Type (Command or Create) and a filter by Space & Equipment (AHU or VAV), the audits filter for Command or Create AND AHU or VAV.
Note: You can bookmark your filters in System Activity.
The filter options vary slightly depending on the active tab. The tabs work like a high-level filter. The following table outlines the available filters.
Table 5. System Activity filters
Available on these tabs Filter name Function Restrictions
All, Audits, Alarms Start Date to End Date

View audits or alarms for a defined date range. The start date and end date filters are inclusive.

The time frame that you enter persists when you switch to another tab.

None.
All, Audits, Alarms Filter by Space & Equipment Equipment: View audits or alarms generated for objects that belong to the equipment that you select in the filter. Audits or alarms generated for objects that belong to the equipment serving the equipment you select in the filter are not included. You can filter for authorized equipment only.
Space: View audits or alarms generated for objects that belong to the equipment serving the space(s) that you select in the filter and any of its descendant spaces. You can filter for authorized spaces only.
All, Audits, Alarms Network Items View content for selected network items. This filter does not include the children of the selected items. This requires that the User Can View The Item Navigation Tree (Default Tree) property is selected in the User Details tab in the User Management feature. You also require the category-based View permission to filter on network objects.
All, Audits, Alarms Activity Type View discarded or non-discarded audits or alarms. You require the View Metasys Status system access privilege to view discarded and non-discarded audits or alarms.
Audits User Choose a user to view information about user-related audits, such as log on information, command audits, or write audits. None.
Audits Class Level Filter content for the following class level: Application, Critical System Events, Diagnostic, Non-Critical System Events, and User Action. None.
Audits Action Type Filter content for the following action types: Command, Create, Delete, Error, Subsystem, and Write. None.
Audits Origin Application Filter content for the following origin application:
  • Alarm & Event
  • Audit Trails
  • Device Manager
  • Device Services
  • Energy Management
  • General
  • Interlock
  • MCE
  • MCO
  • N2
  • Schedule
  • Site Services
  • System Security
  • Trend
  • Web Services
None.
Alarms Priority Min to Priority Max View alarms for a defined priority range. None.
Alarms Event Status View acknowledged or unacknowledged alarms. You require the View Metasys Status system privilege to view acknowledged and unacknowledged alarms.
Alarms Acknowledgement Required View alarms that require acknowledgment or alarms that do not require acknowledgment. None.
Alarms Authorization Category Filter content for the following authorization categories: HVAC, Fire, Security, Services, Administrative, General, Lighting, Refrigeration, Critical Environment, Air Quality, Power, Energy, System, or Custom 1 to Custom 150 None.
Alarms Event Type Filter content for the following event types: Normal, Fault, Off Normal, High Limit, Low Limit, Low Warning, High Warning, Low Alarm, High Alarm, Alarm, Trouble, Status, Offline, Shutdown, Unreliable, Online, Above Setpoint, Below Setpoint, Unoccupied, or Unknown Previous State None.

Why are audits and alarms from older engines not displaying in System Activity?

Alarms on engines prior to Release 5.2 and audits on engines prior to Release 8.0 are not forwarded to a server repository. System Activity can display audit and alarm data only if audits and alarms are forwarded to a server repository.

Is the data displayed in System Activity updated dynamically?

Yes, the data is updated dynamically in System Activity.

Are there notifications for new alarms?

Yes, there is a notification feature for new alarms in System Activity. A star icon indicates a new alarm.

Can I export or print System Activity data?

Yes, you can export information that appears in System Activity on a computer. The export functionality is not supported on tablets and smartphones.

To export information that appears in System Activity, click the export icon. You can export a maximum of 10,000 results to a .csv file. You can export the audits that are displayed on the page to a .pdf file. For example, if System Activity has 2,000 results, then those 2,000 results appear in the .pdf file. You can print the .csv or .pdf file.

Is System Activity supported on all devices?

Yes, the System Activity feature is supported on desktop, tablets, and smartphones.