Skip to content

Latest commit

 

History

History
205 lines (187 loc) · 13.9 KB

README.md

File metadata and controls

205 lines (187 loc) · 13.9 KB
Raw
page_type description products languages extensions contentType createdDate
sample
Proactive Tab Conversation
office-teams
office
office-365
csharp
samples
13-05-2022 15:00:00

Proactive Tab Conversations

The proof of concept demonstrates how to use a bot to proactively create a new conversation each time a support inquiry is filed. The inquiry will be viewable in a tab, and the conversation can continue using conversational tabs. This concept can be extended to additional scenarios including proactively creating conversations on a patient, opportunity, incident, etc.

Please see the Code Tours section for in-depth explanation of the sample.

Included Features

  • Conversational tabs/Sub-entity conversations
  • Personal tabs
  • Proactive conversation creation from a Bot
  • Authorization of API calls based on user's Team membership

Image of the app in a channel tab, showcasing a user Mark's support ticket, and and the corresponding channel conversation, where Adele has been asked to provide help Image of the app in a personal app, showing the top incidents from the two channels (IT Department and Sales) that the logged in user has access too

Workflow

sequenceDiagram
    actor User as User
    participant External as External Service
    Note over External: Simple website in our POC
    participant ChannelTab as Support Department Channel Tab
    participant ChannelPosts as Team Channel Posts
    participant PersonalTab as Personal Tab
    participant Bot as Teams App Bot
    participant Service as Service
    participant DataStore as Data Store
    participant Graph as Graph API
    Note over Bot,Service: App Installation
    Bot ->> Service: Bot context, for future proactive messages
    Service ->> DataStore: Store bot context
    Note over User,DataStore: Create a Tab
    User ->> ChannelTab: Adds Tab
    ChannelTab ->> Service: Save support department tab details
    Service ->> Graph: Ensure user is a member of the relevant Team
    Graph ->> Service: 
    Service ->> DataStore: Get bot context for channel
    alt Bot context exists
        DataStore ->> Service: Bot Context Data
        Service ->> DataStore: Store support department details
        DataStore ->> Service: Success
        Service ->> ChannelTab: Create tab
    else Bot context missing
        DataStore ->> Service: No bot context error
        Service ->> ChannelTab: Channel bot context not found error message 
    end
    ChannelTab ->> User: Error or tab created successfully
    Note over External,DataStore: Post a new inquiry
    External ->> Service: Creates a new inquiry for a support department
    Service ->> DataStore: Support department details and bot context
    DataStore ->> Service: 
    Service ->> Bot: Bot context and inquiry details
    Bot ->> ChannelPosts: Inquiry posted to Team
    Bot ->> Service: Inquiry conversation reference
    Service ->> DataStore: Store inquiry conversation reference
    Service ->> External: Success
    Note over User,DataStore: Open Support Department
    User ->> ChannelTab: Opens Channel Tab
    ChannelTab ->> Service: Get inquiries
    Service ->> DataStore: Support department inquiries
    DataStore ->> Service: 
    Service ->> Graph: Ensure user is a member of the Support Department Team
    Graph ->> Service: 
    Service ->> ChannelTab: Support department inquiries
    ChannelTab ->> User: Display list of support department inquiries
    User ->> ChannelTab: Select single inquiry, open details
    ChannelTab ->> Service: Get single inquiry
    Service ->> DataStore: Single inquiry
    DataStore ->> Service: 
    Service ->> Graph: Ensure user is a member of the Support Department Team
    Graph ->> Service: 
    Service ->> ChannelTab: Single inquiry
    ChannelTab ->> User: Display single support department inquiry
    Note over User,DataStore: Open Personal Tab
    User ->> PersonalTab: Opens Personal Tab
    PersonalTab ->> Service: Get all support departments
    Service ->> DataStore: All support department inquiries
    DataStore ->> Service: 
    Service ->> Graph: Get user's Teams
    Graph ->> Service: 
    Service ->> PersonalTab: Filter support department inquiries to user's Teams
    PersonalTab ->> User: Display list of all support departments and top inquiries
Loading

Usage

Channel Tab

  • Set-up, deploy and sideload the app to a channel.
    • When the app is installed to the team the bot will automatically gather the required info to create proactive conversations later.
  • In a channel, click '+ Add a tab', and add a new Conversational Tab.
    • Configure your tab, by adding a Department name and Department description, then click Save.
    • The first time running this application you will need to consent twice. Once to use the app initially, and once to call the API. If you see "We need you to consent to complete that action.", ensure that your pop-up blocker isn't blocking a consent dialog.
  • In your tab you will see the department details, but there will be no inquires.
  • Open up the external admin page at <<deployment-url>>/admin. This page is a stand-in for an external service that might want to connect into teams, e.g. a job posting board who wants to post new applications.
    • In the external admin page, select a support department and add a new inquiry.
  • In the channel, you will see a new conversation. The conversation will be an Adaptive Card that will link to the inquiry in the tab.
  • In the tab, you will see the inquiry details and you can use Open conversation to open the conversation to the side. And messages posted here, will be visible in the conversation in that channel.
  • If you navigate Back you can see all the inquiries.

