page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample shows a feature where user can send task request to his manager and manager can approve/reject the request in group chat. |
|
|
|
officedev-microsoft-teams-samples-bot-request-approval-nodejs |
This sample shows a feature where:
- Requester : Can request for any task approval from manager by initiating a request in group chat using bot command
request
and only requester can edit the request card. - Manager : Can see the request raised by user in the same group chat with an option of approve or reject.
- Others: Other members in the group chat can see the request details only.
-
Register a new application in the Azure Active Directory – App Registrations portal.
-
Setup for Bot
- Register a AAD aap registration in Azure portal.
- Also, register a bot with Azure Bot Service, following the instructions here.
- Ensure that you've enabled the Teams Channel
- While registering the bot, use
https://<your_ngrok_url>/api/messages
as the messaging endpoint.
NOTE: When you create your app registration, you will create an App ID and App password - make sure you keep these for later.
-
Setup NGROK
- Run ngrok - point to port 3978
# ngrok http -host-header=rewrite 3978
-
Setup for code
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
- Open the
.env
configuration file in your project folder (or in Visual Studio Code) and update theClientId
andClientSecret
,BaseURL
with your app's base url. (Note the ClientId is the AppId created in step 1 (Setup for Bot), the ClientSecret is referred to as the "client secret" in step 1 (Setup for Bot) and you can always create a new client secret anytime.)
- Open the
-
In the folder where repository is cloned navigate to
samples/bot-task-approval/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
npm start
- Setup Manifest for Teams
-
This step is specific to Teams.
- Edit the
manifest.json
contained in the ./AppPackage 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 themanifest.json
) - Edit the
manifest.json
forvalidDomains
and replace{{domain-name}}
with base Url of your domain. E.g. if you are using ngrok it would behttps://1234.ngrok.io
then your domain-name will be1234.ngrok.io
. - Zip up the contents of the
AppPackage
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 ./AppPackage folder, select the zip folder, and choose Open.
- Select Add in the pop-up dialog box. Your app is uploaded to Teams.
-
Initiated request using bot command
request
in group chat. -
Card will refresh for requester to fill details.
-
After submitting the request, requester can edit or cancel the request.
Note: Users who created the card will only be able to see the buttons to edit or cancel the request.
Manager:
-
After requester submit the request, manager can approve/reject the request.
Note: Manager of the task request will only be able to see the buttons to approve or reject the request.
-
If manager approves or rejects the request, card will be refreshed for all the members in group chat.