botbuilder-java/samples/54.teams-task-module

Teams Task Module

Bot Framework Teams Task Module sample.

This bot has been created using Bot Framework. It shows how to fetch a Task Module from a Hero Card button and receive input from an Adaptive Card in the Task Module.

Prerequisites

• Microsoft Teams is installed and you have an account
• ngrok or equivalent tunnelling solution

To try this sample

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. Clone the repository

   git clone https://github.com/Microsoft/botbuilder-java.git
   

2. Run ngrok - point to port 3978

   ngrok http -host-header=rewrite 3978
   

3. Create Bot Framework registration resource in Azure

   • Use the current https URL you were given by running ngrok. Append with the path /api/messages used by this sample
   • Ensure that you've enabled the Teams Channel
   • If you don't have an Azure account you can use this Bot Framework registration

4. Update the resources/application.properties configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.)

5. Update CustomForm.html to replace your Microsoft App Id everywhere you see the place holder string <<YOUR-MICROSOFT-APP-ID>>

6. This step is specific to Teams.

   • Edit the manifest.json contained in the teamsAppManifest folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string <<YOUR-MICROSOFT-APP-ID>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json). Note: the Task Modules containing pages will require the deployed bot's domain in validDomains of the manifest.
   • Zip up the contents of the teamsAppManifest folder to create a manifest.zip
   • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

7. From the root of this project folder:

   • Build the sample using mvn package
   • Unless done previously, install the packages in the local cache by using mvn install
   • Run it by using java -jar .\target\bot-teams-task-module-sample.jar

Interacting with the bot in Teams

Note this manifest.json specified that the bot will be installed in "personal", "team" and "groupchat" scope which is why you immediately entered a one on one chat conversation with the bot. You can at mention the bot in a group chat or in a Channel in the Team you installed it in. Please refer to Teams documentation for more details.

You can interact with this bot by sending it a message. The bot will respond with a Hero Card with a button which will display a Task Module when clicked. The Task Module demonstrates retrieving input from a user through a Text Block and a Submit button.

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading

• How Microsoft Teams bots work