Skip to content

Commit 4be672c

Browse files
Yamini-MicrosoftYamini-Microsoft
committed
docs: Updated Demonstrator Guide docs
1 parent 4bfb773 commit 4be672c

2 files changed

Lines changed: 112 additions & 24 deletions

File tree

‎docs/DemonstratorGuide.md‎

Lines changed: 84 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,109 @@
1-
# Demonstrator's Guide
1+
# Demonstrator's Guide
22

3-
This page provides guidance on how to set up a demonstration environment for the solution and how to start the data generation simulators. It also describes the security setup for the person to demonstrate the solution.
3+
This guide provides instructions for demonstrating the Real-Time Intelligence Operations solution. Follow the steps in order to effectively showcase the system's capabilities.
44

5-
Please review the [Access Requirements] (./DemostratorAccessRequirement.md). Yamini
5+
## Access Prerequisites
66

7+
Before beginning the demonstration, verify your access permissions:
78

9+
- **If deployed using AZD:** You have the required access and may proceed directly to the demonstration steps.
10+
- **If using a pre-configured environment:** Review the [Demonstrator Access Requirements](./DemostratorAccessRequirement.md) guide to verify your access level.
811

9-
## Step 1. Refresh Historical Data
12+
---
1013

11-
When the solution accelerator was deployed, it automatically creates 90 days of telemetry data and stores the data in the EventHouse database. By the time you demonstrate this solution, the data needs to be refreshed. You will need to follow instructions in [Fabric Data Ingestion Guide](./FabricDataIngestion.md) and use the options `--refresh-dates` and `--overwrite` to get a fresh and up to date dataset.
14+
## Step 1. Demonstrate the Fabric Data Agent
1215

13-
## Step 2. Start Real Time Event Simulator
16+
The Fabric Data Agent is an AI-powered assistant that provides natural language responses to business questions about your data.
1417

15-
You will need to start the Real-Time Event Simulator by following the instructions in [Event Simulator Guide](./EventSimulatorGuide.md) to start the simulator. We recommend you start with normal mode and then switch to anomaly mode to illustrate how anomaly events can be observed and how the anomaly events can trigger alerts.
18+
**Instructions:**
1619

17-
## Step 3. Demonstrate the Real-Time Intelligence Operations Dashboard
20+
1. Refer to the [Fabric Data Agent Guide](./FabricDataAgentGuide.md) for detailed setup instructions
21+
2. Locate the Data Agent in your Fabric workspace
22+
3. Submit questions about the data using the [provided sample questions](./fabric_data_agent/user_sample_test_questions.md) or your own queries
23+
4. Observe how the agent delivers instant responses in natural language
1824

19-
Please follow the [Real-Time Intelligence Operations Dashboard Guide](./RealTimeIntelligenceDashboardGuide.md) to understand the concepts and business metrics. You will want to highlight the anomaly spikes as shown in below diagram. Suggest you select time range filter as last 2 days or last 24 hours depending on when you started the anomaly event simulation.
25+
**What you'll see:**
26+
27+
![Fabric Data Agent UI](../docs/images/deployment/fabric_data_agent_ui.png)
28+
29+
## Step 2. Refresh Historical Data
30+
31+
The system contains 90 days of sample data. To ensure the demonstration reflects current information, you must refresh the dataset.
32+
33+
**Instructions:**
34+
35+
1. Follow the [Fabric Data Ingestion Guide](./FabricDataIngestion.md) for detailed procedures
36+
2. Use the `--refresh-dates` and `--overwrite` options to update the data
37+
38+
This process takes approximately a few minutes and ensures the demonstration displays current data.
39+
40+
---
41+
42+
## Step 3. Initialize the Event Simulator
43+
44+
The Event Simulator generates realistic business events to demonstrate the system's real-time anomaly detection capabilities.
45+
46+
**Instructions:**
47+
48+
1. Refer to the [Event Simulator Guide](./EventSimulatorGuide.md) for detailed setup procedures
49+
2. Start the simulator in **Normal Mode** to demonstrate standard operational conditions
50+
3. Switch to **Anomaly Mode** to illustrate system detection and alert capabilities
51+
52+
You may switch operating modes or restart the simulator at any time during the demonstration without interrupting the session.
53+
54+
---
55+
56+
## Step 4. Present the Real-Time Intelligence Dashboard
57+
58+
The Real-Time Intelligence Operations Dashboard displays critical business metrics and provides real-time visibility into operational anomalies.
59+
60+
**Instructions:**
61+
62+
1. Refer to the [Dashboard Guide](./RealTimeIntelligenceDashboardGuide.md) for detailed information
63+
2. On the dashboard, identify **anomaly spikes** in the data visualization. These represent potential operational issues
64+
3. Configure the time filter to display "Last 24 Hours" or "Last 2 Days" corresponding to the simulator start time
65+
4. Highlight the dashboard's real-time update capability as events are processed
66+
67+
**Example of anomaly spikes on the dashboard:**
2068

2169
![RTI Dashboard Anomaly Spikes](../docs/images/deployment/rti-dashboard-anomaly-spikes.png)
2270

23-
## Step 4. Demonstrate the Activator Anomaly Alerts
71+
---
72+
73+
## Step 5. Demonstrate Alert Mechanisms with Activator
2474

25-
Please follow the [Activator Guide](./ActivatorGuide.md) to understand how the anomaly detection rules are set. You may need to reconfigure the rules to send alerts to an email account that you have access to. You can also reconfigure the rules to send anomaly alerts to a Microsoft Teams channel instead of an email account.
75+
The Activator component monitors real-time data streams and automatically triggers alerts when anomalies exceed defined thresholds, enabling proactive incident response.
2676

