page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This application demonstrates how to scan products directly within Microsoft Teams, capturing images and allowing users to approve or reject items. |
|
|
|
officedev-microsoft-teams-samples-tab-product-inspection-csharp |
This sample application provides a seamless product inspection experience within Microsoft Teams, enabling users to scan product barcodes and capture images to mark items as approved or rejected. With integrated device permissions and user-friendly interactions, this app enhances operational efficiency and streamlines product management directly in the Teams environment.
- Tabs
- Device Permissions (media)
Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app manifest (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).
Product Inspection: Manifest
- Microsoft Teams is installed and you have an account (not a guest account)
- .NET Core SDK version 6.0
- dev tunnel or ngrok latest version or equivalent tunneling solution
- M365 developer account or access to a Teams account with the
- Teams Toolkit for Visual Studio
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio.
- Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
- Install Teams Toolkit for Visual Studio Teams Toolkit extension
- In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
- In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
- Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
- In the browser that launches, select the Add button to install the app to Teams.
If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.
-
Register a new application in the Microsoft Entra ID – App Registrations portal.
NOTE: When you create your app registration, you will create an App ID and App password - make sure you keep these for later.
-
Setup NGROK
-
Run ngrok - point to port 3978
ngrok http 3978 --host-header="localhost:3978"
Alternatively, you can also use the
dev tunnels
. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:devtunnel host -p 3978 --allow-anonymous
- Setup for code
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
Build your solution
- Launch Visual Studio
- File -> Open -> Project/Solution
- Navigate to
samples/tab-product-inspection/csharp/ProductInspection
folder - Select
ProductInspection.csproj
file - Press
F5
to run the project
-
Config changes
- Press F5 to run the project
- Update the tunnel URL in manifest
- Zip all three files present in manifest folder
- Setup Manifest for Teams
-
This step is specific to Teams.
- Edit the
manifest.json
contained in the ./appPackage folder to replace your Microsoft App Id (that was created when you registered your app registration earlier) everywhere you see the place holder string{{Microsoft-App-Id}}
(depending on the scenario the Microsoft App Id may occur multiple times in themanifest.json
) - Edit the
manifest.json
forvalidDomains
and replace{{domain-name}}
with base Url of your domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.app
then your domain-name will be1234.ngrok-free.app
and if you are using dev tunnels then your domain will be like:12345.devtunnels.ms
. Note: If you want to test your app across multi hub like: Outlook/Office.com, please update themanifest.json
in thetab-product-inspection\csharp\ProductInspection\AppManifest_Hub
folder with the required values. - Zip up the contents of the
Manifest
folder to create aManifest.zip
orAppManifest_Hub
folder to create aAppManifest_Hub.zip
(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- Edit the
-
Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")
- Go to Microsoft Teams. From the lower left corner, select Apps
- From the lower left corner, choose Upload a custom App
- Go to your project directory, the ./appPackage folder, select the zip folder, and choose Open.
- Select Add in the pop-up dialog box. Your app is uploaded to Teams.
Interact with Product Inspection by clicking on the App icon.
-
Once the app is clicked, Product Inspection appears with the default product list.
-
On click on "Inspect product" button, scanner will open when scan the product bar code user can Approve or Reject the product.
-
On click on "View product status" button, scanner will open when scan the product bar code and user can view the detail of the product.
-
To view your app in Outlook on the web.
-
Go to Outlook on the weband sign in using your dev tenant account.
On the side bar, select More Apps. Your sideloaded app title appears among your installed apps
Select your app icon to launch and preview your app running in Outlook on the web
Note: Similarly, you can test your application in the Outlook desktop app as well.
-
To preview your app running in Office on the web.
-
Log into office.com with test tenant credentials
Select the Apps icon on the side bar. Your sideloaded app title appears among your installed apps
Select your app icon to launch your app in Office on the web
Note: Similarly, you can test your application in the Office 365 desktop app as well.