Revision Log... (Last updated: 23-Jan-2023)
Version | Published | Summary of Changes |
---|---|---|
1.0 | 25-Jan-2023 | Initial version |
Note: The guideline below is intended for readers in the SE, SRE staff. Please login to see the images on this page. |
Overview
This article describes the steps required to create a Microsoft Teams developer account, Azure app and a Microsoft Teams app.
Create the Microsoft Teams developer account and Azure app
Create the Microsoft Teams account and Azure app as part of the Sidebar with Microsoft Teams integration.
Role required: admin
Procedure
1. Register your Microsoft developer account.
For more information, see https://developer.microsoft.com/en-us/microsoft-365/dev-program.
2. Register your application in Azure portal.
For instructions on registering an application, see Tutorial: Register an app with Azure Active Directory in the Microsoft Docs.
3. In the Microsoft Azure portal, copy and record the Directory ID for later use.
For more information, see Get tenant and app ID values for signing in in Microsoft Azure documentation.
4. Copy the Application ID for later use. Copy the App ID and not the External app ID.
5. For redirect URLs, go to Authentication module and add the instance's URL to the list of Redirect URLs. If you don't see the single-page application accordion, click Add a platform to add it.
6. Add all the following API permissions to the app.
7. Add meters to monitor costs billed for the metered Microsoft Teams APIs.
For instructions: see https://learn.microsoft.com/en-us/graph/teams-licenses#payment-and-billing
Create the Microsoft Teams App
Create your Microsoft Teams app as part of integrating Sidebar with Microsoft Teams.
Role required: admin
Procedure
1. Log in to the Microsoft Teams client at https://teams.microsoft.com/.
2. Select the More added apps icon(3 dot button) from the left-side panel.
3. Select or search for Developer Portal.
4. On the Developer Portal screen, select the Apps tab, then New app.
5. Enter the basic information.
6. Copy the Application (client) ID from the Azure portal to the Application (client) ID field. (You may need scroll down the page to find the Application (client) ID field)
7. Select Save.
8. Navigate to App features and select Group and channel app. Select Group Chat in Scope section and provide your Configuration URL (this URL does not affect any functionality).
9. Complete the form and select Save.
10. Navigate to the App package screen and select "Download app package" at the top of the page.
11. Select Apps from the left-side menu and select Manage your apps at the bottom of second layer.
12. Select Upload an app and submit an app to your organization.
13. Select the downloaded zip file from the step 8.
14. Sign in to the Microsoft Teams admin page at https://admin.teams.microsoft.com/.
15. Select Teams Apps then Manage apps from the left panel.
16. Search for the uploaded app by name.
17. Open the app from Teams admin and select Publish.
18. Open the app details page from Teams admin and copy the App ID.
Trouble shooting
If you run into trouble, and don't know what went wrong, try these steps before reaching the Dev team.
- When a message is sent from ServiceNow, you should see the new conversation in Teams is linked to App:
2. Check the System Logs in ServiceNow for errors.
3. Test some flow and action with debugging turned on:
(a) Subflow: Create Collaboration Chat
Turn on debugging: Click more option (3 dots) -> Flow Reporting Settings -> click Reporting Level to Full.
Then create a chat and then check the Executions.
(b) Test Action: Get Chat Subscription
Same steps to turn on debug and check Executions.
4. If no messages are sent either ways, check the Admin Settings config. Sometimes copy paste of client id, password, etc can be wrong.