Personal Tab

There is also a personal tab that will list inquires from all the support departments from all the channels you have access to.

  • After installing the app in the personal scope, open the app.
  • Once authenticated, the app will list all the support departments from any channel you are a member of. Up to five inquiries from each support department will be listed.
  • Clicking on the -> Arrow will open the inquiry details. From the detail page you can open the channel conversation about the inquiry.

Known issues

  • When the solution is run on a local web browser (anywhere outside of Teams), it will load a spinner. Instead side-load the application to a teams client, or open up <<deployment-url>>/admin to open the admin page
  • Sometimes, the "Open Details" button on a new inquiry's Adaptive Card may not navigate to a the channel tab. This is due to side-loaded apps not having a consistent entityId. This makes deeplinking difficult. If this happens you can open the inquiry in the tab directly. If you have submitted the app to either your Org App Store or the Teams App Store you must set the <<teams-app-store-app-id>> in appsettings.json to the App ID value as shown in the Teams Admin Center.
  • Private channels do not support bots at the moment, therefore this app is not supported on private channels.
  • If in the personal app a user opens a conversation from a channel they are not a member of, the conversation will fail to show. This is not an issue in our sample as we filter support departments based on Team membership.
  • App shows "We need you to consent to complete that action." but provides no action: your pop -up blocker might be blocking a consent dialog from opening, be sure to allow pop-ups from Teams.

Code Tours

This repository uses VSCode Code Tours to explain how the code works.

The tour files can be found in the .tours directory.

Prerequisites

Steps

  • Start Ngrok
  • Create a new Bot Registration
  • Update the Azure AAD App Registration
  • Update URL in Manifest
  • Build C# App
  • Deploy to Teams

Set up

  • Run Ngrok
    • Run ngrok and point it to the port the Web App is listening on. Note the port will change depending on how you are deploying.
    ngrok http https://localhost:44326 -host-header=localhost:44326 # For Visual Studio
    • Make sure to copy and save the https url (it should look like https://<randomsubdomain>.ngrok.io).
  • Create a Bot. We recommend using Developer Portal for Microsoft Teams, but you can use create a Azure Bot in Azure Portal.
    • Set the 'Bot endpoint address' to https://<randomsubdomain>.ngrok.io/api/messages.
    • Create a client secret, being sure to copy the secret for replacing in the appSettings.json below.
    • Note: if you restart Ngrok you may have to update the messaging endpoint domain URL you have set in your Bot Configuration
  • Update the AAD App to enable Teams SSO
    • When creating the Bot above, an AAD app should either have been created for you, or you should have chosen an AAD app to associate with the bot.
    • The updates below will allow for us to authenticate and authorize API calls to limit data returned to only channels the user is a member of.
    • Follow the instructions, to expose an AAD API, creating an Application ID URI, scopes, etc.
    • Once you have followed those instructions, you need to configure the Web authentication platform for the application.
    • Ensure the following API permissions are granted to the app for Microsoft Graph access - email, offline_access, openid, profile, Team.ReadBasic.All
    • Note: if you restart Ngrok you may have to update any fully qualified domain name you have set in your AAD App
  • In appSettings.json, manifest.json and .env replace:
    • <<deployment-url>> with your ngrok url, minus the https://.
    • <<aad-id>> with your AAD Application (Client) Id.
    • <<aad-client-secret>> with the client secret you created above.
    • <<teams-app-store-app-id>> with the App ID assigned to the app in the Teams Admin Center or provided when your app passes validation. If you are sideloading the app you can use the appId from the manifest file, but please note that deep linking may not work when sideloading.
  • Project Structure
    • The sample contains 3 projects
      • Web - Exposes REST APIs for documents and signing scenarios supported in this POC.
        • Web\ClientApp contains the Front End code to support document sharing in a meeting via share to stage.
      • Domain - Contains the business logic to support the REST APIs.
      • Infrastructure - Fulfils Domain's dependencies like data repositories, graph support needed.
  • Deploying
    • There are detailed instructions for deploying locally below.
  • Sideloading the App

Deployment

Locally in Visual Studio

  • Point Ngrok to port 44326: ngrok http https://localhost:44326 -host-header=localhost:44326
  • Open the solution in Visual Studio.
  • Ensure the start-up project is set to Microsoft.Teams.Samples.ConversationalTabs.Web
  • Start Debugging using IIS Express

Locally using .NET SDK

  • Point Ngrok to port 5001: ngrok http -host-header=rewrite 5001
  • In a terminal, navigate to Source\ConversationalTabs.Web
  • Run dotnet run

Docker

Note the below instructions are using Podman, but Docker's commands are similar. There are instructions for setting up Podman on WSL2 here

  • From this directory build the Docker image podman build -f Deployment/Dockerfile --ignorefile Deployment/.dockerignore ./Source
  • Wait for the container to build
  • Run podman images to view available images, copy the Image ID
  • Point Ngrok to port 8080: ngrok http -host-header=rewrite 8080
  • Run podman run -d -p 8080:80 --name ConversationalTabs <IMAGE_ID> to start the container
  • Open http://localhost:8080/ to view the service running

Additional links