CrmAnalyticsTile Documentation

Purpose

The CrmAnalyticsTile is a component designed for use within the Vantage analytics and data platform. This tile provides a comprehensive overview of CRM (Customer Relationship Management) pipeline and deal analytics, enabling data visualization of sales performance through key metrics and analytics such as total deals, won/lost statistics, and activity breakdowns. It helps users to track sales stages, analyze performance, and make informed decisions.

Settings

The CrmAnalyticsTile can be configured using several settings, detailed below:

1. title

• Input Type: String
• Description: This setting defines the title displayed at the top of the tile.
• Effect of Changing: Modifying this setting will change the displayed title of the tile, allowing customization based on user preferences or specific dashboards.
• Default Value: 'CRM Analytics'

2. subtitle

• Input Type: String
• Description: This setting provides additional context or description that appears below the title.
• Effect of Changing: Changing this will affect the subtitle displayed in the tile, which can be used for clarification or additional information about the data presented.
• Default Value: '' (empty string)

3. id

• Input Type: String
• Description: A unique identifier for the tile used for internal management within the dashboard system.
• Effect of Changing: This ID is crucial for tracking and updating the tile's data; changing it without updating references can result in errors.
• Default Value: undefined (must be provided for the tile to function properly)

4. data (inferred from context, not directly in the code)

• Input Type: Object
• Description: The tile expects data related to deals and activities to render its analytics.
• Effect of Changing: Inputting different data will dynamically change the statistics and rendering within the tile.
• Default Value: undefined (the data is fetched from the API)

How It Works

The CrmAnalyticsTile fetches sales and activity data from the API upon mounting and displays key performance indicators (KPIs) relevant to the CRM pipeline and activities. It manages state and side effects:

1. Data Loading: Fetches data for deals and activities when the component mounts. This asynchronous call is handled in the loadData function.
2. State Management: Maintains the loading state, error messages, and the active tab (pipeline or activity) through local state hooks.
3. Analytics Calculation: Uses memoization to compute analytics, such as the total number of deals, average deal value, win rates, and activities organized by type.
4. Dynamic UI Components: Renders KPI cards, a tab switcher for pipeline and activity views, and visual displays such as bar graphs for pipeline value by stage and activity breakdowns.

Data Expectations

The CrmAnalyticsTile expects the following data structure from the API for successful rendering:

• Deals: Should include properties such as:
  • value: Numeric value of the deal.
  • stage: Status of the deal.
  • probability: Likelihood of winning the deal (percentage).
• Activities: Should include at least a type property to categorize the activities (e.g., call, email, meeting).

This data will determine how the tile computes and presents analytics.

AI Integrations

While the CrmAnalyticsTile does not have direct AI integrations mentioned in the code, it prepares analytics data that could be utilized in machine learning models to predict sales outcomes or suggest sales strategies.

Billing Impacts

As part of the overarching Vantage platform, usage of the CrmAnalyticsTile may have implications on billing based on:

1. Data volume being processed and displayed (e.g., more deals and activities may entail higher costs).
2. Frequency of API calls made by the component, which could depend on the refresh rate of the tile or the number of users concurrently interacting with the tile.

Use Cases & Examples

Use Cases

1. Sales Performance Tracking:

   • Sales teams can utilize the CrmAnalyticsTile to monitor their sales pipeline and performance against targets actively.

2. Monthly Review Meetings:

   • During monthly meetings, managers can present real-time analytics from the tile to assess team performance and strategy effectiveness.

3. CRM Data Visualization:

   • CRM administrators can integrate the CrmAnalyticsTile into dashboards to provide a visual representation of sales data for better decision-making.

Detailed Example Configuration

Use Case: Monthly Review Meetings

• Configuration: A sales manager wants to present the current state of the sales pipeline during a monthly review meeting.

{
  "title": "Sales Performance Overview",
  "subtitle": "Monthly Review - March 2023",
  "id": "sales-perf-march-2023"
}

• Result: The tile titled "Sales Performance Overview" will display relevant metrics for March 2023, allowing stakeholders to view total deals, pipeline stage performance, and activity breakdowns dynamically through Vantage.

In implementing this configuration, the manager can ensure that the necessary analytics are visible for informed discussions and decisions in the review meeting.