page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample shows a feature where user can schedule a recurring task and get the reminder at scheduled time using bot. |
|
|
|
officedev-microsoft-teams-samples-bot-daily-task-reminder-nodejs |
This sample shows a feature where user can schedule a recurring task and get the reminder at scheduled time using bot.
- Bots
- Adaptive Cards
- Task Modules
- Quartz Scheduler (for scheduling)
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).
Bot daily task reminder: Manifest
- Microsoft Teams is installed and you have an account (not a guest account)
- To test locally, NodeJS must be installed on your development machine (version 16.14.2 or higher).
- ngrok or equivalent tunneling solution
- M365 developer account or access to a Teams account with the appropriate permissions to install an app.
- 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.
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.
- Setup for Bot
-
In Azure portal, create AAD app registraion and it will generate MicrosoftAppId and MicrosoftAppPassword for you.
-
In Azure portal, create a Azure Bot resource.
-
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 in Azure portal, you will create an App ID and App password - make sure you keep these for later.
-
Setup NGROK
Run ngrok - point to port 3978ngrok http 3978 --host-header="localhost:3978"
-
Setup for code
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
In the folder where repository is cloned navigate to
samples/bot-daily-task-reminder/nodejs
-
Install node modules
Inside nodejs 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
npm install
-
Update the
.env
configuration file in your project folder for the bot to use theMicrosoftAppId
,MicrosoftAppPassword
(Note the MicrosoftAppId is the AppId created while doing AAD app registration in Azure portal, the MicrosoftAppPassword is referred to as the "client secret" generated while creating Secret in AAD app registration.BaseUrl
with application base url. For e.g., your ngrok url https://xxx.ngrok-free.app -
Run your app
npm start
-
Setup Manifest for Teams
- Edit the
manifest.json
contained in theappPackage/
folder to replace with your MicrosoftAppId (that was created in step1.1 and is the same value of MicrosoftAppId in.env
file) 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
) - Relace {{domain-name}} with base Url domain. E.g. if you are using ngrok it would be
https://1234.ngrok-free.app
then your domain-name will be1234.ngrok-free.app
. - Zip up the contents of the
appPackage/
folder to create amanifest.zip
- Upload the
manifest.zip
to Teams (in the left-bottom Apps view, click "Upload a custom app")
- Edit the
Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.
Type command create-reminder to get card for scheduling the recurring task:
Click on schedule task button to open task module for scheduling a task:
Once task is scheduled, you will be notified about the task at scheduled time:
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.