diff --git a/site/guide/_sidebar.yaml b/site/guide/_sidebar.yaml index 821e1d0c4..a5f2f6e9d 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 bf8771548..18f033c3e 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,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. ::: @@ -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) diff --git a/site/guide/configuration/manage-announcements.qmd b/site/guide/configuration/manage-announcements.qmd new file mode 100644 index 000000000..3babdac2d --- /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 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) + + + +[^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 39bbc4eab..425809c47 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,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. - @@ -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) diff --git a/site/guide/configuration/managing-your-organization.qmd b/site/guide/configuration/managing-your-organization.qmd index 0b282448d..c9448771a 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. diff --git a/site/llm/chatbot-product-map.md b/site/llm/chatbot-product-map.md index 49882f8af..f1a0b0a33 100644 --- a/site/llm/chatbot-product-map.md +++ b/site/llm/chatbot-product-map.md @@ -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):**