Disclaimer

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/

Overview

Microsoft Teams is a collaboration app that helps teams stay organized and have conversations. This Universal Extension provides the capability to monitor a Microsoft Teams channel for uploaded files and run job(s) and/or workflows accordingly.

Refer to the Changelog for version history information.

Software Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task. Requires Python version 3.7 or 3.11  

Software Requirements for Universal Agent

Both Windows and Linux agents are supported:

• Universal Agent for Windows x64 Version 7.0.0.0 and later with Python options installed.

• Universal Agent for Linux Version 7.0.0.0 and later with Python options installed.

Software Requirements for Universal Controller

Universal Controller Version 7.0.0.0 and later.

This Universal Task requires that Universal Controller property Web Service Default Response Content (uc.web_service.response.content.default) is set to JSON.

Network and Connectivity Requirements

• Universal Agent needs to have network connectivity towards the following Microsoft Domains to allow necessary APIs to be called

  • graph.microsoft.com

  • sharepoint.com

  • microsoftonline.com

Azure Active Directory Requirements

An application must be registered in the Azure Active Directory. See official instructions on Quickstart: Register an application with the Microsoft identity platform

1. Use as "Supported Account Types" option "Accounts in this organizational directory only".

2. When registration finishes an Application (client) ID is generated (required as part of Extension Task configuration).

3. Configure API permissions.

• Assign the following Microsoft Graph API permissions.

  API / Permissions name	Type	Description
  ChannelMessage.Read.All	Delegated	Read user channel messages
  User.Read	Delegated	Sign in and read user profile

• Grant admin consent.

4. Create a client secret -> Add client secret (client secret is required as part of Extension Task configuration)

Key Features

This Universal Extension provides the following main features:

• Support authentication to Microsoft Teams with Oauth2 protocol for Grant Type Resource Owner Password Credentials (aka "Password Credentials").

• For a specific Microsoft Teams Channel, periodically poll all the new messages since the last lookup.

• For each fetched message having attachments, launch a task in Universal Controller with variables holding the list of attachments' SharePoint URLs, names, and a message summary.

• Support for up to 5 attached files (any additional files are skipped).

• Ability to resume from the last read message on restart.

• Different Log levels for the Universal task, with DEBUG level providing more information in case of issues.

• Universal task instance must be stopped with Force Finish/Cancel command to avoid leaving a running monitor process.

The scope is to support the exchange of files on a dedicated Microsoft Teams channel that will act as a service channel.

To share a file, a conversation is created with the file being attached. It is not expected that anyone will react or reply to this message.

Known Issues

This extension is subject to the limitations of MS Graph API.

For more technical details, please refer to Microsoft Graph REST API v1.0 chatMessage: delta

• Actions and replies on the channel conversations are not supported.

• Only returns channel conversations within the last eight months.

• Incremental reading of new messages relies on a delta token from the API. Its opaque value must be kept in a variable to allow for it to resume between runs. See how to configure the task in the example section below.

Import the Universal Template

To use this downloadable Universal Template, you first must perform the following steps:

1. This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.
2. To import the Universal Template into your Controller, follow the instructions here.
3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

Configure Universal Task

For the new Universal Task type, create a new task, and enter the task-specific details that were created in the Universal Template.

Input Fields

The input fields for this Universal Extension are described below.

Launch Task Variables

The Variables that are passed to the launched task are described below.

Example: attachment_urls

{
  "contentUrls": [ "https://uacextensions.sharepoint.com/sites/my_site/Shared%20Documents/General/my_file.txt" ]
}

Example: attachment_names

{
  "names": [ "my_file.txt" ]
}

Example: message_summary

{
  "lastModifiedDateTime": "2021-09-21T16:09:29.236Z",
  "id": "1632240161921",
  "from": {
    "user": {
      "displayName": "John Doe"
     }
  }
}

Task Output

Output Fields

The output parameters are set after every message processing. If they are 'preserved on re-run', they prevent a re-run of the task instance from restarting from scratch.

The output fields for this Universal Extension are described below.

Exit Codes

The exit codes for this Universal Extension are described below.

Task Examples

Follow the steps below to create a Task.

1. Give the Task a name.

2. Select an active agent of version 7.0.0.0 or higher for the task to run on.

3. Select the action.

4. Set your Client Credentials.

5. Set your Resource Owner Credentials.

6. Set your Universal Controller Credentials.

7. Select the Channel Identifier.

8. Enter the required Channel Link. An easy way to retrieve this is from the Microsoft Teams UI:
   
   
   
   
   

9. Enter the Launch Task name.

10. Enter the Universal Controller URL.

11. Enter the Offset Token from the previous instance execution.

12. Enter the required Interval in seconds.
    
    
    
    
    

Example with the Usage of Offset Token in an Instance Re-run

Create a global variable from inside a Task.

Set the value of the global variable to be set, when the instance finishes, with the value of the task instance variable as below. ('ops_msteams_monitor_offset_token' is the task instance variable name for the tracker for the last read message from the channel.)

${ops_msteams_monitor_offset_token}

2. In the Task, set the global variable value in the Offset Token field.

The offset is kept between the task executions and allows to resume from the last read message on that channel.

Document References

This document references the following documents:

Changelog

ue-msteams-monitor-1.0.3 (2024-03-07)

Enhancements

• Added: Support for Python 3.11.

ue-msteams-monitor-1.0.2 (2022-03-30)

Enhancements

• Added: Update of Extension Icon

ue-msteams-monitor-1.0.1 (2021-12-13)

Enhancements

• Added: Skip a given number of MSTeams messages on task startup
• Added: Skip message when type is unknownFuture (channel system events

Fixes

• Fixed: STDOUT is not always printed on with UAG 7.0
• Fixed: Returned correct message for HTTP errors from UAC API.
• Fixed: Fixed the returned number of attachments when the message has more than 5 attachments.
• Fixed: Returned correct error for invalid REST UAC Credentials

ue-msteams-monitor-1.0.0 (2021-10-14)

Initial Release