Microsoft Teams
Microsoft Teams integration in Qualytics enables seamless communication by connecting your Microsoft Teams workspace with data quality updates and notifications. It involves configuring Azure resources, providing necessary credentials, and establishing a direct link to your Teams workspace for alerts and communication.
Let's get started 🚀
Microsoft Teams Setup Guide
This section provides a comprehensive walkthrough to help you configure the necessary resources and retrieve the required credentials. By following this setup process, you'll have everything you need to complete the integration form.
Warning
Some steps in this guide may require administrator privileges in your Microsoft Azure environment. If you don't have the necessary permissions, you might need to coordinate with your IT department or someone with administrative access to your Azure tenant.
Creating a Microsoft Entra App Registration
The Microsoft Entra App Registration is used by Qualytics to provision Teams bot resources in your environment.
Step 1: Navigate to the Microsoft Entra App Registrations in the Azure Portal.
Step 2: Click on New registration to create a new app.
Step 3: Fill in the required details for the app registration:
- Name: Provide a name for your app (e.g., "Qualytics Bot Manager")
- Supported account types: Select "Accounts in this organizational directory only (Single tenant)"
- Redirect URI: Leave blank as it's not required for this integration
Step 4: Click Register to create the app registration.
Step 5: After the app is created, note the Application (client) ID from the Overview page. This will be used as the App Client ID for the Qualytics integration.
Adding API Permissions
The Microsoft Entra App needs the "Application.ReadWrite.All" permission to create and manage bot resources.
Step 1: In your app registration, select Manage > API permissions from the left menu.
Step 2: Click Add a permission
Step 3: Select Microsoft Graph from the options.
Step 4: Choose Application permissions.
Step 5: Search for and select Application.ReadWrite.All.
Step 6: Click Add permissions.
Step 7: Click on Grant admin consent for [Your Organization] to approve these permissions.
Creating a Client Secret
The Client Secret authorizes Qualytics to programmatically create bot resources.
Step 1: In your app registration, select Certificates & secrets from the left menu.
Step 2: Under the Client secrets tab, click New client secret.
Step 3: Add a description for the secret (e.g., "Qualytics Integration") and select an expiration period (maximum of 24 months).
Step 4: Click Add.
Step 5: Immediately copy and securely store the Value of the secret that appears. This will be used as the App Client Secret for the Qualytics integration.
Warning
The client secret value is only displayed once immediately after creation. Make sure to copy and securely store it as you won't be able to retrieve it again.
Retrieving the Azure Subscription ID
The Subscription ID is required to manage bot resources in your Azure environment.
Step 1: Navigate to Subscriptions in the Azure Portal.
Step 2: Select the subscription you want to use for the Teams integration.
Step 3: Copy the Subscription ID from the overview page.
Verifying the Microsoft Bot Service
You need to verify if the Microsoft Bot Service resource provider is registered in your subscription.
Step 1: In your subscription, navigate to Settings > Resource providers.
Step 2: Search for "Microsoft.BotService" and verify the status column.
Note
The step 3 is only required if the resource provider is not already registered. If the Microsoft.BotService provider is already marked as "Registered" in your subscription, you can skip this step.
Step 3 (maybe optional): Click Register to enable the resource provider if it's not already registered.
Setting Up the Resource Group
The Resource Group will hold and manage the bot resources created by Qualytics.
Step 1: Navigate to Resource Groups in the Azure Portal.
Step 2: Click Create to create a new resource group if you don't already have one to use.
Step 3: Select your subscription, enter a resource group name (e.g., "qualytics-msft-teams-rg"), and select a region.
Step 4: Click Review + create, then Create.
Step 5: Once created, note the Resource Group name for the Qualytics integration.
Assigning the Azure Bot Service Contributor Role
The Microsoft Entra App needs the "Azure Bot Service Contributor" role to manage bot resources.
Step 1: Navigate to your Resource Group and select Access control (IAM) from the left menu.
Step 2: Click Add > Add role assignment.
Step 3: In the Role tab, search for and select the Azure Bot Service Contributor role.
Step 4: Click Next.
Step 5: In the Members tab, select User, group, or service principal, then click Select members.
Step 6: Search for and select the Microsoft Entra App you created earlier.
Tip
Enterprise Applications will only appear in the search results when you start typing the exact name used in your Entra App registration. If you don't see your app immediately, try typing the full name as you entered it when creating the app.
Step 7: Click Select, then Review + assign.
Step 8: Click Review + assign again to confirm the role assignment.
Getting Your Microsoft Teams Link
You need to provide the link to your Microsoft Teams workspace.
Step 1: Open Microsoft Teams desktop or web application.
Step 2: Navigate to the team where you want to receive Qualytics notifications.
Step 3: Right-click on the team name and select Get link to team.
Step 4: Copy the link provided.
Integration Summary
Now that you've gathered all the necessary information and configured the Azure resources, you're ready to integrate Microsoft Teams with Qualytics.
In the next section, we'll walk through the steps to access the Qualytics integration interface and enter these credentials to establish the connection between Qualytics and Microsoft Teams.
Navigation to Integration
Step 1: Log in to your Qualytics account and click the "Settings" button on the left side panel of the interface.
Step 2: By default, Connections tab will open. Click on the Integrations tab.
Connect Microsoft Teams Integration
Connect Microsoft Teams by providing necessary Azure credentials, configuring bot resources, and establishing a direct link to your Teams workspace for secure communication.
Step 1: Click on the Connect button next to Microsoft Teams to connect to the Teams Integration.
A modal window titled "Add Microsoft Teams Integration" appears. Fill in the connection properties to connect to Microsoft Teams.
Step 2: Fill out the required provisioning properties for the Microsoft Teams integration:
No. | Field Name | Description |
---|---|---|
1. | App Client ID | The Application (client) ID from the Overview page of your Entra App registration. |
2. | App Client Secret | The secret value you copied after creating a new client secret in your Entra App. |
3. | Azure Subscription ID | The Subscription ID you copied from the Azure Subscriptions page. |
4. | Azure Resource Group Name | The name of the Resource Group you created or selected for bot resources. |
5. | Microsoft Teams Link | The team link you copied from Microsoft Teams using the "Get link to team" option. |
Step 3: Click the Provision and Next button to provision the app resources and proceed with publishing the Qualytics app to the Microsoft Teams App Catalog.
Note
Provisioning the app resources may take around 15 seconds to complete.
Once the app resources have been successfully provisioned, a confirmation message will appear stating, "The Teams app resources have been successfully provisioned."
Step 4: Click the Publish button to publish the Qualytics app to your organization's Microsoft Teams App Catalog.
A dialog will appear asking you to accept the requested permissions. Click Accept to proceed with the publication.
Once the app has been successfully published, a confirmation message will appear stating, "The Teams app has been successfully published to your organization's App Catalog."
Warning
Microsoft may take up to 24 hours to make the app available in Teams after it's published.
Completing the Teams Integration
After publishing the app to your organization's Teams App Catalog, the integration will show a "Pending" status in Qualytics until the app is installed in a Teams channel.
Installing the App in Microsoft Teams
To complete the integration, you need to install the Qualytics app in Microsoft Teams:
Step 1: Open Microsoft Teams desktop or web application.
Step 2: Click on Apps in the left sidebar.
Step 3: Select Built for your org to see custom apps for your organization.
Step 4: Find and select the "Qualytics" app.
Note
If you don't see the app immediately, it might still be propagating through Microsoft's systems. This can take up to 24 hours.
Step 5: Click Add to begin the installation process.
Step 6: When prompted, select a team and channel where you would like to add the Qualytics app, then click Set up to complete the installation.
Tip
When you add the app to a team and channel, Qualytics will automatically detect the installation. You may need to refresh your browser to see the status update from "Pending" to "Connected" in the Qualytics Integrations page.
Manual Verification (optional)
Important
Manual verification serves as a fallback method if Qualytics doesn't automatically detect the app installation after adding it to a channel. If the status remains "Pending" after installing the app and refreshing the Qualytics page, use this manual verification process to complete the integration.
To manually verify the integration:
Step 1: Return to the Qualytics Integrations page.
Step 2: Click on the Verify app installation button next to the Microsoft Teams integration.
When the verification is successful, the integration status will change to "Connected", indicating that Qualytics can now send notifications to your Microsoft Teams workspace.