Skip to content

Latest commit

 

History

History
166 lines (144 loc) · 10.3 KB

README.md

File metadata and controls

166 lines (144 loc) · 10.3 KB
Raw
page_type description products languages extensions contentType createdDate
sample
In-Meeting Document Signing
office-teams
office
office-365
csharp
samples
09-03-2022 15:56:00

In-Meeting Document Signing

Meeting Signing is a Teams sample app that demonstrates the scenario of enabling users to sign documents in real time during meetings making possible to review and sign documents in a single session. This sample lets users electronically sign documents with their current tenant identity. Some example documents that can be signed during meetings are Purchase Agreements and Purchase Orders. This template is also applicable, and could be adapted for other scenarios like reviewing and approving code reviews or collaborative reviewing of documents

The sample app could be customized to incorporate other kind of signatures like handwritten signatures or certificate based signatures.

Personas:

This sample has 3 main personas:

  • Document creator: this role can add their own documents to be signed using the app
  • Signer: this role will be able to sign documents reviewed during the meeting
  • Reader: this role will only be able to read the documents reviewed during the meeting

Scenarios:

  • Add documents to be reviewed during a meeting
  • Share documents to be reviewed to main stage
  • Sign documents using the signer’s identity

Included Features

  • Teams SSO
  • Programmatic sharing of content to stage
  • Stage app view depends on the authentication of the user
  • Adaptive Cards
  • People Picker

Video documenting the sharing to stage, including the choosing of a document from the sidepanel, and the signing of the document on the stage

Workflow

sequenceDiagram
    Teams User->>+Teams Client: Schedules a Teams Meeting with members
    Teams Client->>+MeetingSigning App: Installs the App
    Teams User->>+Teams Client: Pre meeting, organises the documents
    Teams Client->>+MeetingSigning App: Opens the pre-meeting tab
    MeetingSigning App->>+Document Creation : From pre-meeting tab, creates a document and assigns signers & readers
    Document Creation-->>-MeetingSigning App: Document created
    Teams User->>+Teams Client: Starts the meeting
    Teams User->>+MeetingSigning App: Opens the MeetingSigning side panel
    MeetingSigning App->>+Side Panel: Loads documents
    Side Panel-->>-MeetingSigning App: Loads meeting organizer's documents
    MeetingSigning App->>+Side Panel: Select document to share to stage
    Side Panel-->>-Teams Client: Tells the team client to open a document on the stage
    Teams Client->>+Document Stage: Tells the app which document to open
    Document Stage-->>-MeetingSigning App: Shares the document to share to stage in the meeting
Loading

Usage

  • Sideload the app to a meeting.
  • In the meeting group chat, add the Meeting Signing app as a new Tab.
  • In the pre-meeting tab, create a test document so you can test the meeting share to stage APIs.
  • Provide one-time consent to the app for Graph permissions while creating the document.
  • Start the meeting.
    • In the bar at the top, select Meeting Signing to open the sidepanel.
    • You will see any documents you created here
    • Select Share to Meeting on a document you want to share to stage.
    • All participants of the meeting will see the app being shared to the stage. Participants who are either signers, viewers or document creators will be able to see the document. Participants not a signer, viewer or creator will see an error stating they do not have permissions to view the document.
    • Signers are able to sign a document, and all viewers will have their view of their document updated to include that signature.

User specific views

  • A user/meeting attendee can be either a viewer or a signer. If neither, an error message "you aren't allowed to see this document" will be displayed.
  • A viewer can only view the document.
  • All signers can view and sign a document.

Known issues

Feature Rollout

Currently, this app is not fully supported in the following scenarios:

  • Mobile
  • The current generally available Teams for Web does not support meeting apps.

User Permissions

  • Tenant - If assigned by the document creator, the User will be able to see and sign the document.
  • Federated/Guest Users:
    • The app loads but it's not possible to be authenticated to load the document. This is due to a bug in Teams SSO
    • The people picker does not allow users outside of the tenant to be selected. Similarly, if a federated user creates the document, they are only able to select people in their tenant as signers/viewers, and nobody from outside their tenant can view the document.
  • Anonymous Users - Does not work because apps can't get an SSO token for anonymous users.

Common Problems

Prerequisites

Steps

  • Start Ngrok
  • Create an Azure AAD App Registration
  • Update URL in Manifest
  • Build C# App
  • Deploy to Teams

Set up

  • Run Ngrok
    • Run ngrok and point it to the port the Web App is listening on.
    ngrok http https://localhost:44326 -host-header=localhost:44326 # For Visual Studio
    • Make sure to copy and save the https url (it should look like https://<randomsubdomain>.ngrok.io).
  • Register an App in AAD that can be used for Teams SSO
    • Once the app is registered update Redirect Uris under the Authentication section with the ngrok url, followed by /auth-end (https://.ngrok.io/auth-end)
    • Ensure the following API permissions are granted to the app for Microsoft Graph access - email, offline_access, openid, profile, User.Read, User.ReadBasic.All
    • Note: if you restart Ngrok you may have to update any fully qualified domain name you have set in your AAD App
    • After you create an AAD app, under Certificates & secrets create a new Client secret. Copy the secret value and set it in appSettings.json
  • In appSettings.json, manifest.json and .env replace:
    • <<deployment-url>> with your ngrok url, minus the https://.
    • <<aad-id>> with your AAD Application (Client) Id.
    • <<client secret>> with the client secret you created above.
  • Project Structure
    • The sample contains 3 projects
      • Web - Exposes REST APIs for documents and signing scenarios supported in this POC.
        • Web\ClientApp contains the Front End code to support document sharing in a meeting via share to stage.
      • Domain - Contains the business logic to support the REST APIs.
      • Infrastructure - Fulfils Domain's dependencies like data repositories, graph support needed.
  • Deploying
    • There are detailed instructions for deploying locally below.
  • Sideloading the App

Deployment

Locally in Visual Studio

  • Point Ngrok to port 44326: ngrok http https://localhost:44326 -host-header=localhost:44326
  • Open the solution in Visual Studio.
  • Ensure the start-up project is set to Microsoft.Teams.Samples.MeetingSigning.Web
  • Start Debugging using IIS Express

Locally using .NET SDK

  • Point Ngrok to port 5001: ngrok http -host-header=rewrite 5001
  • In a terminal, navigate to Source\MeetingSigning.Web
  • Run dotnet run

Docker

Note the below instructions are using Podman, but Docker's commands are similar. There are instructions for setting up Podman on WSL2 here

  • From this directory build the Docker image podman build -f Deployment/Dockerfile --ignorefile Deployment/.dockerignore ./Source --build-arg REACT_APP_AAD_CLIENT_ID
  • Wait for the container to build
  • Run podman images to view available images, copy the Image ID
  • Point Ngrok to port 8080: ngrok http -host-header=rewrite 8080
  • Run podman run -d -p 8080:80 --name MeetingSigning <IMAGE_ID> to start the container
  • Open http://localhost:8080/ to view the service running

Additional links