Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Power BI Report template Feature #8641

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Power BI Report template Feature #8641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9d3a613
Power BI Report template Feature
SSanjeevi Sep 8, 2021
67190e3
Fixed some naming to composer
SSanjeevi Sep 8, 2021
3c49368
fixed name
SSanjeevi Sep 8, 2021
0b5dbbb
fixed name from va to composer
SSanjeevi Sep 8, 2021
3bca958
Merge branch 'main' into main
benbrown Oct 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 139 additions & 0 deletions reports/1-intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
# Tutorial: View analytics with Power BI

## Intro

### Purpose
The BOT framework Composer sample provides a Power BI template that can be used to understand how your bot is performing.

<div id="powerbi-carousel" class="carousel slide" data-ride="carousel">
<div class="carousel-inner">
<div class="carousel-item active">
<div class="card">
<img src="./assets/images/analytics/virtual-assistant-analytics-powerbi-1.png" class="card-img-top" alt="Overall usage">
<div class="card-body">
<h4 class="card-title">Overall usage</h4>
<p class="card-text">Personalize your experience for your brand and customers.</p>
</div>
</div>
</div>
<div class="carousel-item">
<div class="card">
<img src="./assets/images/analytics/virtual-assistant-analytics-powerbi-2.png" class="card-img-top" alt="All dialogs overview">
<div class="card-body">
<h4 class="card-title">All dialogs overview</h4>
<p class="card-text">All dialogs' popularity and status based off of SDK telemetry</p>
</div>
</div>
</div>
<div class="carousel-item">
<div class="card">
<img src="./assets/images/analytics/virtual-assistant-analytics-powerbi-3.png" class="card-img-top" alt="Dialog overview">
<div class="card-body">
<h4 class="card-title">Dialog overview</h4>
<p class="card-text">Review a specific dialog's popularity and status</p>
</div>
</div>
</div>
<div class="carousel-item">
<div class="card">
<img src="./assets/images/analytics/virtual-assistant-analytics-powerbi-4.png" class="card-img-top" alt="LUIS intents">
<div class="card-body">
<h4 class="card-title">LUIS intents</h4>
<p class="card-text">A count of LUIS intents per day</p>
</div>
</div>
</div>
<div class="carousel-item">
<div class="card">
<img src="./assets/images/analytics/virtual-assistant-analytics-powerbi-5.png" class="card-img-top" alt="All conversation metrics">
<div class="card-body">
<h4 class="card-title">All conversation metrics</h4>
<p class="card-text">Highlights the average number of conversations per unique user and the average duration by day</p>
</div>
</div>
</div>
<div class="carousel-item">
<div class="card">
<img src="./assets/images/analytics/virtual-assistant-analytics-powerbi-6.png" class="card-img-top" alt="Conversations drill down">
<div class="card-body">
<h4 class="card-title">Conversations drill down</h4>
<p class="card-text">Per conversation, this highlights the dialogs triggered and common utterances</p>
</div>
</div>
</div>
<div class="carousel-item">
<div class="card">
<img src="./assets/images/analytics/virtual-assistant-analytics-powerbi-7.png" class="card-img-top" alt="Transcript">
<div class="card-body">
<h4 class="card-title">Transcript</h4>
<p class="card-text">Review interactions, sessions, and the transcript between a bot and its users</p>
</div>
</div>
</div>
<div class="carousel-item">
<div class="card">
<img src="./assets/images/analytics/virtual-assistant-analytics-powerbi-8.png" class="card-img-top" alt="Demographics">
<div class="card-body">
<h4 class="card-title">Demographics</h4>
<p class="card-text">See where users are connecting to your bot</p>
</div>
</div>
</div>
<div class="carousel-item">
<div class="card">
<img src="./assets/images/analytics/virtual-assistant-analytics-powerbi-9.png" class="card-img-top" alt="Word cloud">
<div class="card-body">
<h4 class="card-title">Word Cloud</h4>
<p class="card-text">Commonly user queries</p>
</div>
</div>
</div>
<div class="carousel-item">
<div class="card">
<img src="./assets/images/analytics/virtual-assistant-analytics-powerbi-10.png" class="card-img-top" alt="Sentiment analysis">
<div class="card-body">
<h4 class="card-title">Sentiment analysis</h4>
<p class="card-text">Average user sentiment results provided by LUIS</p>
</div>
</div>
</div>
<div class="carousel-item">
<div class="card">
<img src="./assets/images/analytics/virtual-assistant-analytics-powerbi-11.png" class="card-img-top" alt="QnA Maker insights">
<div class="card-body">
<h4 class="card-title">QnA Maker insights</h4>
<p class="card-text">Insights on matched user queries with QnA Maker</p>
</div>
</div>
</div>
<div class="carousel-item">
<div class="card">
<img src="./assets/images/analytics/virtual-assistant-analytics-powerbi-12.png" class="card-img-top" alt="User feedback">
<div class="card-body">
<h4 class="card-title">User feedback</h4>
<p class="card-text">Insights on user submitted feedback</p>
</div>
</div>
</div>
</div>
<a class="carousel-control-prev" href="#powerbi-carousel" role="button" data-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="sr-only">Previous</span>
</a>
<a class="carousel-control-next" href="#powerbi-carousel" role="button" data-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="sr-only">Next</span>
</a>
</div>


