Microsoft 365 Community Microsoft Teams, 11 Jan 2022

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Building a Microsoft Teams bot for scheduling tasks and to get reminders

Description

In this 16-minute developer focused demo – Wajeed Shaikh instructs this sample “Bot daily task reminder" is about sending a proactive chat message/request to app users. Users are able to schedule a recurring task and get a reminder at scheduled times via Adaptive Cards. Comprehensive walk-through from cloning sample repo, to creating and registering an Azure bot, to updating endpoints, creating App manifest file and sideloading into your dev tenant. This PnP Community demo is taken from the weekly Microsoft 365 Platform Community call recorded on January 11, 2022.

Demo Presenter: Wajeed Shaikh (Microsoft)

Supporting materials:
• Microsoft Teams Samples - #15 Bot daily task reminder | http://github.com/officedev/microsoft-teams-samples
• Documentation – Send Proactive Messages | https://docs.microsoft.com/microsoftteams/platform/sbs-send-proactive
• Documentation – Proactive Messages | https://docs.microsoft.com/microsoftteams/platform/bots/how-to/conversations/send-proactive-messages?tabs=dotnet
• Feedback – Teams Feedback | aka.ms/TeamsPlatformFeedback

Learn more:
• Learn more about the Microsoft 365 Patterns and Practices community at: http://aka.ms/m365pnp
• Visit the Microsoft 365 Patterns and Practices community YouTube channel: https://aka.ms/m365pnp/videos

A

Hello, everyone, my name is, and I'm a program manager for microsoft teams, developer community responses. We got a lot of feedback from community to have scenario piece samples along with the capability samples we have today.

A

So today I am going to do a demo and have a code walkthrough for microsoft team sport for scheduling a task to get a reminders. First, we'll cover the basics on scenario and we'll do a demo using the ready to try app manifests which are available on github after the demo. I'll show you how you can set this up on your local machine. We'll also do a code walkthrough covering the key core snippets and followed by the questions.

A

Sending a proactive message to end user of your app is a very common scenario in this sample. We allow user to schedule a daily task reminder. As per the end user experience on installation you'll get a welcome card which has information about the app and the next action to be taken.

A

User can then create tasks. Reminder by filling the task. Description along with the schedule. Part then sends an interruptive card as a response.

A

When the reminder hits now, let's just try and side load the ready to try manifest uh we'll have a demo uh and then then we'll go through the repository and the code snippets.

A

So if you go to microsoft teams, samples repository in the sampling order, what we have started doing is we added a section called: try it yourself and what we have done. We picked top samples and deployed these samples in azure instance.

A

Now what you could do is you could actually go ahead and download these, and before you write any code, you could just try those out. So in today's we are covering this book uh task reminder. I will click on view.

A

This will take a zip file which I'll be able to download and then cyborg in the demo, terran I'll, just open my demo tenant. Meanwhile, click on download this is a zip file which has a manifest available you'll, be able to download that out. So it's downloaded I'll switch to a demo tenant.

A

So what we already did we already downloaded the manifest which we are going to try. We go to app section: click on manage your apps and select upload a custom app. So now I'm installing it in my personal scope.

A

Can you see the bot uh screen now for the daily dance reminder.

B

Yes, I see that now.

A

Once this app is installed, you'll get a welcome message stating that the sample is for scheduling a recurring task and the way to start is by using create reminder. So we'll start with the command, create reminder, and you see a scheduled task. Dialogue.

A

Okay in schedule, task dialog you'll be able to enter the task details.

A

Demo and I'll schedule it for 10 21 and we'll select tuesday, wednesday till friday.

A

Once you submit the task, you'll get a message saying the reminder has been set and after two minutes we'll get the reminder.

A

Meanwhile, we'll go back to slides and take a look at the next next things, so in order to run this sample locally, these are the steps we are going to follow. We are going to clone the repo and open the part daily tasks reminder solution. First, then, we will go to azure and create a new part and capture the ids required.

A

We then launch the ngrok and update the endpoints in the bot, we'll also update the app setting and app manifest file.

A

What I have already done is, I have already cloned this repo. I have just fetched the latest code. What we'll do is we'll open the explorer go to samples, go to a folder for task reminder and open a daily task reminder solution.

A

Okay, so this is the solution for the task reminder. We have opened the app settings and the manifest file.

A

We need microsoft, app id and app password for our app, so the next step is to go and create azure bot and then capture these ids.

A

In order to create a new new bot, you go to create resource and search for azure bot.

A

Once you, click on azure bot and create you'll be asked to enter the bot handle subscription and resource group details.

A

So I'm just giving some dummy name here putting in the resource group and the type of app would be multi-tenant once you fill in then this information click on review and create to save time. I have already created a bot. uh This is already available once this bot is created, you'll be you'll, be shown the bot profile page. This is where you'll be able to upload your custom icon and you will be able to set the display name.

A

What we need to do now is we need to copy the microsoft app id and microsoft app secret, so I have copied this we'll go back and put it in our solution.

