page_type | description | products | languages | extensions | urlFragment | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample illustrates a meeting experience for recruitment scenario using Apps In Meetings. This app also uses bot for sending notifications. |
|
|
|
officedev-microsoft-teams-samples-meeting-recruitment-app-nodejs |
This sample app demonstrates how to enhance recruitment meetings in Microsoft Teams using bots to send notifications and provide in-meeting functionality. It includes features such as managing candidate information, adding interview questions, sharing assets, and capturing feedback in the meeting side panel.
- Bots
- Meeting Chat
- Meeting Sidepanel
- Meeting Details
Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app package (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).
Recruitment App Sample: Manifest
- NodeJS must be installed on your development machine (version 16.14.2 or higher).
- dev tunnel or ngrok latest version or equivalent tunnelling solution
- Teams Microsoft Teams is installed and you have an account
- Teams Toolkit for VS Code or TeamsFx CLI
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.
- Ensure you have downloaded and installed Visual Studio Code
- Install the Teams Toolkit extension
- Select File > Open Folder in VS Code and choose this samples directory from the repo
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
- Select Debug > Start Debugging or F5 to run the app in a Teams web client.
- In the browser that launches, select the Add button to install the app to Teams.
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.
-
Register a new application in the Microsoft Entra ID – App Registrations portal.
Go to App registrations and create a new app registration in a different tab.
Register an application. Fill out name and select third option for supported account type and click "Register".
- Copy and paste the App Id and Tenant ID somewhere safe. You will need it in a future step.
- Create Client Secret.
- Navigate to the "Certificates & secrets" blade and add a client secret by clicking "New Client Secret".
- Copy and paste the secret somewhere safe. You will need it in a future step.
-
Setup for Bot
- In Azure portal, create a Azure Bot resource.
- Ensure that you've enabled the Teams Channel
- While registering the bot, use
https://<your_tunnel_domain>/api/messages
as the messaging endpoint. NOTE: When you create app registration, you will create an App ID and App password - make sure you keep these for later.
-
Create a Azure Storage account(This is needed to store/retrieve data that's used in the app) Create storage account
This step will create a storage account. You will require storage account name and keys in next steps.
Please follow View account keys to see the
keys info.
- 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
- Setup for code
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-Modify the keys.js
file in the location samples/meeting-app/nodejs/api/server
and fill in the [STORAGE ACCOUNT NAME]
and [ACCESS KEY]
for azure table storage.
-
We have two different solutions to run so follow below steps:
A) In a terminal, navigate to
samples/meeting-recruitment-app/nodejs/api
B) In a different terminal, navigate to
samples/meeting-recruitment-app/nodejs/clientapp
-
In both the terminal run
npm install
npm start
-
- 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<<APP-ID>>
(depending on the scenario the Microsoft App Id may occur multiple times in themanifest.json
) - Edit the
manifest.json
for<<BASE-URL>>
and replace<<BASE-URL>>
with base Url of your domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.app
then your domain-name will be1234.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 amanifest.zip
(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- Edit the
-
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.
-
Details page: The details page shows basic information of the candidate, timeline, Questions (that can be added for meeting), Notes (provided by peers)
-
Action on Questions:
- The interviewer can Add/Edit or Delete question.
- Add Questions Task Module
- Edit Question Task Module
-
Add Notes:
The interviewer can add notes that will appear to other peers.
Add Note Task Module
-
Sidepanel:
The in-meeting side panel shows two sections as follows:
A) Overview: Shows the basic details of the candidate.
B) Questions: The questions set in the details page appear here. The interviewer can use this to provide rating and submit final feedback.
-
Share assets:
This is used to share assets to the candidate.
-
Mobile view: Details tab
- Sidepanel view
Deploy your project to Azure by following these steps:
From Visual Studio Code | From TeamsFx CLI |
---|---|
|
|
Note: Provisioning and deployment may incur charges to your Azure Subscription.