[dashboardId]-page

Purpose

The [dashboardId]-page is a part of the Vantage analytics and data platform that dynamically renders a dashboard based on the provided dashboardId. This page leverages the DashboardWrapper component, ensuring that the appropriate dashboard is displayed corresponding to the unique identifier passed in the URL. The main purpose is to serve as a versatile dashboard interface for users, allowing them to visualize data effectively.

How It Works

When a request is made to the [dashboardId]-page, the application retrieves the dashboardId from the URL parameters. The page performs a validity check to ensure that the dashboardId is a valid integer. If the dashboardId fails this validation check, the user is redirected to a "not found" page. Otherwise, the DashboardWrapper component is rendered, passing the validated dashboardId as a prop to it. The DashboardWrapper component is responsible for fetching data related to the specified dashboard and managing the presentation logic.

Data Expectations

The [dashboardId]-page expects:

• dashboardId: A valid integer that corresponds to an existing dashboard in the Vantage analytics platform. If the dashboardId isn't a valid integer or doesn't exist, the user will be redirected to an error page.

Settings

The configuration options for the [dashboardId]-page primarily revolve around the properties passed to the DashboardWrapper component:

Settings Overview:

1. dashboardId
   • Input Type: Numeric (integer)
   • Description: This setting represents the unique identifier for the dashboard that the DashboardWrapper will display. It determines which dashboard will render its specific components and data.
   • Effect of Change: Modifying this value to a different integer will change the displayed dashboard to the one associated with that new dashboardId. If set incorrectly (i.e., not a valid integer), it leads to redirection to the not-found page.
   • Default Value: No default value as it is derived directly from the URL parameters.

Use Cases & Examples

Use Case 1: Personalized Dashboards for Clients

A consulting firm may have multiple clients, each requiring different data insights. The [dashboardId]-page allows the firm to generate a specific dashboard for each client. By dynamically rendering the dashboard with unique client identifiers, the firm can ensure that each client views only their relevant data.

Use Case 2: Performance Monitoring

An organization wants to monitor key performance indicators (KPIs) for various departments in real-time. Each department has its own dashboard containing metrics pertinent to their operations. The [dashboardId]-page enables users to easily navigate to their department dashboards by appending the corresponding dashboardId.

Use Case 3: Data-Driven Decision Making

A data team needs to provide real-time analytics for different company branches. Across multiple offices, various dashboards are set up to display pertinent business data. The [dashboardId]-page allows users to access relevant data quickly by navigating through specified dashboardIds in their URLs.

Example Configuration

To provide a concrete example, let’s take the second use case where different departments need to monitor their KPIs using unique dashboard identifiers.

Suppose the IT department has a dashboard ID of 101 and the Marketing department has a dashboard ID of 102. Here’s how the URLs would look:

• For the IT department dashboard:

  /dashboard/101

• For the Marketing department dashboard:

  /dashboard/102

In this configuration, when a user accesses /dashboard/101, the dashboardId of 101 is passed to the DashboardWrapper, rendering the IT dashboard with KPIs relevant to their needs. If an invalid dashboardId is entered, the user is redirected to a "not found" page.

This behavior demonstrates the dynamic capability of the [dashboardId]-page, reinforcing its utility in providing tailored analytical insights across various business functions within the Vantage platform.