Audit Message Annotations - Metasys - LIT-1201793 - Software Application - Site Management Portal - 12.0.50

Metasys Site Management Portal Help

Brand
Metasys
Product name
Site Management Portal
Document type
User Guide
Document number
LIT-1201793
Version
12.0.50
Revision date
2023-06-02
Language
English

An annotation is a textual string associated with an audit message. You can view or add annotations from the ADS (ADX) audit repository only. You cannot edit an existing annotation. Instead, add a new annotation to the audit message. You can also define custom annotations. See Adding Annotations, Viewing Annotations, and Creating Annotations.

Note: The annotation feature is not available on the Engine local audit repository.

The following table describes the fields of an annotation.

Table 1. Audit Message Annotations

Field

Description

User

When adding annotations, indicates the user ID of the person associated with the action that generated the audit message.

When viewing annotations, the first User field displayed indicates the user ID of the person associated with the action that generated the audit message. The User field displayed under the Annotation Information section indicates the user ID of the person that added the annotation.

Date and Time

When adding annotations, indicates the date and time the audit message was generated.

When viewing annotations, the first Date and Time field displayed indicates the date and time the audit message was generated. The Date and Time field displayed under the Annotation Information section indicates the date and time the annotation was added to the audit message. The date and time format is defined by the language selected in the User Profile (User Profile tab section of the Security Administrator System).

Item Reference

Indicates the complete Item Reference of the item associated with the audit message.

Description

Provides the description of the action that generated the audit message. For example, Enabled appears in this field if you send an Enable command to an item. The descriptions come from the State, Mode, and Type Sets associated with the item that generated the audit message.
Note: If the Class level is Non-Critical System Error or Diagnostics and the Action Type is Error, then an associated error string appears.

Annotation

Allows you to select from a list of predefined annotations or add or view a text string (annotation) of up to 254 characters describing the associated audit message.

Navigation Controls

If the audit message has multiple annotations associated with it, allows you to navigate through the annotations. Use the buttons to go to the first annotation, previous annotation, next annotation, or last annotation.

The text box displays the number of the annotation being viewed. The Annotations feature automatically assigns a number to each annotation created. For example, if the audit message has three annotations, the number being displayed in this section can be 1, 2, or 3 depending on the annotation being viewed. Type a number in the text box and press the enter key to jump directly to a specific annotation.