Skip to content

Latest commit

 

History

History
149 lines (89 loc) · 5.64 KB

teams_extension.md

File metadata and controls

149 lines (89 loc) · 5.64 KB

Back to Chat with your data README

Teams extension

USER STORY | TEAMS DEPLOY | SUPPORTING DOCUMENTATION

User Story

User story

This extension enables users to experience Chat with your data within Teams, without having to switch platforms. It allows them to stay within their existing workflow and get the answers they need. Instead of building the Chat with your data solution accelerator from scratch within Teams, the same underlying backend used for the web application is leveraged within Teams.

Teams - Chat with your Data

Deployment to Teams

IMPORTANT: Before you proceed, installation and configuration of the Chat with your data with speech-to-text deployment is required.

Pre-requisites

Deploy Teams application

  1. Clone this GitHub repo.
  2. Open the “extensions/teams” folder with Visual Studio Code

Teams

  1. Open the file env\.env.test

ENV

  1. Locate the environment variable AZURE_FUNCTION_URL.
  2. Replace the <RESOURCE_TOKEN> and <FUNCTION_APP_CLIENT_KEY> with the name of your Function App resource and its clientKey (created in previous section)
    AZURE_FUNCTION_URL=https://backend-<RESOURCE_TOKEN>.azurewebsites.net/api/GetConversationResponse?code=<FUNCTION_APP_CLIENT_KEY>&clientId=clientKey
    
    Env
  3. Save the file.
  4. Select Teams Toolkit from the navigation panel.

Teams Toolkit in VS Code

  1. Within the Teams Toolkit panel, login to the following accounts:

Sign in to Microsoft 365: Use your Microsoft 365 work or school account with a valid E5 subscription for building your app. If you don't have a valid account, you can join Microsoft 365 developer program to get a free account before you start.

Sign in to Azure: Use your Azure account for deploying your app on Azure. You can create a free Azure account before you start.

Teams Toolkit Accounts

  1. Under Environment, select test.

Teams Toolkit Environment

  1. Under Lifecycle, select Provision.

Teams Toolkit Lifecycle Provision

  1. Within the command palette, select test for the environment.

Select an Environment

  1. Select the resource group created earlier in the installation

Select a Resource Group

  1. When prompted about Azure charges, select Provision.

Azure Charges Prompt

  1. Verify that the provisioning was successful.

Provision Successful

  1. Under Lifecycle, select Deploy.

Teams Toolkit Lifecycle Deploy

  1. Within the command palette, select test for the environment.

Select an Environment

  1. When prompted, select Deploy.

VS Code Prompt to Deploy

  1. Verify that the Deployment was successful.

Deployment successful

  1. Under Lifecycle, select Publish.

Teams Toolkit Lifecycle Publish

  1. Within the command palette, select test for the environment.

Select an Environment

  1. Verify that the Publish was successful.

Publishing successful

  1. Select Go to admin portal.

Go to Admin Portal

  1. On the Manage apps page within the Teams Admin portal, you should see one submitted custom app pending approval.

Pending Approval

  1. In the search by name input box, enter: enterprise chat

Filtered app

  1. Select the app and then select Allow.

Selected app

  1. Select the app name.

Select app name

  1. Select Publish.

Publish app

  1. When prompted, select Publish.

Prompt to publish

  1. Depending on your environment, it may take several hours to publish.

Teams Publish Success

To customize the accelerator or run it locally, first, copy the .env.sample file to your development environment's .env file, and edit it according to environment variable values table. Learn more about deploying locally here.

Supporting documentation

Supporting documentation

Resource links for Teams extension

This solution accelerator deploys the following resources. It's crucial to comprehend the functionality of each. Below are the links to their respective documentation: