Skip to content
Merged
1 change: 1 addition & 0 deletions site/guide/_sidebar.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ website:
contents:
- guide/configuration/set-up-your-organization.qmd
- guide/configuration/manage-platform-notifications.qmd
- guide/configuration/manage-announcements.qmd
- file: guide/configuration/configuring-private-connectivity.qmd
contents:
- guide/configuration/configure-aws-privatelink.qmd
Expand Down
11 changes: 9 additions & 2 deletions site/guide/configuration/customize-your-dashboard.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Retrieves a saved artifacts view.[^3]
Retrieves an analytics visualization.[^4]

##### {{< fa flask >}} Other
Retrieve a list of the latest artifacts[^5] or recent activity.[^6]
Retrieve a list of the latest artifacts,[^5] recent activity,[^6] or your own inbox.[^my-inbox]

:::

Expand Down Expand Up @@ -216,7 +216,12 @@ c. Click **Add Visualization** to insert the visualization as a widget onto your

#### {{< fa flask >}} Other

a. Select one of the **Widgets**.
a. Select one of the **Widgets**:

- **Model Artifacts** — The latest artifacts across the records you have access to, with a sort selector so you can order them by date, severity, or status.[^5]
- **Activity Feed** — The most recent activity across your records, shown on the dashboard as Recent Activity.[^6]
- **My Inbox** — Your inbox as a widget, opening on the **Updates** tab, with the **Tasks** tab and the same filters, selection, and per-item actions as the sidebar inbox. Acting on an item in either place updates the other.[^my-inbox]

b. Click **Add Widget** to insert the widget onto your dashboard.

:::
Expand Down Expand Up @@ -274,3 +279,5 @@ Removing a widget from a dashboard will not delete the linked view or analytics
[^roles]: [Manage roles](/guide/configuration/manage-roles.qmd)

[^stakeholders]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)

[^my-inbox]: [Manage platform notifications](/guide/configuration/manage-platform-notifications.qmd)
107 changes: 107 additions & 0 deletions site/guide/configuration/manage-announcements.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
---
# Copyright © 2023-2026 ValidMind Inc. All rights reserved.
# Refer to the LICENSE file in the root of this repository for details.
# SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial
title: "Manage announcements"
date: last-modified
---

Publish organization-wide notices, such as maintenance windows, policy changes, and process reminders, that reach every member of your organization in **{{< fa inbox >}} My Inbox**.

::: {.attn}

## Prerequisites

- [x] {{< var link.login >}}
- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble}.[^1]

:::

## How announcements work

- Every active member of your organization receives each announcement in **{{< fa inbox >}} My Inbox** under **Updates**, and in the My Inbox dashboard widget if they have added it.[^2] Members added to the organization while an announcement is live receive it when they join.
- Each announcement has a **Level**: **Info**, **Warning**, or **Critical**. Info announcements are shown in blue and Warning announcements in yellow, each with its own icon. While an announcement is live it is pinned above other updates in My Inbox, with Critical announcements first. Critical announcements also cannot be dismissed while they are live, and are emailed to every member when published.[^3]
- An announcement moves through **Draft**, **Scheduled**, **Live**, and then **Retired** or **Expired**. Live and finished announcements cannot be edited, because every inbox already holds its own copy. To publish a corrected version, duplicate the announcement and publish the copy.
- Members can dismiss Info and Warning announcements. Dismissed announcements remain available under the **Dismissed only** filter in My Inbox.
- Creating, scheduling, publishing, retiring, and deleting announcements is recorded in the settings activity log.[^4]

## Create an announcement

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under {{< fa building >}} Organization, select **Announcements**.

3. Click **{{< fa plus >}} Add Announcement**.

4. Enter a **Title** and a **Message**. The message supports rich text formatting and links.

5. Select a **Level**: **Info**, **Warning**, or **Critical**.

6. Click **Create Draft**. The announcement's detail page opens.

## Schedule or publish an announcement

On the announcement's detail page:

1. Set the **Start** and **End** date and time. Times are entered in your local time and shown to each member in theirs.

- **Start** is required to schedule. Leave it empty if you plan to publish immediately.
- **End** is optional. Leave it empty to keep the announcement live until you retire it.

2. Choose how to send it:

