Skip to content

Latest commit

 

History

History

nodejs

README.md

page_type description products languages extensions urlFragment
sample
This sample application demonstrates how to retrieve meeting attendance reports using the Graph API and send them through a bot in Microsoft Teams chat.
office-teams
office
office-365
nodejs
javascript
contentType createdDate
samples
08/20/2022 00:30:15
officedev-microsoft-teams-samples-meetings-attendance-report-nodejs

Meeting attendance report

This sample application showcases the use of the Graph API to fetch meeting attendance reports and send them through a bot in Microsoft Teams chat. With features such as automated report delivery at the end of meetings, it provides an efficient way to track participant engagement and improve meeting effectiveness.

Included Features

  • Bots
  • Graph API

Interaction with app

When meeting ends, attendance report card is sent by the bot.

Attendance Report

Prerequisites

Run the app (Using Teams Toolkit for Visual Studio Code)

The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.

  1. Ensure you have downloaded and installed Visual Studio Code
  2. Install the Teams Toolkit extension
  3. Select File > Open Folder in VS Code and choose this samples directory from the repo
  4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
  5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
  6. In the browser that launches, select the Add button to install the app to Teams.
  7. Follow this link- Configure application access policy
  8. Note: Copy the User Id you used to granting the policy. You need while configuring the .env file.

If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.

Setup

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

  1. Register a new application in the Microsoft Entra ID – App Registrations portal.

    • Click on "New registration", and create an Azure AD application.

    • Name: The name of your Teams app - if you are following the template for a default deployment, we recommend "App catalog lifecycle".

    • Supported account types: Select "Accounts in any organizational directory"

    • Leave the "Redirect URL" field blank.

    • Click on the "Register" button.

    • When the app is registered, you'll be taken to the app's "Overview" page. Copy the Application (client) ID; we will need it later. Verify that the "Supported account types" is set to Multiple organizations.

    • On the side rail in the Manage section, navigate to the "Certificates & secrets" section. In the Client secrets section, click on "+ New client secret". Add a description for the secret and select Expires as "Never". Click "Add".

    • Once the client secret is created, copy its Value, please take a note of the secret as it will be required later.

    • At this point you have 3 unique values:

      • Application (client) ID which will be later used during Azure bot creation
      • Client secret for the bot which will be later used during Azure bot creation
      • Directory (tenant) ID We recommend that you copy these values into a text file, using an application like Notepad. We will need these values later.

    • Under left menu, navigate to API Permissions, and make sure to add the following permissions of Microsoft Graph API > Application permissions:

      • OnlineMeetingArtifact.Read.All

    Click on Add Permissions to commit your changes.

    • If you are logged in as the Global Administrator, click on the Grant admin consent for %tenant-name% button to grant admin consent else, inform your admin to do the same through the portal or follow the steps provided here to create a link and send it to your admin for consent.

  2. Setup for Bot

  • In Azure portal, create a Azure Bot resource.

  • Ensure that you've enabled the Teams Channel

  • If you are using Ngrok to test locally, you'll need Ngrok installed on your development machine. Make sure you've downloaded and installed Ngrok on your local machine. ngrok will tunnel requests from the Internet to your local computer and terminate the SSL connection from Teams.

  1. Allow applications to access online meetings on behalf of a user
  1. Setup NGROK

  • Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"

    Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:

    devtunnel host -p 3978 --allow-anonymous
    • If you are using Ngrok, once started you should see URL https://41ed-abcd-e125.ngrok-free.app. Copy it, this is your baseUrl that will used as endpoint for Azure bot and webhook.

  1. Setup for code

    • Clone the repository
    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

    -Update the .env configuration for the bot to use the MicrosoftAppId and MicrosoftAppPassword and MicrosoftAppTenantId and AppBaseUrl and UserId (Note that the MicrosoftAppId is the AppId created in step 1 , the MicrosoftAppPassword is referred to as the "client secret" in step 1 and you can always create a new client secret anytime., MicrosoftAppTenantId is reffered to as Directory tenant Id in step 1, AppBaseUrl is the URL that you get in step 3 after running the tunnelling application, UserId of the user used while granting the policy in step 1).

  • In the folder where repository is cloned navigate to samples/meetings-attendance-report/nodejs

  • Install node modules

Inside node js folder, open your local terminal and run the below command to install node modules. You can do the same in Visual studio code terminal by opening the project in Visual studio code

```bash
npm install
```
  • Run your app
```bash
npm start
```
  1. Setup Manifest for Teams

  • This step is specific to Teams.

    • Edit the manifest.json contained in the ./appManifest folder to replace your Microsoft App Id (that was created when you registered your app registration earlier) everywhere you see the place holder string {{Microsoft-App-Id}} (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
    • Edit the manifest.json for validDomains and replace {{domain-name}} with base Url of your domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.
    • Zip up the contents of the appManifest folder to create a manifest.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)

  • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

    • Go to Microsoft Teams. From the lower left corner, select Apps
    • From the lower left corner, choose Upload a custom App
    • Go to your project directory, the ./appManifest folder, select the zip folder, and choose Open.
    • Select Add in the pop-up dialog box. Your app is uploaded to Teams.

Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.

Running the sample

Schedule the meeting and add Meeting Attendance Bot from Apps section in that particular scheduled meeting:

Install

Add Meeting UI:

Add Bot

On installation you will get a welcome card:

Welcome Card

Once the bot is installed in the meeting, whenever meeting ends bot will send attendance report:

Attendance Report

Further reading