A

In order to get the app secret, we click on manage.

A

Go to certificates and secrets and click on new client secret, we'll just keep the recommended option and click on add copy. The client secret date and pasting it back in our code.

A

Next thing we need to do is set up an encrop and run it on the local host port. So this is the angular command. I want to run and open up a tunnel between my port number 3978 and get the https forwarding address, because all the communication in teams happens over https.

A

We need to provide https endpoint for our bot, so I've copied the bot copy. The ngrok url we'll go back to bot, go to configuration section and put the message in point. The endpoint is api, slash messages and we click on save. Now we go back to our solution.

A

We have one value to be filled. This is application base url, it's the same as a n growth base, url.

A

The last step is to go and update the manifest file. So if you go to app packages, folder you'll find the manifest.json file and you'll see the placeholder. Where values need to be updated.

A

You can use the same bot id as a manifest id and for the portal and for the domain we'll just put in the in group domain.

A

Okay, now, let's just open this folder and zip these files, so we have our manifest already now we run the solution locally.

A

This will open up a solution on three nine, seven, eight four and we'll verify whether our ngrok is pointing to the right place. So you can just copy the intro and just please just to confirm that we are running on right code, so we got a request on android for http get and it's loading the same page as localhost.

A

Now we go back to our demo tenant and, as you can see, this was the previous task, which was scheduled, and this actually sent the reminder saying this is a community call.

A

What we'll do now is we'll go back and upload this local manifest what we have.

A

Go to manage apps upload, a custom app, I'm just pasting in the url here.

A

Adding it to my personal scope,.

A

And just to confirm just looking at the ngrok, we started getting the api, slash messages, a request and you could see. We got a welcome message from the our bot, which is running locally and same way. You could uh go ahead and create a reminder. It will follow the same flow which we have already covered.

A

Instead, I will go next and we'll have a code walkthrough covering the code snippets in the sample so coming to the code. Walkthrough we'll start with the libraries using the sample, we're using what shrimp sdk v4 for the scheduler. We are using cart's nuget package and to store the tasks, details and user details. We are using in memory storage in terms of flow. We first start by sending out a welcome message to the user.

A

When the app is installed, then we capture the required information of the user so that we can send them a proactive message.

A

We schedule a job using a cron expression and then we trigger a trigger notification whenever trigger occurs.

A

We will go in detail of each of these, starting with the sending welcome message in order to send a welcome message. We have handle on message added, async method, to send out a message to all the members we get list of members as a part of turn context, dot, activity, payload and we iterate through the list and then send a welcome and say this is something is very important. Whenever your app starts, you could just send out information of what to expect from that and then share the commands. You can run after the welcome message.

A

The next thing is handling a create reminder command, so this is being handled in on message activity as sync and along with sending the adaptive card. What we are doing is. We are also capturing the user details.

A

It's also known as a conversation reference and what we are doing is we are adding this conversation reference in in memory, so we are just keeping it in memory so that we could send out to product message.

A

Here's the detail, json on what conversation reference needs. It actually contains information about user bot and the conversation you'll see bunch of these ids about user and even the conversation, ids and you'll also find the service url, which is very crucial in sending property message.

A

Next thing, we'll check is: how do we actually capture this schedule? Information so based on the input provided by the end user, we create a cron expression and we schedule a task, and this task actually does a http get on api. Slash task input, so, whenever a particular trigger hits, it will just execute this part and do http get request.

A

This is the http get request uh to to to send out a task reminder. What we are doing here is. We are going to the conversation, reference values which we have stored in memory, and we are doing the conversation which actually gives us return context value which then can be used to send the actual adaptive card as a reminder card.

A

We are also adding a few bunch of checks to make sure that we are sending a reminder at a right time. Just to recap, we we had a demo using the ready to try manifest.

A

We also set up what locally and we just site loaded and see that it's running fine key code snippets covered are: how do you capture the conversation reference? How do you schedule a job and then how? Finally, you can send a property messages as per the resources concerned, I have provided the documentation, link and also a step-by-step guide I'll paste in the link in the description.

A

The step-by-step guide available for practice message will give you specific tech, specific steps about setting up things locally. We have provided all the troubleshooting guides here. You could go start from the installation having everything ready, setting up a bot and then doing some code work by updating the adapter card to actually get the final challenge and then, at the end, you'll be able to read more about the proactive messaging documentation.

A

So so that brings us to the final topic. So if there are any questions, uh I think we are on time so we'll try and get it uh we'll try and respond on chat. uh But if there's one or two minutes we can uh take questions.

B

There were one or two questions in the chat. If you do want to take a look at those and try and respond with you, that'd be helpful. um Otherwise, I do see you put a link on here for feedback and questions, so uh folks, please do feel free to take a look at the aka dot, ms slash teams, platform feedback and utilize that for any kind of fault that you might have so that would I really appreciate you coming on today.

B

Do appreciate you coming on to share more about teamspots, a really cool scenario and I'd like to I like what you shared.