From 862e7ae1ee82674dbf3c470a5e89469938da9cfc Mon Sep 17 00:00:00 2001 From: Emma Van Der Heide Date: Wed, 30 Sep 2026 12:33:43 -0400 Subject: [PATCH 1/7] [SC-18631] Document Announcements and the My Inbox dashboard widget Adds a Manage announcements page (Settings > Announcements: levels, lifecycle, create, schedule, publish now, retire, duplicate, delete, critical email) and registers it in the sidebar and the Managing your organization listing. Adds the Announcements update type and the Critical announcements email event to the platform notifications page, and the My Inbox widget to the dashboard widget docs. Co-Authored-By: Claude Fable 5.1 --- site/guide/_sidebar.yaml | 1 + .../customize-your-dashboard.qmd | 10 +- .../configuration/manage-announcements.qmd | 107 ++++++++++++++++++ .../manage-platform-notifications.qmd | 7 ++ .../managing-your-organization.qmd | 1 + 5 files changed, 124 insertions(+), 2 deletions(-) create mode 100644 site/guide/configuration/manage-announcements.qmd diff --git a/site/guide/_sidebar.yaml b/site/guide/_sidebar.yaml index 28b811a4e0..aa372f68d7 100644 --- a/site/guide/_sidebar.yaml +++ b/site/guide/_sidebar.yaml @@ -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 diff --git a/site/guide/configuration/customize-your-dashboard.qmd b/site/guide/configuration/customize-your-dashboard.qmd index bf87715481..58bc1a709e 100644 --- a/site/guide/configuration/customize-your-dashboard.qmd +++ b/site/guide/configuration/customize-your-dashboard.qmd @@ -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] ::: @@ -216,7 +216,11 @@ 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**: + + - **Latest artifacts** and **Recent activity** widgets, as before. + - **My Inbox** — Your inbox as a widget, opening on the **Updates** tab, with the **Tasks** tab and the per-item actions from the sidebar inbox. Filters and bulk selection stay in the sidebar inbox. Acting on an item in either place updates the other. + b. Click **Add Widget** to insert the widget onto your dashboard. ::: @@ -274,3 +278,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) diff --git a/site/guide/configuration/manage-announcements.qmd b/site/guide/configuration/manage-announcements.qmd new file mode 100644 index 0000000000..87656b56ed --- /dev/null +++ b/site/guide/configuration/manage-announcements.qmd @@ -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 and Warning announcements differ only in their icon. Critical announcements are pinned to the top of My Inbox, 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 **Show 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 **Save 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 in 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) + + + +[^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) diff --git a/site/guide/configuration/manage-platform-notifications.qmd b/site/guide/configuration/manage-platform-notifications.qmd index 39bbc4eabf..cdf273615d 100644 --- a/site/guide/configuration/manage-platform-notifications.qmd +++ b/site/guide/configuration/manage-platform-notifications.qmd @@ -102,6 +102,9 @@ 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. Critical announcements are pinned to the top and cannot be dismissed while they are live. + ## 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)] @@ -128,6 +131,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. @@ -141,3 +146,5 @@ 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) diff --git a/site/guide/configuration/managing-your-organization.qmd b/site/guide/configuration/managing-your-organization.qmd index 0b282448d8..c9448771a5 100644 --- a/site/guide/configuration/managing-your-organization.qmd +++ b/site/guide/configuration/managing-your-organization.qmd @@ -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. From 4c79a3ffad20d3a1cd965ad8b5628decd0b23c77 Mon Sep 17 00:00:00 2001 From: Emma Van Der Heide Date: Wed, 30 Sep 2026 12:47:18 -0400 Subject: [PATCH 2/7] [SC-18631] Update the Inbox guide for the redesigned notifications and My Inbox widget Rewrites the filter, mark-as-read and dismiss steps for the redesigned Inbox rows (sc-18373: Update type and Show filters with chips, hover-to-select checkboxes, selection bar, Mark all as read, Restore, opening an update marks it read) and adds an Add My Inbox to your dashboard section (sc-18336). Co-Authored-By: Claude Fable 5.1 --- .../configuration/manage-announcements.qmd | 2 +- .../manage-platform-notifications.qmd | 41 +++++++++++-------- 2 files changed, 25 insertions(+), 18 deletions(-) diff --git a/site/guide/configuration/manage-announcements.qmd b/site/guide/configuration/manage-announcements.qmd index 87656b56ed..86b55dd860 100644 --- a/site/guide/configuration/manage-announcements.qmd +++ b/site/guide/configuration/manage-announcements.qmd @@ -22,7 +22,7 @@ Publish organization-wide notices, such as maintenance windows, policy changes, - 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 and Warning announcements differ only in their icon. Critical announcements are pinned to the top of My Inbox, 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 **Show dismissed only** filter in My Inbox. +- 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 diff --git a/site/guide/configuration/manage-platform-notifications.qmd b/site/guide/configuration/manage-platform-notifications.qmd index cdf273615d..2c7ae4aa81 100644 --- a/site/guide/configuration/manage-platform-notifications.qmd +++ b/site/guide/configuration/manage-platform-notifications.qmd @@ -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} @@ -40,13 +42,12 @@ 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**. +To show older updates, scroll down to the bottom and click **Load more**. Faint shading at the top or bottom of the list means more updates sit above or below the fold. @@ -59,35 +60,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 every update as read at once, click the **{{< fa ellipsis-vertical >}}** menu at the top of the list and select **Mark all as read**. ### 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] ::: @@ -105,6 +106,10 @@ Record Stage Updates 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. Critical announcements are pinned to the top and 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 and per-item actions as the sidebar inbox. Filters and multi-selection stay in 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)] @@ -148,3 +153,5 @@ Enable or disable email notifications for specific events across your organizati [^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) From 74b052acc7aeb50be538a5c3522624c582bdce3c Mon Sep 17 00:00:00 2001 From: Emma Van Der Heide Date: Thu, 1 Oct 2026 20:54:32 -0400 Subject: [PATCH 3/7] [SC-18631] Describe each Other widget in the dashboard guide Replaces the placeholder wording with one bullet per widget, using the labels from the Add Widget picker (Model Artifacts, Activity Feed, My Inbox). Co-Authored-By: Claude Fable 5.1 --- site/guide/configuration/customize-your-dashboard.qmd | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/site/guide/configuration/customize-your-dashboard.qmd b/site/guide/configuration/customize-your-dashboard.qmd index 58bc1a709e..180edffeab 100644 --- a/site/guide/configuration/customize-your-dashboard.qmd +++ b/site/guide/configuration/customize-your-dashboard.qmd @@ -218,8 +218,9 @@ c. Click **Add Visualization** to insert the visualization as a widget onto your a. Select one of the **Widgets**: - - **Latest artifacts** and **Recent activity** widgets, as before. - - **My Inbox** — Your inbox as a widget, opening on the **Updates** tab, with the **Tasks** tab and the per-item actions from the sidebar inbox. Filters and bulk selection stay in the sidebar inbox. Acting on an item in either place updates the other. + - **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 per-item actions from the sidebar inbox. Filters and bulk selection stay in 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. From 7ef9e9add7345e6b51cdd9e9b0c599e096a7c8a4 Mon Sep 17 00:00:00 2001 From: Emma Van Der Heide Date: Thu, 1 Oct 2026 21:11:34 -0400 Subject: [PATCH 4/7] Update manage-platform-notifications.qmd --- site/guide/configuration/manage-platform-notifications.qmd | 1 - 1 file changed, 1 deletion(-) diff --git a/site/guide/configuration/manage-platform-notifications.qmd b/site/guide/configuration/manage-platform-notifications.qmd index 2c7ae4aa81..1ebdc99714 100644 --- a/site/guide/configuration/manage-platform-notifications.qmd +++ b/site/guide/configuration/manage-platform-notifications.qmd @@ -49,7 +49,6 @@ b. Active filters are shown as chips above the list. Click **{{< fa xmark >}}** To show older updates, scroll down to the bottom and click **Load more**. Faint shading at the top or bottom of the list means more updates sit above or below the fold. -