- Click **Schedule** to publish automatically at the start time.
- Click **Publish Now** to make it live immediately, then confirm. For a Critical announcement, the confirmation notes that every member will be emailed.

Once live, the announcement is read-only. You can still **Retire** or **Duplicate** it.

## Retire, duplicate, or delete an announcement

::: {.panel-tabset}

### Retire

Retiring ends a live announcement early for everyone.

a. Open the announcement from the list under **Settings** > **Announcements**.

b. Click **Retire**, then confirm.

The copies in members' inboxes remain, marked **Ended**, and can now be dismissed.

### Duplicate

Duplicating creates a new draft with the same title, message, and level, and no dates. Use it to republish a corrected version of a live or finished announcement.

a. Open the announcement.

b. Click **Duplicate**. The new draft opens.

### Delete

Only drafts can be deleted, since nobody has received them.

a. Open the draft.

b. Click **Delete**, then confirm.

:::

## Email for critical announcements

Critical announcements are emailed to every active member when they are published, provided the **Critical announcements** event is enabled under **Settings** > **Email Notifications**.[^3] If it is disabled, the announcement is still pinned at the top of My Inbox and cannot be dismissed, and the confirmation after publishing tells you that no email was sent.

## What's next

- [Manage platform notifications](manage-platform-notifications.qmd)
- [Customize your dashboard](customize-your-dashboard.qmd)

<!-- FOOTNOTES -->

[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd)

[^2]: [Customize your dashboard](/guide/configuration/customize-your-dashboard.qmd#manage-widgets)

[^3]: [Customize email notifications](/guide/configuration/manage-platform-notifications.qmd#customize-email-notifications)

[^4]: [View settings activity](/guide/reporting/view-settings-activity.qmd)
49 changes: 31 additions & 18 deletions site/guide/configuration/manage-platform-notifications.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ Unread {{< fa bell >}} Updates will be marked with a [pink {{< fa circle >}}]{.p

2. Select the **Updates** tab.

Each update is a self-contained row: a type icon, a bold title, when it happened, a context line with the record or workflow it belongs to, and any actions one step below. Updates about you read as "You were …"; updates about others name them. Click an update to open what it refers to, which also marks it as read.

3. From the in-{{< var vm.platform >}} inbox, review updates, accept invites, mark updates as read, or dismiss updates entirely:

::: {.panel-tabset}
Expand All @@ -40,15 +42,13 @@ To filter updates:

a. Click **{{< fa filter >}} Filter** to narrow down the kinds of updates displayed:

- Select between a number of different in-{{< var vm.platform >}} notifications with the drop-down menu.[^1]
- Click **Show unread only** to display only unread updates.
- Click **Show dismissed only** to display only dismissed updates.
- Under **Update type**, select one of the in-{{< var vm.platform >}} notification types, or **All types**.[^1]
- Under **Show**, select **Unread only** to display only unread updates, or **Dismissed only** to display only dismissed updates.

b. Click **Apply Filters** to narrow down results based on your selections.
b. Active filters are shown as chips above the list. Click **{{< fa xmark >}}** on a chip to remove that filter, or **Clear all** to remove them all.

To show older updates, scroll down to the bottom and click **Load More**.
Older updates load as you scroll down. If your filters hide everything loaded so far, click **Load more** to fetch older updates. Faint shading at the top or bottom of the list means more updates sit above or below the fold.

<!-- AS PER NATE THE BELOW IS NOT LIVE YET -->

<!-- ### Accept invites

Expand All @@ -59,35 +59,35 @@ Invites to join a {{< var vm.product >}} organization offer the option to accept

### Mark updates as read

To mark an individual update as read:
Opening an update marks it as read. To mark an individual update as read or unread without opening it:

a. Hover over the update you want to mark as read.
a. On the update's row, click the **{{< fa ellipsis-vertical >}}** menu.

b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa envelope >}} Mark as Read**.
b. Select **Mark as read** or **Mark as unread**.

To mark multiple updates as read:

a. Click **{{< fa square-check >}} Select** to multi-select updates.
a. Hover over the type icon of an update until it becomes a checkbox, then select it. Select the checkboxes for the other updates you want to include, or click **Select all loaded updates**.

b. Select the checkboxes for the updates you want to mark as read.
b. On the selection bar that appears at the bottom of the list, confirm the number of updates selected, then select **Mark as read**.

c. Confirm the number of updates you've flagged to be marked as read, then select **{{< fa envelope >}} Mark as Read**.
To mark all loaded updates as read, click **Mark all as read** in the toolbar above the list. This marks the unread updates loaded so far that match your current filters, not every update you have ever received.

### Dismiss updates

To dismiss an individual update:

a. Hover over the update you want to dismiss.
a. On the update's row, click the **{{< fa ellipsis-vertical >}}** menu.

b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa bell-slash >}} Dismiss**.
b. Select **Dismiss**. The confirmation offers **Undo** for a moment afterwards.

