Skip to content

Solution overview

Jump to bottom
Priyank Saxena edited this page Aug 19, 2020 · 12 revisions

Overview

The Company Communicator app has the following main components:

  • App Service: The app service implements the message compose experience in the team tab, and the messaging endpoint for the bot.
  • Service Bus: The individual messages sent by the bot to the recipients are enqueued on a service bus queue, to be processed by an Azure Function. This queue decouples the message composition experience from the process that delivers the message to recipients.
  • Azure Function: The Azure Functions picks up the messages from the queues, prepares the recipients and delivers them.
  • Microsoft Graph API: The app leverages Microsoft Graph APIs to Search Groups, Get Group Transitive Members and Get User.

App Service

The app service implements two main components, the tab for composing messages and viewing their status, and the messaging endpoint for the bot.

Messages tab

The messages tab is the interface by which message authors create the messages to be sent, specify the intended recipients, and initiate the send. After sending, the tab reports the status of the message delivery, as counts of deliveries that were successful, failed, or throttled.

The tab is implemented as a React application, using UI components from Stardust UI and Office UI Fabric React. The message compose UX is in a task module, with a message preview implemented using the Adaptive Cards SDK.

The tab's front-end gets its data from web APIs implemented by the same app service that's hosting it. These APIs are protected by AAD token authentication, which checks that the user attempting to access the site is in the list of valid senders.

Bot endpoint

The app service exposes a bot messaging endpoint, which receives activities from Bot Framework as the user interacts with the app.

conversationUpdate: When the app is installed in team, or personally by users, the bot is notified via a conversationUpdate activity. The bot uses these messages to keep track of the users and teams that have installed the app:

  • The list of teams is used to populate the team picker in the compose UX
  • The bot tracks the Teams user ids (29:xxx) of the users that install the app, so that it can broadcast messages to them. Proactive messaging in Teams requires the bot to know this unique ID, which otherwise cannot be derived from their AAD ID or UPN.

messageReaction: When the user reacts to a message sent by the bot, Teams sends the bot a messageReaction event. We don't use this information in the initial version, we plan to do so in the future.

fileConsent: When the user accepts/decline the file consent card sent by the bot, Team sends the bot a fileConsentAccept or fileConsentDecline event.On user's consent file is uploaded to user's One Drive.

Azure Function

Company Communicator uses five Azure Functions:

Send function

This function is executed on each message in the "send" Service Bus queue, which contains the delivery information for each recipient. The function will:

  1. Get an access token for the bot, if needed.
  2. Construct the message to send, based on the message ID.
  3. If the recipient is an individual user, check if we have a known 1:1 conversation with them. If not, create a conversation and update the user record with the conversation ID. (We cache the conversation ID so we don't need to create it repeatedly.)
  4. Send the message to the recipient.
  5. Store the outcome of the delivery in an Azure table.

Data aggregation function

An instance of this function runs every 30 seconds, while the app is actively delivering messages. For each message that's currently in the sending state, the data aggregation function checks the delivery records created by the Send fuction, and updates the success, failure, and throttle counts, so that the information shown in the tab is up-to-date.

Prepare To Send function

This is an durable function and is executed on each message in the "prepare-to-send" Service Bus queue. The function will:

  1. Get the receipients of the message, based on the message ID.
  2. Store the receipients in an Azure Table.
  3. Prepare the adaptive card.
  4. Send a data aggregation trigger queue message to the data queue for the data function to process.
  5. Send triggers to Send queue for the Send function.

Export function

This is an durable function and is executed on each message in the "export" Service Bus queue. The function will:

  1. Get the receipients of the sent message, based on the message ID.
  2. Create and stage the zip file in Azure Blob Storage.
  3. Send the File Consent Card to upload the file to User's One Drive.

Clean Up function

This is an time trigger function and runs as per the scheduled time. It deletes the staged files and file consent card for which there is no response from user within a set period of time.

Microsoft Graph API

  1. Company communicator app service performs group search which requires delegated permission and tenant admin to provide consent.
Sr. No. Use Case API Delegated permissions API version
1. Search Groups GET https://graph.microsoft.com/v1.0/groups?$filter={condition} Group.Read.All V1.0
  1. Company Communicator azure functions gets group transitive members and get user details which requires application permissions and tenant admin to provide consent.
Sr. No. Use Case API Application permissions API version
1. Get Group Transitive Members GET https://graph.microsoft.com/v1.0/groups/{group-id}/transitiveMembers Group.Read.All V1.0
2. Get User GET https://graph.microsoft.com/v1.0/Users/{user-id} User.Read.All V1.0
Clone this wiki locally