Settings Page Documentation

Overview

The "Settings Page" within the Vantage analytics & data platform serves as the central hub for users to configure various application settings that impact data analysis, user preferences, and integrations. It is designed to retrieve and display personalized settings based on the user's session and allow for real-time modifications.

Purpose

The primary purpose of the Settings Page is to provide users with an interactive interface for updating their preferences and configurations. This dynamism enriches the user experience tailored to individual needs, thus enhancing the overall efficiency of the analytics platform.

Functionality

The Settings Page utilizes server-side rendering by fetching user session data and effective settings based on the logged-in user's ID. The getEffectiveSettings function pulls the appropriate configurations, which are passed to the SettingsPageClient component for rendering.

Settings

The settings configuration is critical to the user experience. Here, we detail the settings managed by the Settings Page.

1. Analytics Frequency

• Setting Name: analyticsFrequency
• Input Type: Dropdown (Select)
• Description: This setting defines how often the system refreshes analytics data. Options typically include Daily, Weekly, Monthly, or Real-time.
• Default Value: Daily
• Impact of Change: Selecting a more frequent update (e.g., Real-time) can increase resource usage and affect billing, while less frequent updates may not provide up-to-date data for decision-making.

2. Data Retention Policy

• Setting Name: dataRetentionPolicy
• Input Type: Numeric (Duration in Days)
• Description: This setting determines how long historical data is retained in the system before automatic deletion. Users can set the policy from a minimum of 30 days to a maximum of 365 days.
• Default Value: 180 days
• Impact of Change: Changing this value will influence how long data is accessible for analysis. A shorter retention period could lead to loss of historical insights, while a longer period could increase storage costs.

3. Notification Preferences

• Setting Name: notificationPreferences
• Input Type: Boolean (Checkbox)
• Description: This toggles the user's preference for receiving notifications about important updates or analyses. If enabled, users will receive alerts for critical analytics updates, scheduled tasks, or data anomalies.
• Default Value: Enabled
• Impact of Change: Toggling this setting impacts user engagement by determining whether they receive timely updates, potentially influencing their interactions with the platform.

4. Language Settings

• Setting Name: language
• Input Type: Dropdown (Select)
• Description: This setting allows users to select their preferred display language. Options might include English, Spanish, French, etc.
• Default Value: English
• Impact of Change: Changing the language setting alters the user interface language, enhancing accessibility for non-English speaking users.

Use Cases & Examples

Use Case 1: Data Update Frequency Management

A company wants to monitor sales data more closely, especially during high-traffic sales events. By changing the analytics frequency from Daily to Real-time, they can react quickly to changes in consumer behavior, such as a sudden spike in purchases.

Use Case 2: Compliance with Regulatory Standards

A financial services company is required to keep transaction records for at least five years for compliance reasons. By setting the data retention policy to the maximum of 365 days multiple times, they can ensure they have historical data for audits and internal reviews without incurring unnecessary costs.

Use Case 3: User Role-Specific Interfaces

A product manager would like to enable notifications for updates related to product performance while keeping it off for other team members. By using the notification preferences setting, they can customize engagement without affecting the whole team's experience.

Example Configuration

Let's take Use Case 1 as a detailed example of how the component might be configured:

To allow for real-time data updates during a major sale:

{
  "analyticsFrequency": "Real-time",
  "dataRetentionPolicy": 180,
  "notificationPreferences": true,
  "language": "English"
}

This configuration will allow the sales team to receive instant updates about transaction data, ensuring they can respond immediately to changing market conditions. The data will still be retained for a moderate period, thus balancing accessibility and compliance with storage limitations.