BiIntelligenceTile Documentation
Overview
The BiIntelligenceTile is an AI-powered business intelligence visualization component designed to analyze multiple workflows and identify alerts and opportunities within the data. It utilizes advanced machine learning algorithms to provide actionable insights displayed with relevant attributes such as priority, confidence, timeline, and impact. The tile includes caching mechanisms to optimize performance during sessions, preserving data across tab switches and refreshing only when necessary.
Purpose
- The primary function of the
BiIntelligenceTileis to deliver business insights derived from various workflows. - It serves to automate the identification of potential risks and opportunities, enhancing decision-making processes.
How It Works
- Insight Generation: When initialized, the tile retrieves user-defined workflows and optionally a custom prompt for insight generation.
- Data Caching: A session-level cache is implemented to store generated insights, reducing unnecessary re-fetching.
- User Interaction: Users can interact with the generated insights, fetching more details via a modal interface and refreshing insights as needed.
Expected Data
- The component expects:
- workflowIds: An array of IDs corresponding to the workflows the user wants the tile to analyze.
- customPrompt: An optional string to prompt the AI for specialized insights beyond standard analysis.
Settings
1. Title
- Input Type: String
- Description: Sets the main title displayed at the top of the tile.
- Default Value: "AI-Powered Business Intelligence"
2. Subtitle
- Input Type: String
- Description: An optional secondary title or description that appears below the main title.
- Default Value: Undefined (not displayed if not provided)
3. Footer Text
- Input Type: String
- Description: A text element that can be displayed at the bottom of the tile for additional context or messaging.
- Default Value: Undefined (not displayed if not provided)
4. Footer Color
- Input Type: String
- Description: Specifies the color used for the footer text to enhance visual appeal.
- Default Value: Undefined (not set if not provided)
5. Workflow IDs
- Input Type: Array of Strings
- Description: Required list of workflow identifiers which the AI will analyze for insights.
- Default Value: Empty array
[](indicating no workflows selected)
6. Custom Prompt
- Input Type: String
- Description: Allows the user to input a specific instruction or context for the AI model, enhancing the relevance of the generated insights.
- Default Value: Undefined (no custom prompt used if not provided)
Use Cases & Examples
Use Case 1: Risk Management
A financial institution can utilize the BiIntelligenceTile to actively monitor transaction workflows for potential fraud alerts. By analyzing past transactions against defined behaviors, the tile identifies anomalies that require immediate attention from analysts.
Use Case 2: Operational Efficiency
A supply chain company may implement this tile to assess labor workflows for bottlenecks. Insights can highlight inefficiencies in logistics processes, allowing managers to strategically allocate resources.
Concrete Example Configuration
For the risk management use case, the BiIntelligenceTile can be configured with the following properties:
{
"title": "Fraud Detection Insights",
"subtitle": "Monitoring Transaction Risks",
"footerText": "Real-time insights generated from transaction data",
"footerColor": "#f44336",
"workflowIds": ["trans-001", "trans-002", "trans-003"],
"customPrompt": "Identify any suspicious transaction patterns that commonly indicate fraud."
}In this configuration:
- The title sets a clear focus on fraud detection.
- A footer provides context about the insights.
- The array of
workflowIdscorresponds to the workflow IDs of transactions to be analyzed. - The
customPromptallows the analyst to emphasize a specific focus for the AI, improving the specificity of the insights.
Billing Impacts
Using the BiIntelligenceTile may impact billing based on:
- The level of AI processing required for insight generation, which may be billed according to the number of workflows analyzed or the frequency of requests made to the AI service.
- Enhanced insights through specially crafted queries (custom prompts) may incur additional computational costs based on backend AI service pricing models.
Ensure you monitor usage statistics for potential billing changes when utilizing this powerful component of the Vantage platform.