Microsoft Teams

Microsoft Teams is a business communication platform that's part of the Microsoft 365 suite of products. Like other business communication platforms, MS Teams offers users chat functionality, group conversations, and video calling.

Authenticate with MS Teams

Tonkean integrates with MS Teams in two different ways, both of which must be connected independently: as a communication source or as a data source.

If you want to connect MS Teams to send messages and generally communicate with your process contributors, connect MS Teams as a communication source. Alternatively, if you want to extract and leverage fields from MS Teams in your module workflow, connect MS Teams as a data source.

Add MS Teams as a Communication Source

You can connect MS Teams as a communication source, a channel by which Tonkean can reach out to and communicate with process contributors (for example, using People Coordination actions).

To add MS Teams as a communication source, follow the steps below:

  1. Make sure you're logged into MS Teams or your Microsoft account that you want to connect to Tonkean.

  2. In Tonkean, select the main nav icon, grid.png, in the upper left and select Enterprise Components. The Enterprise Components screen displays.

  3. Select the Communication Sources tab. The Communication Sources screen displays.

    select_comm_sources_tab.png
  4. In the Microsoft Teams section, select New Instance. A new window displays asking you to authenticate with Microsoft Teams.

    comm_sources_new_teams_instance.png
  5. Select Authenticate with MS Teams. A window opens where, depending on whether you're currently logged in to your Microsoft account, you are asked to log in, then asked to give permissions to Tonkean to access your Microsoft account.

    Make sure you're signed in to allow authentication.

    auth_with_ms_teams_comms_source.png
  6. Once you're logged in to your Microsoft account, select Accept to allow Tonkean to access your Microsoft account. The permissions window closes and returns to the Set Up Communication Source window.

    accept_permissions_request.png

    If your Microsoft account is already connected and authenticated in Tonkean, you are automatically authenticated and are not required to accept the permissions request again.

  7. Once authentication is complete, the Set Up Communication Source window displays. Select the team you want to connect to Tonkean. Instructions display for completing connection setup in MS Teams.

    If you've already connected the Tonkean application for MS Teams to your Microsoft Online account, you are not required to complete the setup process again.

    select_team_to_connect_comm_source.png
  8. Follow the instructions provided in the window:

    1. Navigate to the Tonkean application for MS Teams in the Microsoft App Store.

    2. Select Get it now and follow the prompts to install the Tonkean application in MS Teams. Once installation is complete, you are redirected to MS Teams with the Tonkean application window open. If you're not redirected, open the application from the App Store in MS Teams.

      ms_teams_download_tonkean_app.png
    3. In the Tonkean application window, select the Add dropdown arrow, then select Add to a team. The Add Tonkean to a team window displays.

      ms_teams_add_to_a_team.png
    4. Enter the name of the team you want to add Tonkean to in the field provided. The selected team name displays as a chip.

      ms_teams_enter_team_name.png
    5. Select Set up a bot. The application installs and a message from Tonkean displays.

      ms_teams_set_up_a_bot.png
    6. Return to Tonkean.

Your MS Teams instance is connected to Tonkean as a communication source.

comm_source_complete.png

Add MS Teams as a Data Source

You can connect MS Teams as a native data source. With this integration, you can access the various fields in a Message and leverage those fields in your module workflow.

  1. Select the main nav icon, grid.png, in the upper left and select Enterprise Components. The Enterprise Components screen displays.

  2. Select + Add Data Source in the upper right.

    connect_data_sources_add_data_source.png
  3. Select + Add Data Source in the upper right.

    add_cloud_application.png
  4. Enter "Teams" in the search field, then select MS Teams. The New MS Teams Connection window displays.

    select_ms_teams_data_source.png
  5. Select Create a new connection. The Set Up Data Source window displays.

    create_new_connection.png
  6. Select Authenticate with MS Teams. A window opens where, depending on whether you're currently logged in to your Microsoft account, you are asked to log in, then asked to give permissions to Tonkean to access your Microsoft account.

    auth_with_ms_teams.png

    Tonkean only collects the Messages entity.

  7. Once you're logged in to your Microsoft account, select Accept to allow Tonkean to access your Microsoft account. The permissions window closes and returns to the Set Up Data Source window.

    accept_permissions_request.png

    If your Microsoft account is already connected and authenticated in Tonkean, you are automatically authenticated and are not required to accept the permissions request again.

  8. Select the team you want to connect to Tonkean. Instructions display for completing connection setup in MS Teams.

    If you've already connected the Tonkean application for MS Teams to your Microsoft Online account, you are not required to complete the setup process again.

    select_team_to_connect.png
  9. Follow the instructions provided in the window:

    1. Navigate to the Tonkean application for MS Teams in the Microsoft App Store.

    2. Select Get it now and follow the prompts to install the Tonkean application in MS Teams. Once installation is complete, you are redirected to MS Teams with the Tonkean application window open. If you're not redirected, open the application from the App Store in MS Teams.

      ms_teams_download_tonkean_app.png
    3. In the Tonkean application window, select the Add dropdown arrow, then select Add to a team. The Add Tonkean to a team window displays.

      ms_teams_add_to_a_team.png
    4. Enter the name of the team you want to add Tonkean to in the field provided. The selected team name displays as a chip.

      ms_teams_enter_team_name.png
    5. Select Set up a bot. The application installs and a message from Tonkean displays.

      ms_teams_set_up_a_bot.png
    6. Return to Tonkean.

  10. In Tonkean, select I've completed the setup in Microsoft Teams.

    complete_setup_in_tonk.png

Your MS Teams instance is connected to Tonkean. Be sure to provide the relevant solutions access to this data source.

Monitor MS Teams as a Module Input Source

Like most data sources, you can use MS Teams as the module input source:

  1. After creating a new module, select the input source tile. The Configure Input Source panel displays.

  2. Select Microsoft Teams App from the available data sources.

    config_input_source_select_teams.png
  3. Select whether to monitor all Messages or to create a custom filter to monitor specific messages. If you select to create a custom filter, configure the conditions for the filter.

    configure_input_source_custom_filter.png

    When setting up a new input source, we recommend always adding a custom filter instead of monitoring all entities of the selected type. This ensures there's a smaller amount of data to monitor and respond to. For example, configuring the filter to monitor messages sent to the "Tonkean" user is a good place to start.

  4. When finished, select Preview Items & Save.