Skip to main content

Integrate with custom app (legacy)

This page describes how to connect Atlan with Microsoft Teams using the custom app (legacy) integration method. This integration lets you connect Atlan with Microsoft Teams to bring data governance and collaboration directly into your team’s workflow.

Important

The custom app (legacy) setup is no longer supported for new integrations. It continues to function for existing configurations, and no immediate action is required.

If your workspace uses the legacy integration and you want to switch to the new experience, first disconnect the existing custom app setup in Atlan. Then remove the legacy Atlan app from your Microsoft Teams Admin Center.

After removing the legacy app, configure the Microsoft Teams Marketplace App to complete the new setup.

Note that a few features of this legacy app are, due to Microsoft protocols, not supported in the new native Microsoft Marketplace app. See the limitations section in the Marketplace App.

Prerequisites​

Before you begin, make sure you have:

Integrate Microsoft Teams​

To integrate Microsoft Teams and Atlan using the custom app approach, follow these steps.

To retrieve the team link, from within Microsoft Teams:

  1. In the left menu in Microsoft Teams, click Teams.
  2. Under Teams, navigate to your team, and to the right of the team name, click the three dots.
  3. From the dropdown menu, click Get link to team.
  4. From the Get a link to the team dialog, click Copy to copy the team link and save it in a temporary location.

Connect Atlan to Microsoft Teams​

Once you have retrieved the team link, you can proceed to connecting Atlan to Microsoft Teams.

Atlan requires the following delegated permissions for the Microsoft Teams integration:

  • offline_access - lets the Atlan app access resources on behalf of the users, even when users aren't currently using the app.
  • User.Read - lets users sign in to the app, and lets the app read the profile of signed-in users.
  • AppCatalog.Submit - lets the app submit application packages to the catalog and cancel submissions that are pending review on behalf of the signed-in user.
  • ChannelMessage.Read.All - lets the app read a channel's messages in Microsoft Teams, on behalf of the signed-in user (only required if you have admin access to publish the app in Microsoft Teams).
  • AppCatalog.ReadWrite.All - lets the app create, read, update, and delete apps in the app catalogs (only required if you have admin access to publish the app in Microsoft Teams).
  • TeamsAppInstallation.ReadWriteSelfForUser - lets a Teams app to read, install, upgrade, and uninstall itself for the signed-in user.

From within Atlan:

  1. From the left menu on any screen, click Admin.
  2. Under Workspace, click Integrations.
  3. In the Microsoft Teams tile, click Connect.
  4. In the Add to Microsoft Teams dialog, for Team link, paste the team link you copied from Microsoft Teams.
  5. Click Next to continue.
  6. For Publish the Atlan app:
    • If you have Application Administrator access to Microsoft Teams:
      • Click Publish now to publish the Atlan app in your Microsoft Teams workspace.
      • In the Permissions requested popover, check the box for Consent on behalf of your organization to automatically grant access to the application for all users and then click Accept to publish the Atlan app.
    • If you don't have admin access to Microsoft Teams:
      • Click Request to publish.
      • In the Permissions requested popover, click Accept to publish the Atlan app.
      • Contact your Microsoft Teams administrator to approve and publish the Atlan app in your Microsoft Teams workspace.
Did you know?

If your global administrator has enabled the admin consent workflow, you're prompted to request admin approval while attempting to install the Atlan app in your Microsoft Teams workspace. Reach out to your admin to approve the admin consent request from the Microsoft Entra admin center. Additionally, if there's any expiry date set for such requests, make sure that the request is approved within that period of time, otherwise you need to request approval again.

Add Atlan to Microsoft Teams directory​

warning

You must wait 24 hours after setting up the Microsoft Teams integration in Atlan before adding the Atlan app to your Microsoft Teams directory. This is required for the Atlan app to be activated in Microsoft Teams. To learn more, refer to Microsoft Teams documentation.

Once the Atlan app has been published in your Microsoft Teams workspace, you need your Teams Administrator to add Atlan to your Microsoft Teams directory.

From within Microsoft Teams:

  1. Log in to the Microsoft Teams admin center with Teams Administrator access.
  2. In the left menu of Microsoft Teams, click Teams apps and then click Manage apps.
  3. On the Manage apps page, use the search bar to search for the Atlan app.
  4. To the left of the app name, click the circle to select the Atlan app.
  5. From the tabs along the top of the All apps section, click Add to a team.
  6. In the Add to a team form, configure the following:
    1. Click the search bar and enter the name of the team to which you want to add the Atlan app. Hover over the team name and then click Add.
    2. Click Apply to confirm your selections.

Atlan is now connected to Microsoft Teams! 🎉

Configure integration from Atlan to Microsoft Teams​

Now that Atlan is connected to Microsoft Teams, you can configure the Microsoft Teams integration from Atlan.

From the Integrations sub-menu:

  1. Expand the Microsoft Teams tile.
  2. Under the Configurations tab, configure the following:

    1. For any existing Microsoft Teams integrations prior to February 22, 2024 only, you need to update the Atlan app in your Microsoft Teams workspace to use new features like enabling notifications for starred assets:

      • If you have Application Administrator access to Microsoft Teams:
        • Click Install now to update the Atlan app in your Microsoft Teams workspace.
        • In the Permissions requested popover, click Accept to update the Atlan app.
      • If you don't have admin access to Microsoft Teams:
        • Click Request update.
        • Contact your Microsoft Teams administrator to update the Atlan app in your Microsoft Teams workspace.
        • Once updated, click Check status in Atlan to view the status of your requested update.
      info

      💪 Did you know? For all new Microsoft Teams integrations from February 22, 2024 onward, no additional configuration required.

    2. For Channels, enter channels to use in your Microsoft Teams workspace to let users post to from within Microsoft Teams or get notified about glossary updates. Enter the channel name without a #, and press tab after each channel if you want to enter multiple channels.

    3. (Optional) For Announcements channel, enter the name of a single channel that can be used to view announcements on assets in Atlan.

    4. (Optional) For Workflows alert channel, enter the name of a single channel that can be used to see alerts for workflow activities in Atlan. You can also choose to receive failure alerts only by toggling on the Receive failure alerts only slider.

    5. (Optional) For Playbooks alert channel, enter the name of a single channel that can be used to see alerts for playbook runs in Atlan. You can also choose to receive failure alerts only by toggling on the Receive failure alerts only slider.

  3. At the bottom of the tile, click the Update button.

Users can now post to Microsoft Teams without leaving Atlan! 🎉

To receive alerts for starred assets directly in your Microsoft Teams account, you need to link your Teams account to Atlan.
This linking lets Atlan send direct notifications to your Microsoft Teams chat. It's performed automatically for the user who set up the Microsoft Teams integration, but other users must link their accounts manually.

Availability

Linking your Microsoft Teams account is only supported for the custom app (legacy) setup.
If your organization is using the Microsoft Teams Marketplace App, this feature isn't available because the Marketplace app doesn't support personal scope in Teams.

To link your Microsoft Teams account:

  1. From any screen in Atlan, navigate to your name in the upper right corner, then click Profile.
  2. In the resulting dialog, click the four dots icon to access integrations.
  3. Under Teams, click the Connect link.
  4. In the resulting popup, scroll to the bottom and select Allow.

Your Microsoft Teams account is now linked and you'll receive starred asset alerts directly in Teams.

Did you know?

Channels need to be standard for Atlan to be able to post to them. If you try to integrate a private or shared channel, you see an error for that channel when you try to update.