Annotations - 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

Can I edit or delete existing annotations?

You cannot edit or delete existing annotations. Instead, add a new annotation to the user change, system change, or alarm instance.

What do the icons used for annotations represent?

The following table describes the icons that you see in connection with annotations.

Note: For MVE on Metasys UI, see Table 1 for more information.
Table 1. Annotation icons
Icon Icon name Feature Description
Annotations Equipment Activity widget, System Activity Annotations are available to view.
Annotations Alarm Manager and Alarms (phone), System Activity Annotations are available to view.
Add Annotation Equipment Activity widget, Alarm Manager, and Alarms (phone), System Activity Add an annotation.

How do I view annotations in the Alarm Manager (computer or tablet) or in Alarms (phone)?

  1. Navigate to the Alarm Manager (computer or tablet) or Alarms (phone).
  2. Tap or click on an alarm. The alarm details open. When an alarm occurrence has annotations to view, the annotations icon appears.
  3. Tap or click the annotations icon.
    Note: Annotations added to an alarm do not appear in the annotations for a new occurrence of an alarm. To view annotations for a particular occurrence, tap or click the annotations icon next to the occurrence.

How do I add an annotation in the Alarm Manager (computer or tablet) or in Alarms (phone)?

  1. Navigate to the Alarm Manager (computer or tablet) or to Alarms (phone).
  2. Tap or click on an alarm.
  3. Tap or click Annotations.
    Note: Annotations added to an alarm do not appear in the annotations for a new occurrence of an alarm. To add annotations for a particular occurrence, tap or click Annotations next to the occurrence.
  4. Tap or click the Add Annotation icon. The Annotations window opens.
  5. You can select a predefined annotation from the drop-down, or you can enter your own annotation in the text box.
    Note: You can select a predefined annotation, then change the predefined text manually in the text box. This change is not subsequently reflected in the drop-down in Metasys UI or in SMP. The changed text only applies to that particular action. You can configure the predefined annotations in Metasys UI. See How do I configure a predefined annotation? for more information.
  6. Tap or click ADD. Your annotation appears in the Annotations window.

How do I add an annotation in the Command window?

  1. Tap or click the point's value to open the Command window.
  2. Select the command type from the Command drop-down menu.
    Note: On tablets and phones, tap the Command field to select the command type from the list and tap Done.
  3. Command the point as desired.
  4. You can select a predefined annotation from the drop-down, or you can enter your own annotation in the text box.
    Note: You can select a predefined annotation, then change the predefined text manually in the text box. This change is not subsequently reflected in the drop-down in Metasys UI or in SMP. The changed text only applies to that particular action. You can configure the predefined annotations in Metasys UI. See How do I configure a predefined annotation? for more information.
  5. Tap or click in the Add Annotation field to enter an optional annotation.
  6. Tap or click SAVE.
Note:
  • When adding annotations while commanding points that have audits forwarding from engines to the Site Director, the annotations may not appear immediately in the Equipment Activity widget.
  • Any Samsung™ phone for Android performs best when you use a third-party keyboard for commanding. You first need to download a third-party keyboard. To use a third-party keyboard, go to Settings > Personalization > Language and Input > Keyboard and Input Methods > Default and select a third-party keyboard. The location for changing the keyboard may vary depending on your device.

How do I add an annotation in the Bulk Command window?

  1. After you have selected your objects, select a command from the drop-down menu.
  2. You can select a predefined annotation from the drop-down, or you can enter your own annotation in the text box.
    Note: You can select a predefined annotation, then change the predefined text manually in the text box. This change is not subsequently reflected in the drop-down in Metasys UI or in SMP. The changed text only applies to that particular action. You can configure the predefined annotations in Metasys UI. See How do I configure a predefined annotation? for more information.
  3. Tap or click NEXT to see a preview of your selected command.

How do I add an annotation in System Activity?

To add a single annotation or bulk annotations to an audit, complete the following steps:
  1. Select a single audit or multiple audits by tapping or clicking the check box next to the audits.
  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. The Bulk Annotate window opens when you select multiple audits.
  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 in the audit details flyout pane:
  1. Tap or click on an audit. The audit 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.

How do I configure a predefined annotation?

  1. Open the User menu.
  2. Tap or click Administrative Tasks.
  3. Tap or click Site Settings.
  4. Tap or click Annotations.
  5. In the Predefined Annotations section, tap or click the + symbol.
  6. Enter the text for the newly created predefined annotation. Select the check box and use the arrows to change the order of the predefined annotations, if required.
  7. Tap or click SAVE.

What permissions and privileges do I need to add annotations?

The following table summarizes the permissions and privileges you need to add various annotations:
Table 2. Required permissions and privileges for adding annotations

Type of annotation

Required permissions or privileges

Adding annotations to an alarm

Manage Item Event permission

Adding annotations to a system change

Manage Audit History system access privilege

Adding annotations to a command in the Equipment Activity widget (user change)

Manage Audit History system access privilege

Adding annotations in the Command window of a point

Appropriate permissions to command the point

and

Manage Audit History system access privilege

Adding annotations to an audit in System Activity

View Metasys Status and Manage Audit History system access privileges