Skip to content

Latest commit

 

History

History
 
 

java

README.md

page_type description products languages extensions urlFragment
sample
This sample app demonstrate is how to use Task Module using Bot Framework.
office-teams
office
office-365
Java
contentType createdDate
samples
12/12/2019 13:38:25 PM
officedev-microsoft-teams-samples-bot-task-module-java

Teams Task Module

Bot Framework v4 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.

This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.

Included Features

  • Bots
  • Tabs
  • Task Modules

Interaction with bot

TaskModule

Try it yourself - experience the App in your Microsoft Teams client

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).

Teams Task Module: Manifest

Prerequisites

  • Intall Java 1.8+ Java
  • Install Maven
  • Setup for Java and Maven Setup
  • An account on Azure if you want to deploy to Azure.
  • Microsoft Teams is installed and you have an account
  • ngrok or equivalent tunnelling solution

Setup

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. Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"

  2. Setup for Bot

    In Azure portal, create a Azure Bot resource.

    • For bot handle, make up a name.
    • Select "Use existing app registration" (Create the app registration in Azure Active Directory beforehand.)
    • If you don't have an Azure account create an Azure free account here

    In the new Azure Bot resource in the Portal,

    • Ensure that you've enabled the Teams Channel
    • In Settings/Configuration/Messaging endpoint, enter the current https URL you were given by running ngrok. Append with the path /api/messages

  3. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

  4. Update the resources/application.properties file configuration in your project, 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.) The Task Modules using pages require the deployed bot's path in BaseUrl.

  5. From the root of this project folder: (samples/bot-task-module/java)

    • Open a terminal and build the sample using mvn package command
    • Install the packages in the local cache by using mvn install command in a terminal
    • Run it by using java -jar .\target\bot-teams-task-module-sample.jar command in a terminal

  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)
    • Edit the manifest.json for validDomains with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app.
    • Zip up the contents of the TeamsAppManifest folder to create a manifest.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
    • Upload the manifest.zip to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
    • Add the app in personal/groupchat/team scope (supported scopes)

Running the sample

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.

  • Send Adaptive Cards:
    Adaptive Cards

  • Opened Task Module with input field via clicking on Adaptive Card button:
    Card Input

  • Submitted response card: Card Form

  • Opened Task Module with custom form via clicking on Adaptive Card's "Custom Form" button: Card Youtube

  • Opened Task Module to play YouTube video via clicking on Adaptive Card's "YouTube" button: Card Youtube

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