To dismiss all updates:
To dismiss multiple updates:

a. Click **{{< fa square-check >}} Select** to multi-select updates.
a. Hover over the type icon of an update until it becomes a checkbox, then select it. Select the checkboxes for the other updates you want to include, or click **Select all loaded updates**.

b. Select the checkboxes for the updates you want to dismiss.
b. On the selection bar that appears at the bottom of the list, confirm the number of updates selected, then select **Dismiss**.

c. Confirm the number of updates you've flagged to be dismissed, then select **{{< fa bell-slash >}} Dismiss**.
Dismissed updates remain available under the **Dismissed only** filter, where **Restore** on the **{{< fa ellipsis-vertical >}}** menu returns one to your inbox. Live critical announcements cannot be dismissed and are skipped when you dismiss a selection.[^announcements]

:::

Expand All @@ -102,6 +102,13 @@ Record Invites
Record Stage Updates
: Record stage transitions on your records.[^4]

Announcements
: Organization-wide notices published by your Customer Admins.[^announcements] Each shows its level, an excerpt, and how long it stays live; click it to read the full message. Live announcements are pinned above your other updates, Critical ones first. Critical announcements cannot be dismissed while they are live.

## Add My Inbox to your dashboard

You can also add **My Inbox** to a dashboard as a widget, under **Add Widget** > **Other**.[^my-inbox-widget] The widget opens on the **Updates** tab and offers the same **Tasks** and **Updates** tabs, filters, selection, and per-item actions as the sidebar inbox. Acting on an item in either place updates the other.

## Document jobs in your inbox {#document-jobs}

**{{< fa inbox >}} My Inbox** also shows long-running document jobs while they are in progress: reading an uploaded PDF so it can be checked, and the {{< var vm.checker >}} run itself.^[[Check documents for compliance](/guide/documentation/check-documents-for-compliance.qmd)]
Expand All @@ -128,6 +135,8 @@ Enable or disable email notifications for specific events across your organizati

3. Toggle the options for each event on or off according to your requirements.

**Critical announcements** controls whether every member is emailed when a Customer Admin publishes a critical announcement.[^announcements]

4. Click **Save Changes** to apply your adjustments.

<!-- FOOTNOTES -->
Expand All @@ -141,3 +150,7 @@ Enable or disable email notifications for specific events across your organizati
[^4]: [Working with workflows](/guide/workflows/working-with-workflows.qmd)

[^5]: [Manage permissions](/guide/configuration/manage-permissions.qmd)

[^announcements]: [Manage announcements](/guide/configuration/manage-announcements.qmd)

[^my-inbox-widget]: [Customize your dashboard](/guide/configuration/customize-your-dashboard.qmd#manage-widgets)
1 change: 1 addition & 0 deletions site/guide/configuration/managing-your-organization.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ listing:
contents:
- set-up-your-organization.qmd
- manage-platform-notifications.qmd
- manage-announcements.qmd
---

Access to the {{< var validmind.platform >}} is associated with an organization, which encompasses all your users, groups, and business units. As a user, you can belong to multiple organizations.
Expand Down
2 changes: 1 addition & 1 deletion site/llm/chatbot-product-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@
**Docs (primary):**

- `/guide/configuration/manage-platform-notifications.html` (section: #customize-email-notifications)
- Sections: Prerequisites; View platform notifications; Review updates; Mark updates as read; Dismiss updates; Document jobs in your inbox; Customize email notifications
- Sections: Prerequisites; View platform notifications; Review updates; Mark updates as read; Dismiss updates; Add My Inbox to your dashboard; Document jobs in your inbox; Customize email notifications

**Docs (related):**

Expand Down