# Alert System

The Alert System keeps you informed about events relevant to your work in OtisEd.Nimble. Alerts are delivered as in-app messages that appear in your dashboard. You control which events generate alerts for you by managing your subscriptions.

## Contents

* [How Alerts Work](#how-alerts-work)
* [Viewing Your Alerts](#viewing-your-alerts)
* [Dismissing Alerts](#dismissing-alerts)
* [Alert History](#alert-history)
* [Managing Subscriptions](#managing-subscriptions)
* [Site-Wide Alert Banners](#site-wide-alert-banners)
* [Troubleshooting](#troubleshooting)

***

## How Alerts Work

When a subscribed event occurs in the portal, the system creates an in-app message for each subscribed user. Messages are scoped to your account — only you see your own alerts.

Alerts have two states:

* **Unread** — the message has arrived and has not been dismissed.
* **Read** — you have dismissed the message from the active view.

Both states are retained in your message history so you can review past notifications.

***

## Viewing Your Alerts

Active (unread) alerts appear in the **Messages** widget on your dashboard. The widget header shows a count of unread messages, for example **Messages (3)**.

The widget displays up to five unread messages at a time. Each row shows:

* The date and time the message was delivered.
* The message body describing the event.
* A **Dismiss** button.

If you have more than five unread messages, dismissing visible messages reveals the next ones in the queue.

When you have no unread messages the widget is hidden automatically — no empty panel is shown.

***

## Dismissing Alerts

To dismiss an alert, click the **Dismiss** button on the message row. The message is marked as read and removed from the active widget. Dismissed messages are not deleted; they move to your message history.

> The dismiss action is immediate and cannot be undone from the dashboard widget. Review the message content before dismissing if you need to retain it for reference.

***

## Alert History

Your full message history is available on the **User Profile** page under the **Message History** tab.

To navigate there directly, click the **Notification Settings** gear icon in the Messages widget header. This opens your profile page at the correct tab.

The Message History view shows a sortable table with these columns:

| Column  | Description                                 |
| ------- | ------------------------------------------- |
| Subject | The alert subject line                      |
| Body    | The full message text                       |
| Date    | The calendar date the message was delivered |
| Time    | The time of delivery                        |

Messages are paginated when more than ten records exist. You can sort by any column.

***

## Managing Subscriptions

You choose which event types generate alerts for you. Subscriptions are managed through the **Notification Subscription** widget, which is available on the dashboard.

### Viewing Available Alerts

The Notification Subscription widget displays up to five event types. Each row shows:

* **Alert Name** — the name of the notification event.
* **Subscribed** — your current subscription status, with an action button.

### Subscribing to an Alert

If the action button reads **subscribe** (green), click it to start receiving alerts for that event. The button changes to **unsubscribe** immediately to confirm the change.

### Unsubscribing from an Alert

If the action button reads **unsubscribe** (red), click it to stop receiving alerts for that event. The button reverts to **subscribe** to confirm the change.

> Subscribing and unsubscribing take effect immediately. Events that fired before you subscribed do not generate retroactive messages.

***

## Site-Wide Alert Banners

Administrators can publish a site-wide alert message that appears as a banner at the top of the page. This is separate from your personal in-app messages and does not require a subscription.

The banner remains visible until you close it using the **X** button at the right side. Once you close a banner, it does not reappear for that message text, even after you log out and back in.

> If a new banner message is published after you closed a previous one, the new banner will appear again on your next visit.

***

## Troubleshooting

**The Messages widget is not visible on my dashboard.** The widget only appears when you have at least one unread message. If you have no active alerts, the widget is hidden. Check your message history on the User Profile page to confirm whether any messages have been delivered.

**I dismissed a message by mistake.** Dismissed messages are recorded in your message history under User Profile > Message History. The message text is retained there even after dismissal.

**A subscription button is not responding.** If clicking subscribe or unsubscribe does not appear to take effect, refresh the page and try again. If the problem persists, contact your system administrator.

**I am not receiving alerts for an event I subscribed to.** Confirm that the event appears in your Notification Subscription widget with the **unsubscribe** button visible, indicating an active subscription. Alerts are only generated for events that occur after you subscribed. If events are occurring and you are still not receiving messages, contact your system administrator.

**The Notification Subscription widget shows fewer events than expected.** The widget displays a maximum of five event types. If more event types are configured by your administrator, they may not all appear in the widget. Contact your administrator for a full list of available notification events.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://nimble.docs.otised.com/guides/alert-system.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
