[Index]

Model: data/Alert

Alerts

An Alert list can be exposed on the GUI by adding the data/Alert model to the administrator menu. This will enable an administrator to inspect the list of alert messages.

The Alert list is summarized by:

Administrators can also filter alerts by any of these fields.

When features are enabled to send alert messages, these are recorded in the list. Each alert also has such properties as a severity (Error, Warning or Info), the number of times that the same alert has been raised and the time stamp of the last alert instance. See: Field Reference for data/Alert.

When an alert is raised, the Notifications indicator on the main user interface will show this. Clicking the Notifications button will show a message in red that alerts have been raised: "There are one or more alerts. Click here to view them." When clicking on this message, the user is directed to the list of alert messages.

Alert messages can be inspected and then acted upon by the administrator. If an issue that raised the alert has been resolved, the administrator can delete the alert from the list. If no alerts are present in the list, no notification is shown.

Enable Database Scheduling

If any of the following messages are shown upon login or when typing health login, the steps below should be carried out:

For general information on scheduling, see: Scheduling.

For considerations and guidance on frequency of the schedule to set up for your system. see the System Maintenance section of the Best Practices Guide.

Important

Schedules must be set up on all unified nodes. This ensures that they still run in the event of a failover and DR scenario.

Used to inform admin users when a note-worthy event takes place on the system

Model Details

Title Description Details
ID * The unique ID of the alert
  • Field Name: alert_id
  • Type: String
Code * The code of the alert
  • Field Name: alert_code
  • Type: String
Category * The category of the alert
  • Field Name: alert_category
  • Type: String
Severity The severity of the alert
  • Field Name: alert_severity
  • Type: String
  • Choices: ["Error", "Warning", "Info"]
Message The message describing the alert
  • Field Name: alert_message
  • Type: String
Count The number of times this alert has occurred
  • Field Name: alert_count
  • Type: Integer
Latest Alert The last time this alert occurred
  • Field Name: alert_timestamp
  • Type: String
  • Format: date-time
API reference for data/Alert