Microsoft Teams In
The Microsoft Teams In node actively monitors incoming messages and attachments from the connected Microsoft Teams account. Messages can be dynamically filtered by a variety of methods to ensure that Dispatcher Phoenix is collecting the content that needs to be processed within the workflow.
Adding Your Microsoft Teams Account
To utilize the Microsoft Teams In node, the user must first add the Microsoft Teams account to Dispatcher Phoenix Web. For more information, see the Dispatcher Phoenix Web Accounts page.
Configuring the Microsoft Teams In Node
-
Enabled - To enable this node in the current workflow, check the box at this field. When unchecked, this input will be ignored. While the workflow will still validate if there is at least one enabled collection node, documents will not be collected by this node if the Enabled box is unchecked.
-
Node Name - The node name defaults to this field. This name appears in the workflow below the node icon. Use this field to specify a meaningful name for the node that indicates its use in the workflow.
-
Node Description - Enter an optional description for this node. A description can help you remember the purpose of the node in the workflow or distinguish nodes from each other. If the description is long, you can hover the mouse over the field to read its entire contents.
Buttons
- Help - To access Dispatcher Phoenix Online Help, click this button.
- Cancel - To exit the window without saving any changes, click this button.
- Save - To preserve your node configuration and exit the window, click this button.
Connection Setup
In the Connection area:
- Account - Click the drop-down to see a list of authorized Microsoft Teams accounts. If no accounts appear, be sure the logon user accounts for Dispatcher Phoenix Web and Microsoft Teams must match.
- Connection timeout (in seconds) - Specify the number of seconds you want to elapse before a network connection times out (i.e., for login or logout operations).
- Refresh Data - Selecting this button will send a new request to Microsoft Teams to retrieve any updated teams and channels of the currently selected account.
Connecting to Microsoft Teams
To connect to Microsoft Teams, do the following:
- In the Connection area, select a Teams account from the dropdown.
Note: If you have not already set up a Teams account through Dispatcher Phoenix Web, you must do this before it will appear in the dropdown.
To modify the default Connection Timeout (the seconds allotted for the time without communication, after initial connection to the server, before a timeout occurs), enter a value in the Connection Timeout field.
Node Configuration
To begin sending messages, do the following:
- In the Teams area, select one of the available teams. This will show the available channels within that team.
- Select one of the available channels.
Filters
To add one or more limits to the node, do the following:
-
In the Filters area, use the + button in the upper right corner to add a rule. You can add multiple filters this way. Each new filter is added at the end of the list. Each filter also has a + button; selecting this button inserts a new filter directly under the selected filter.
-
Select the Field and Condition. If necessary, enter a Filter Value.
Filter Logic
Messages collected into a Dispatcher Phoenix workflow with the Microsoft Teams In node can be filtered by the following fields:
Field | Description |
---|---|
Sender Name | The user account that sent the message. |
Sender Email | The email address of the user who sent the message. |
Subject | The subject line of the message. |
Message | The content included in the message. |
Attachment Name | The name of each individual message attachment. |
Attachment Size | The size of each individual message attachment. |
Total Attachment Size | The size of the message attachments added together. |
Date | The time period in which the message was received. |
For fields with customizable content, a variable Condition and Filter Value can be specified. Options for Conditions may include:
- Contains
- Doesn’t Contain
- Is
- Starts With
- Ends With
- Regular Expression
For fields that expect numbers, options for Conditions may include:
- Less than
- Greater than
- Equal to
In addition, you can configure the data unit. Options include:
- Bytes
- KB (Kilobytes)
- MB (Megabytes)
The Date field will search all Teams messages in the selected date range and all messages received in that Team going forward. Options include:
- Within 1 day
- Within 3 days
- Within 1 week
- Within 2 weeks
- Within 1 month
- Within 2 months
- Within 6 months
- Within 1 year
Important! If you do not configure a Date filter, the workflow will only collect messages from the moment the workflow is started, not any past messages. If you would like to collect past messages, you must include a Date filter.
Using Multiple Filters
After adding more than one filter to the node, you can define filter logic. For example, your node may include the following two filter conditions:
1. Subject contains: "Form"
2. Message starts with: "Project X"
By default, the AND filter logic will be applied to these two filters. This means that any messages that have a subject that contains the word “Form” and that have a message starting with “Project X” will be automatically pulled into the workflow.
Note: Filter values are not case sensitive.
In some cases, you may need to find messages by one criteria OR another. In this case, you would change the filter logic selection to OR.
Consecutive AND filters create a group of conditions while an OR separates filters from one another. For example:
(Filter 1 AND Filter 2) OR (Filter 3) OR (Filter 4 and Filter 5)
Important!
- It is a best practice to organize Teams and Channels with unique names to avoid confusion when using Microsoft Teams and the Microsoft Teams In node; attempting to receive messages and documents to Teams or Channels with identical names can produce unexpected outcomes.
- The Teams In node may experience errors with Team or Channel names longer than 240 characters.
Metadata
The following metadata is created in the Microsoft Teams In node:
Metadata Value | Description |
---|---|
{Teams:channelid} | The ID value of the channel. |
{Teams:channelname} | The name of the channel. |
{Teams:datetime} | The date and time the message was received. |
{Teams:emailaddress} | The email address associated with the sender. |
{Teams:emailname} | The name associated with the sender. |
{Teams:filename} | The name of the attachment. |
{Teams:message} | The contents of the message. |
{Teams:subject} | The subject line of the message. |
{Teams:teamid} | The ID value of the team. |
{Teams:teamname} | The name of the team. |