ScenarioPlannerTile Documentation

Overview

The ScenarioPlannerTile is an AI-powered analytics component integrated into the Vantage platform, enabling users to conduct scenario planning by adjusting various variables and analyzing the potential outcomes. This tile facilitates "what-if" analyses by allowing users to model different business scenarios based on user-defined workflows, variables, and key performance indicators (KPIs).

Purpose

The primary purpose of the ScenarioPlannerTile is to provide an interactive interface for businesses to run scenario analyses dynamically. It allows users to hypothesize changes in certain variables and see how those changes could impact key performance metrics over time.

Data Requirements

The ScenarioPlannerTile expects the following data to function correctly:

• scenarioWorkflows: An array of identifiers for scenario workflows.
• scenarioPrompt: A string used as a base prompt for AI-generated analysis.
• scenarioVariables: An array of objects defining the variables available for adjustment, including their names, default values, minimum and maximum ranges, and units.
• scenarioKPIs: An array of KPIs to assess the scenarios.
• scenarioOutputs: An array of output specifications relevant to the scenario.

Settings

The component has several configurable settings that can alter its behavior and appearance:

1. Title

• Input Type: String
• Description: This setting defines the primary title displayed at the top of the tile.
• Default Value: 'Scenario Planner'

2. Subtitle

• Input Type: String (Optional)
• Description: This setting is used for an optional subtitle that appears underneath the title, providing additional context about the tile's functionality.
• Default Value: (None, optional)

3. scenarioWorkflows

• Input Type: Array of Strings
• Description: An array of workflow identifiers that will define the specific scenarios to be analyzed. The tile uses these identifiers to fetch relevant data for the scenarios.
• Default Value: []

4. scenarioPrompt

• Input Type: String
• Description: This prompt is utilized as a base input for the AI engine during scenario analysis. It helps guide the generated outcomes and impacts.
• Default Value: ''

5. scenarioVariables

• Input Type: Array of Objects
• Description: Each object in this array defines a variable that users can adjust when setting up their analysis. A variable object typically includes properties like name, default, min, max, and unit.
• Default Value: []

6. scenarioKPIs

• Input Type: Array of Strings
• Description: An array of key performance indicators relevant to the scenario analysis. These KPIs will be affected by the variable adjustments made.
• Default Value: []

7. scenarioOutputs

• Input Type: Array of Strings
• Description: An array that specifies what outputs users would like to see from their scenario analyses. These outputs focus the analysis on specific data points of interest.
• Default Value: []

How It Works

1. State Management: The component manages state using internal state management to hold variable values and scenarios. The initial values are derived from the configuration provided.

2. Cache Mechanism: It uses a session-level cache to store the results of previous analyses, which speeds up the retrieval of results that have already been computed, avoiding repeated API calls.

3. Scenario Analysis Execution: When the "Run Analysis" button is clicked, the component sends a POST request to an API endpoint with relevant data, including the adjusted variable values, workflows, prompt, KPIs, and output specifications. This request is processed to generate predictions.

4. Display Logic: Depending on the state (loading, error, or data ready), different user interfaces are displayed. The main content area will show variable sliders for user adjustments and a prompt editor for any custom input on scenario descriptions.

5. Dynamic Updates: The component listens for changes in scenario variables and updates the displayed values accordingly, re-running the analysis as necessary based on user inputs.

Use Cases & Examples

Use Cases

1. Business Forecasting: A retail company can use the ScenarioPlannerTile to adjust variables such as marketing budgets, discount rates, and inventory levels to forecast sales over different scenarios.

2. Sensitivity Analysis: A financial institution can utilize the tile to analyze the sensitivity of their loan portfolio under varying interest rate scenarios and understand how these variables will affect overall risk.

3. Change Management: A project manager can model different 'what-if' scenarios based on potential changes in project scope or timelines, evaluating impacts on resource allocation and cost.

Example Configuration

Use Case: A company wants to predict the outcomes of varying the marketing budget and discount rates to project changes in sales.

Scenario Configuration Sample:

{
  "title": "Sales Forecast Planner",
  "subtitle": "Analyze the impact of marketing spend and discounts",
  "scenarioWorkflows": ["workflow1", "workflow2"],
  "scenarioPrompt": "Analyze how marketing budget and discount rates affect sales performance.",
  "scenarioVariables": [
    {
      "name": "Marketing Budget",
      "default": 5000,
      "min": 0,
      "max": 10000,
      "unit": "$"
    },
    {
      "name": "Discount Rate",
      "default": 10,
      "min": 0,
      "max": 50,
      "unit": "%"
    }
  ],
  "scenarioKPIs": ["Total Sales", "Customer Acquisition Cost"],
  "scenarioOutputs": ["Projected Revenue", "Net Profit"]
}

This configuration sets up the ScenarioPlannerTile to let users adjust the marketing budget and discount rate to get insights on how these changes influence total sales and overall profitability.