This article describes how to install and configure the Microsoft Teams integration for TeamDynamix. Instructions for how to install Teams in Office 365 may change without notice from TeamDynamix.
Installing the TDX Teams integration
Follow these steps in order to install the TeamDynamix integration in the Teams app catalog:
Notes: Each of these steps only needs to happen one time per Office 365 environment--you do not need to follow these steps for every Team within one O365 tenant.
TeamDynamix only supports the production instance of the Teams integration in the production instance of TeamDynamix. i.e., We do not support configuration of the Teams integration from the sandbox.
As of 11/23/2020 Microsoft has not enabled the Manage Apps functionality for Government Clients.
If you are a Government Community Cloud (GCC) customer with Microsoft, this integration will not work:
https://docs.microsoft.com/en-us/microsoftteams/manage-apps
- Download the installation file:
- Log in to TDNext in your TeamDynamix production environment and navigate to the Downloads application.
- Select the Teams Integration for TeamDynamix and download it. A .zip file will be downloaded which includes the information Teams needs to set up the integration, tailored to your TeamDynamix environment.
- Add the integration to your Teams environment.
- Navigate to the Microsoft Teams admin center at https://admin.teams.microsoft.com to manage the Teams environment.
- In the left navigation menu, select Teams apps > Manage apps.
- In the Manage apps page, select Upload new app.
- Click Select a file and provide the .zip file downloaded in step 1. Teams will add the TDX app to the list of installed applications.
- Add the integration to a Team.
- In the Teams desktop app, choose one or more Teams where you would like to add the TDX integration.
- This allows the integration to be invoked using @TDX in that Team, but is not required to use the messaging extension for posts in that team or for chats outside of teams.
- For the selected team, click the ellipsis menu > Manage team > Apps tab.
- Click More Apps to view the list of apps.
- Select the TDX app (search for it if it is not shown in the "Built for [Organization]" section). The details of the TDX app will display.
- If you don't see it after searching, it may still be propagating through your environment after being installed in step 2 above.
- Click Add > Add to a team, then select the appropriate team or channel.
- Click Set up a bot to save.
- Teams will take you to the selected channel, and the TeamDynamix bot will send a message with the Azure Tenant ID, which will be used for setup in TeamDynamix.
- Set up the integration in TDAdmin.
- In TeamDynamix, navigate to TDAdmin > Security and create an Admin Service Account. If you have a local TeamDynamix Admin Service Account already, skip to step 2.
- Usually, the first and last name values are something like API User, and this account can act as a service account to help you use some of the technical components of TDX
- When creating the account, check the Use as the TeamDynamix integrations account box
- Completing these steps will allow the Teams integration to communicate back with TDX
- Navigate to TDAdmin > Organization Settings > Integrations and click +New.
- Set the following values:
- Integration Type: Microsoft Teams
- Name: provide a name for the Teams environment. TeamDynamix can connect to multiple Teams environments by setting up multiple Integrations records.
- Description: optionally provide a description
- Azure Tenant ID: enter the Microsoft Teams Tenant ID.
- Is Active: checked
- Save.
The Teams integration is now configured and should be automatically registered. After these steps are completed successfully, the Status command (see below) should indicate that the Integration State for the Organization is "Registered" and the Integration State for the user is "Not Registered". Follow the instructions in the Using TeamDynamix with Microsoft Teams article to register your user for the first time.
If a Teams user needs to be unlinked from the TeamDynamix user, this can be done in the TDAdmin > Organization Settings > Integrations page.
Troubleshooting the TDX Teams Integration
Once the TDX app is installed in Teams, you can use the Status and Help commands in a conversation with the @TDX bot in order to get the details of the integration's status.
Status will provide information about whether the integration has been set up with TeamDynamix:
Help will provide basic information about the integration and a link to the TDX knowledge base help article.