NewsBoard Documentation

Overview

The NewsBoard component is a user interface module in the Vantage analytics & data platform that displays real-time notifications and updates to users. It aggregates messages regarding system alerts, task assignments, and billing updates, providing a concise overview of important activities. The NewsBoard not only renders a notification feed but also allows users to manage their notifications effectively, enabling actions such as marking them as read or dismissing them.

Purpose

The primary purpose of the NewsBoard component is to enhance user experience by keeping users informed about relevant notifications and updates within the platform. It aims to facilitate efficient workflow management by allowing users to track and respond to notifications as they arise.

Data Expectations

The NewsBoard expects to receive the following data from the underlying notification store:

• Notifications: An array of notification objects, each containing properties like id, title, message, severity, type, created, and status.
• Unread Count: A numeric count of unread notifications.

How It Works

1. Data Fetching:

   • On component mount, the NewsBoard fetches notifications and news tile content from specific API endpoints.
   • The notifications are fetched with a limit (e.g., 20) to avoid overloading the component with excessive data.

2. Sorting Notifications:

   • The notifications are sorted according to severity, with critical notifications appearing first.
   • The component provides visual indicators (icons) for different severities (e.g., critical, warning, information).

3. User Actions:

   • Users can mark notifications as read or dismiss them directly from the notification feed.
   • A modal can be opened to view all notifications in detail.

4. Dynamic Rendering:

   • The component renders a visual representation of notifications and their current state, updating reactively based on user interactions or incoming data.

Settings

The following settings are critical for configuring the NewsBoard component:

Use Cases & Examples

Use Cases

1. System Alerts: A company can use the NewsBoard to notify users of critical system updates or emergencies, ensuring that users have real-time access to urgent information.
2. Task Management: Teams can implement the NewsBoard to deliver notifications regarding task assignments, reminders for deadlines, and updates on team activities, thereby improving productivity.
3. Billing Notifications: Businesses can leverage the component to inform users about billing updates, payment reminders, or account status changes to maintain transparent financial communication.

Example Configuration

Use Case: Task Management Notifications

To implement a use case where the NewsBoard is used for task management notifications, consider the following configuration:

const notifications = [
    {
        id: '1',
        title: 'New Task Assigned',
        message: 'You have been assigned a new task: Update the project documentation.',
        severity: 'info',
        type: 'task',
        created: '2023-10-10T12:00:00Z',
        status: 'unread'
    },
    {
        id: '2',
        title: 'Task Deadline Approaching',
        message: 'The deadline for your task "Update the project documentation" is this Friday.',
        severity: 'warning',
        type: 'task',
        created: '2023-10-11T09:00:00Z',
        status: 'unread'
    },
    {
        id: '3',
        title: 'Task Completed',
        message: 'You have marked "Update the project documentation" as completed.',
        severity: 'info',
        type: 'task',
        created: '2023-10-11T15:00:00Z',
        status: 'read'
    }
];

// Implementing the NewsBoard component
<NewsBoard 
    notifications={notifications} 
    unreadCount={2} 
    fetchNotifications={yourFetchFunction} 
    markAs={yourMarkAsFunction} 
    openModal={yourOpenModalFunction} 
/>

In this configuration example, the notifications array contains multiple task-related notifications, showcasing both urgent and informational messages. The unreadCount reflects the number of notifications that need the user's attention.

This setup allows users to get alerted to tasks assigned to them, reminders about deadlines, and updates on the status of their work—providing comprehensive management of their task workflow directly through the NewsBoard component within the Vantage platform.