### Prerequisites
* [Install Power BI Desktop](https://powerbi.microsoft.com/desktop/)
* [Download the Bot Composer analytics Power BI template](./Power-BI-Report-Composer.pbit)
* [Create a Bot in Composer](https://docs.microsoft.com/en-us/composer/quickstart-create-bot?tabs=v2x) to deploy your Azure resources

### Time To Complete
10 minutes

### Scenario
A Power BI dashboard showing Application Insights telemetry captured from a Bot Composer BOT.
13 changes: 13 additions & 0 deletions reports/2-get-application-insights-application-id.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Tutorial: View analytics with Power BI

## Get your Application Insights Application ID

1. Log in to the [Azure Portal](https://portal.azure.com/).

1. Navigate to the Application Insights resource created from the [Create a Virtual Assistant tutorial](./virtual-assistant/tutorials/create-assistant/csharp/1-intro).

1. In the sidebar, navigate to **Configure > API Access** on the sidebar.
![Screenshot highlighting the API Access tab in an Application Insights resource](./assets/images/analytics/application-insights-api-access.png)

1. Copy the Application ID for the next step.
![Screenshot highlighting the Application ID of an Application Insights resource](./assets/images/analytics/application-insights-application-id.png)
23 changes: 23 additions & 0 deletions reports/3-open-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Tutorial: View analytics with Power BI

## Open the Power BI template

1. Open the [Bot Composer analytics template](./Power-BI-Report-Composer.pbit) and paste your **Application Insights Application ID**.
![Screenshot of the load template view of a new Composer Bot analytics Power BI template](./assets/images/analytics/virtual-assistant-analytics-powerbi-load-template.png)

1. After loading the tables with your populated data, you should now see insights from your Virtual Assistant.

*Note: You may run into authentication issues when opening the template, particularly if you have opened the template previously using another Application ID. If so, perform the following steps to re-authenticate the template with your Application Insights service:*

1. Open the Template
2. File > Options and Settings > Data Source Settings
3. Click "Global permissions"
4. Click on anything resembling "api.logalytics.io" and Clear Permissions > Clear Permissions > Delete
5. Close and Re-open the Template
6. Paste your Application Insights AppId
7. Click Load
8. *Important*: Select Organizational Account > Sign In > Connect

## Additional Telemetry

By default, a Bot composer Bot based project collects personally identifiable information (e.g. Conversation drill-down and transcripts) which will lead to the respective sections in the PowerBI dashboard to function as expected. If you wish to not collect this information make the changes to `appsettings.json` by following this article: https://docs.microsoft.com/en-us/composer/how-to-capture-telemetry?tabs=v2x#configure-telemetry
Binary file added reports/Power-BI-Report-Composer.pbit
View file
Open in desktop
Binary file not shown.
127 changes: 127 additions & 0 deletions reports/assets/css/index.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
---
---

@import "@primer/css/index.scss";
@import "pages/home.scss";
@import "colors.scss";
@import "markdown.scss";
@import "switcher.scss";
@import "syntax.css";

/*
* Extend the footer to the bottom of the page,
* even if there’s not enough content to make the page scroll.
*/
body {
min-height: 100vh;
min-width: 60vw;
display: flex;
flex-direction: column;
}

#nav-content {
top: 4rem;
overflow-y: auto;
z-index: 1000;

ul {
list-style-type: none;
padding-left: 5px;
}

a:hover {
text-decoration: underline;
color: black;
}

.is-selected {
font-weight: 600 !important;
background-color: hsla(0,0%,95%,1);
}
}

@media (min-width: 768px){
#nav-content {
position: -webkit-sticky;
position: sticky;
height: calc(100vh - 4rem);
}
}

#toc-content {
position: -webkit-sticky !important;
position: sticky !important;
top: 4rem;
overflow-y: auto;
height: calc(100vh - 4rem);

ul::before {
content: "On this page";
font-weight: 600;
font-size: 16px;
}

ul {
list-style-type: none;
padding-left: 15px;

li {
padding: 2px 0;
}

li.a {
padding-left: 5px;
}
}
}

#markdown-content {
.carousel-control-prev-icon {
background-image: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='%23d2d2d2' viewBox='0 0 8 8'%3E%3Cpath d='M5.25 0l-4 4 4 4 1.5-1.5-2.5-2.5 2.5-2.5-1.5-1.5z'/%3E%3C/svg%3E");
}

.carousel-control-next-icon {
background-image: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='%23d2d2d2' viewBox='0 0 8 8'%3E%3Cpath d='M2.75 0l-1.5 1.5 2.5 2.5-2.5 2.5 1.5 1.5 4-4-4-4z'/%3E%3C/svg%3E");
}

.btn-primary {
background-color: var(--primary) !important;
background-image: none !important;
}

.btn-primary:hover {
background-color: #0069d9 !important;
}

a.card {
color: inherit;
text-decoration: none;
box-shadow: 0 2px 5px hsla(0,0%,89%,1);
}

a.card:hover {
border: 1px solid var(--primary);
}

pre > code {
font-size: 95% !important;
}
}

.octicon {
display: inline-block;
vertical-align: middle;
fill: currentColor;
}

#searchbox {
float:right;
padding: 3px;
border:0;
outline: none;
vertical-align: bottom;
}

#searchinput {
width:100%;
}
Loading