InputTile Documentation

Overview

The InputTile component is designed to provide a user-friendly interface for quick configuration controls on a dashboard for another tile. It allows users to adjust data configurations—like datasets and labels—without needing to open a separate editing modal for the target tile. This enhances productivity and provides more immediate interactivity for users working within the Vantage data platform.

Purpose

• Offers an intuitive input interface for configuring linked tiles.
• Provides quick modification of data settings for enhanced user experience.
• Improves visual feedback and immediate updates of dashboard components.

Settings

1. Title

• Type: String
• Description: The main title displayed at the top of the tile. This helps users identify the purpose of the tile at a glance.
• Default Value: 'Input Controls'

2. Subtitle

• Type: String (optional)
• Description: A secondary title that gives additional context to the user about the input tile. Can be used to show information or instructions related to the linked tile.
• Default Value: undefined (not set by default)

3. Linked Tile ID

• Type: String
• Description: The unique identifier for the tile this InputTile is expected to control. It should match the ID of an existing tile within the dashboard.
• Default Value: undefined (must be configured)

4. Target Tile Type

• Type: String
• Description: Specifies the type of tile that the InputTile is linked to (e.g., 'comparison', 'summary', 'forecast', etc.). This setting determines the specific input fields that will be rendered on the tile.
• Default Value: 'unknown'

5. Dashboard Tiles

• Type: Array
• Description: This is a representation of all tiles currently in the dashboard. The InputTile accesses this to find the linked tile and make updates accordingly.
• Default Value: N/A - dynamically populated from the dashboard store.

6. Save Dashboard

• Type: Function
• Description: This function is called to save any changes made to the dashboard settings and configurations.
• Default Value: N/A - must be defined in the dashboard store.

7. Workflow Data Cache

• Type: Object
• Description: This object serves as a temporary storage for cached workflow results that can be used to update the dashboard without additional network calls.
• Default Value: N/A - initialized based on the dashboard store.

8. Show Data Selector

• Type: Boolean
• Description: This state variable determines whether the Advanced Data Selector modal is currently open for user interaction.
• Default Value: false

9. Data Selector Configuration

• Type: Object
• Description: Holds configuration settings for the Advanced Data Selector, such as the current workflow ID and the label for data selection.
• Default Value: null

10. Refreshing Tile

• Type: Boolean
• Description: Indicates the current state of a refresh action for the linked tile, allowing for UI feedback like loading indicators.
• Default Value: false

How It Works

• The InputTile retrieves its configuration settings to identify and interact with its linked tile using the linkedTileId.
• It continuously monitors changes to its own inputs, indicating to users when there are unsaved changes.
• Depending on the configured targetTileType, it renders specific input fields appropriately tailored for the type of tile it controls, ensuring proper data mapping and configuration.
• It can fetch available workflows and display loading states while performing data operations such as refreshing or saving.

Data Expectations

The InputTile expects the following data:

• A valid linkedTileId corresponding to an existing tile.
• Access to the correct tile configuration from the dashboard store to maintain the applicable input field mappings.
• Workflows must be defined in the system to interact with various linked tile functionalities.

AI Integrations

The InputTile has potential integrations with AI functionalities through configurations specified for target tile types like 'summary', 'forecast', and 'predictiveinsights'. These target types imply the need for specialized processing or machine learning workflows that can be initiated from this input tile.

Billing Impacts

Usage of the InputTile may indirectly affect billing based on the complexity of workflows it triggers or manages:

• If workflows are computationally expensive or require extensive data processing, they may incur higher billing rates depending on the pricing model of the Vantage platform.
• Efficient use of caching mechanisms may help mitigate costs associated with frequent data processing or fetching.

Use Cases & Examples

Use Cases

1. Market Analysis Dashboard: A financial analyst can use an InputTile to adjust parameters for a predictive insights tile that forecasts stock prices based on varying historical data input.

2. Sales Performance Tracking: A sales manager could leverage an InputTile to dynamically adjust input fields providing the sales team with real-time updates on forecasting metrics and analytical summaries.

3. Data Reporting Tool: A report generator can employ the InputTile to facilitate user selections of datasets to generate reports from a configuration tile linked to various BI intelligence charts.

Example Configuration

Business Scenario: A Sales Manager wants to create a dashboard to monitor sales forecasts based on varying input parameters like sales regions and product categories.

Sample Configuration Data:

{
  "config": {
    "linkedTileId": "salesForecastTile",
    "targetTileType": "forecast"
  },
  "props": {
    "title": "Sales Forecast Controls",
    "subtitle": "Adjust parameters to see live sales forecasts"
  }
}

In this case, the InputTile allows the Sales Manager to tweak configurations like product line selection and geographic region directly on the dashboard, updating the linked salesForecastTile with live forecasts based on the latest data inputs.