Skip to content

Latest commit

 

History

History
226 lines (164 loc) · 11.2 KB

Readme.md

File metadata and controls

226 lines (164 loc) · 11.2 KB
Raw
page_type description products languages extensions contentType createdDate
sample
Demonstrating on how to implement sequential flow, user specific view and upto date adaptive cards in bot.
office-teams
office
office-365
nodejs
javascript
samples
07-07-2021 13:38:26

Sequential workflow adaptive cards

This App talks about the Teams Bot User Specific Views and Sequential Workflows in adaptive card with Node JS

This bot has been created using Bot Framework v4, it shows how to create a simple bot that accepts food order using Adaptive Cards V1.4

This is a sample app that provides an experience of managing incidents. This sample makes use of Teams platform capabilities like Universal Bots with below mentioned capabilities. User Specific Views Sequential Workflows Up to date cards

Key features

  • Incident Creation
    • Choose Category
    • Choose Sub Category
    • Create Incident
    • Edit/ Approve/ Reject Incident
  • List Incidents

Prerequisites

  1. Office 365 tenant. You can get a free tenant for development use by signing up for the Office 365 Developer Program.

  2. To test locally, NodeJS must be installed on your development machine (version 10.14 or higher).

    # determine node version
node --version

  3. 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: The free ngrok plan will generate a new URL every time you run it, which requires you to update your Azure AD registration, the Teams app manifest, and the project configuration. A paid account with a permanent ngrok URL is recommended.

To try this sample

  • Register Azure AD applications

    • Register your bot using bot channel registration in Azure AD portal, following the instructions here.
    • Ensure that you've enabled the Teams Channel

  • Clone the repository

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

  • In a console, navigate to samples/bot-sequential-flow-adaptive-cards/nodejs

    cd samples/bot-sequential-flow-adaptive-cards/nodejs

  • Run ngrok - point to port 3978

    ngrok http -host-header=localhost 3978

  • Update the .env configuration for the bot to use the MicrosoftAppId (Microsoft App Id) and MicrosoftAppPassword (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.

  • Install modules & Run the NodeJS Server

    • Server will run on PORT: 3978
    • Open a terminal and navigate to project root directory
    npm run server

    This command is equivalent to: npm install > npm start

  • 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) also update the <<DOMAIN-NAME>> with the ngrok URL
    • 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")

Workflows

Workflow for bot interaction

sequenceDiagram
    participant Teams User B    
    participant Teams User A
    participant Teams Client
    Teams User A->>+Teams Client: Enters create incident bot commands
    Sample App->>+Teams Client: loads card with option 
    Teams User A->>+Teams Client: Enters required details and assigns to user B
    Sample App-->>Teams Client: Posts the incidet card with auto-refresh for user A and user B
    Teams Client->>Teams User A: loads incident card with loading indicator 
    Teams Client->>Sample App: Automatically invokes refresh action
    Sample App-->>Teams User A: Responds with Updated AC for the user A
    Teams User B->>Teams Client: User opens the chat
    Teams Client-->>Teams User B: Loads the incident base card
    Teams Client->>Sample App: Automatically invokes refresh action
    Sample App-->>Teams User B: Responds with card for user B with option to approve/reject
Loading

Workflow for messaging extension interaction

sequenceDiagram
    participant Teams User B    
    participant Teams User A
    participant Teams Client
    Teams User A->>+Teams Client: Clicks on Incidents ME action in a group chat
    opt App not installed flow
        Teams Client-->>Teams User A: App install dialog
        Teams User A->>Teams Client: Installs app
    end   
    Teams Client->>+Sample App: Launches Task Module
    Sample App-->>-Teams Client: Loads existing incidents created using Bot
    Teams User A->>Teams Client: Selects incident to share in chat
    Teams Client->>Sample App: Invoke action callback composeExtension/submitAction
    Sample App-->>Teams Client: Posts Base card with auto-refresh for user A and user B
    Teams Client->>Teams User A: loads incident card with loading indicator 
    Teams Client->>Sample App: Automatically invokes refresh action
    Sample App-->>Teams User A: Responds with Updated AC for the user A
    Teams User B->>Teams Client: User opens the chat
    Teams Client-->>Teams User B: Loads the incident base card
    Teams Client->>Sample App: Automatically invokes refresh action
    Sample App-->>Teams User B: Responds with card for user B with option to approve/reject
Loading

Interacting with the bot in Teams

You can interact with this bot by @Sequential Workflows (BotName). The bot will respond with adaptive card requesting you the details.

  • Install App

Navigate to Manage apps > Upload a custom app (Bottom-Right of the screen) > Upload manifest.zip > Add image

image

  • Open The App

Type in Chat: @Sequential Workflows (BotName) and Enter

image

Create New Incident

image image image image

Only the Created By person have the option to Edit

image

Edit Incident

image

Approve or Reject Incidents

Only the Assigned To person have the option to Approve or Reject

image image image

List Incidents

image image

Interaction from messaging extension.

You can also interact with this app using messaging extension action which allows you to share incidents in group chats.

  1. On selecting app from messaging extension,it checks whether bot is installed in chat/team. If not installed, user will get a option for justInTimeInstallation card.

    just in time installation card

  2. After successful installation, list of all incident will be available in messaging extension.

    incident list card.

  3. User can select any incident from the list and can share to that chat/team.

    image

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