27-
If the simulator is in normal mode, you will rarely receive anomaly events as things should be running much smoother during normal mode. If the simulator is switched to 'anomaly' mode, you will get many alerts. The frequency of the simulated events can be adjusted with the simulator's command line options. This is well documented in the [Event Simulator Guide](./EventSimulatorGuide.md). You can stop and restart this event simulator at any time, or switch the operating mode while it is running.
77+
When anomalies are detected, the system automatically generates alerts, enabling teams to respond promptly to operational issues.
78+
79+
**Instructions:**
80+
81+
1. Review the [Activator Guide](./ActivatorGuide.md) to understand alert configuration and functionality
82+
2. Ensure alerts are configured to send to an accessible email address (configuration updates may be required)
83+
3. Optionally configure alerts to be sent to a Microsoft Teams channel for team visibility
84+
85+
**Alert Behavior:**
86+
87+
- **Normal Mode:** Minimal anomalies result in infrequent alerts
88+
- **Anomaly Mode:** Frequent anomalies trigger regular alert notifications
89+
90+
Example email notification:
2891

2992
![Anomaly Alert](../docs/images/deployment/anomaly-email-alerts.png)
3093

31-
When you open one of the emails, you will see something similar to below:
94+
When you open the email, it shows details like this:
3295

3396
![Activator Email Alert](../docs/images/deployment/activator-email-alert.png)
3497

98+
---
3599

100+
## Summary
36101

37-
## Step 5. Demonstrate the Fabric Data Agent
38-
39-
Please follow the [Fabric Data Agent Guide](./FabricDataAgentGuide.md) to understand how the Fabric Data Agent is created and set up. If it is not already set up, you can follow the instructions to create and configure a new Fabric Data Agent in minutes. After that, you can ask any questions you'd like the agent to answer. For starters, you can use the [sample test questions](./fabric_data_agent/user_sample_test_questions.md).
102+
You have successfully demonstrated the following capabilities:
40103

41-
In the Fabric workspace, find the Fabric Data Agent that is already set up. You will be able to chat with the agent right away. Below is the user interface you can expect:
104+
1. **Intelligent Data Assistant:** Natural language query interface for business intelligence
105+
2. **Real-Time Dashboard:** Comprehensive visualization of key operational metrics
106+
3. **Automated Alerting:** Proactive notification system for anomaly detection
107+
4. **Operational Response:** Integrated system enabling rapid response to critical events
42108

43-
![Fabric Data Agent UI](../docs/images/deployment/fabric_data_agent_ui.png)
109+
These components work in concert to provide organizations with real-time operational visibility and accelerated incident response capabilities.

‎docs/DemostratorAccessRequirement.md‎

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
1-
# Demonstrator's Access Requirements
1+
# Demonstrator's Access Requirements
22

3-
If you deployed the solution accelerator via AZD following the [Deployment Guide](./DeploymentGuide.md), you have already established the required access to the solution, and **you can skip this Access Requirements section**, and start at [Step 1. Refresh Historical Data](#step-1-refresh-historical-data).
3+
To effectively demonstrate the Real-Time Intelligence Operations solution using a pre-configured environment, you must have the following permissions and access levels.
44

5-
If you are using a demonstration environment already set up by someone else, you will need below accesses:
5+
## 1. Fabric Workspace Contributor Role
66

7-
1. You will need to be added as a contributor of the Fabric workspace. If you are a viewer, you will not be able to update any resources such as [Real-Time Intelligence Operations Dashboard](./RealTimeIntelligenceDashboardGuide.md) or [Activator](./ActivatorGuide.md). Recommend role: **contributor**.
8-
2. You will need to change the rules in Activator with your own outlook email that you have access to.
9-
3. You will need to be able to send simulated events to the Azure Event Hub deployed with the solution. The owner of the Event Hub or your Azure Admin can add you to the role of **Azure Event Hubs Data Sender**. Below diagram illustrates the key steps.
7+
You must have atleast **contributor** level access to the Fabric workspace to modify resources, including:
8+
9+
- [Real-Time Intelligence Operations Dashboard](./RealTimeIntelligenceDashboardGuide.md)
10+
- [Activator](./ActivatorGuide.md)
11+
12+
> **Note:** Viewer-level access is insufficient for demonstration purposes.
13+
14+
## 2. Configure Activator Rules
15+
16+
Update the Activator rules with your Outlook email address to receive alert notifications.
17+
18+
### Steps to Update Activator Rule Email Address
19+
20+
1. Open the [Activator](./ActivatorGuide.md) in your Fabric workspace
21+
2. Navigate to the rule you wish to modify
22+
3. Locate the email notification settings on the right panel **Definations**
23+
4. Replace the existing email address with your Outlook email address
24+
5. Click **Save** to apply the changes
25+
6. Verify you have access to the updated email account to receive alerts
26+
27+
## 3. Azure Event Hubs Data Sender Role
28+
29+
To send simulated events to the Azure Event Hub, you must have the **Azure Event Hubs Data Sender** role assigned to your account. Contact either the Event Hub owner, or your Azure Administrator to request this role assignment.
30+
31+
The diagram below illustrates the role assignment process:
1032

1133
![Event Hubs Data Sender Role](../docs/images/deployment/eventhubs-data-sender-role.png)

0 commit comments

Comments
 (0)