...
...
...
...
| Note | ||
|---|---|---|
| ||
|
In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Use You can use this Snap to perform the following operations:
Create a new team.
...
Prerequisites
- Valid client ID.
- A valid account with the required permissions.
Create a new team from an existing group.
...
Snap Type
Teams - Send Channel Message Snap is a Write-type Snap that creates a new private/public team either from scratch or from the existing group.
Prerequisites
None.
Support for Ultra Pipelines
Capture if Ultra Mode is supported. If the Snap requires certain configurations to support Ultra mention those as well.
Works in
...
Limitations
...
None.
& Known Issues
None.
Snap
...
Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
Input |
Binary
Binary orDocument |
|
|
A document containing details of the team to create. |
Output |
Binary
Binary orDocument |
|
| A document containing details of the team created. | |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
| |||
Learn more about Error handling in Pipelines. |
Snap Settings
| Note | ||
|---|---|---|
| ||
| Info | ||
|
Field Name | Field Type | Field Dependency | Description | ||
|---|---|---|---|---|---|
Label*
Default Value: Create Team | String | N/A | Specify a unique name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. | ||
From Existing Group Default Value: Deselected | Checkbox | Deactivates the Team Name, Team Description, Private Team, and Add Team Owners fields. Activates the Group ID field. | Select to create a team from an existing group. | ||
Group ID Default Value: N/A | String/Expression/Suggestion | Activates when you select the From Existing Group check box. | Specify the ID of the group from which to copy the team. Alternatively, click the | ||
Team Name Default Value: N/A | String/Expression | Activates when you deselect the From Existing Group check box. | Specify the name for the new team. | ||
Team Description Default Value: N/A | String/Expression | Activates when you deselect the From Existing Group check box. | Specify a brief description about the new team. | ||
Private Team Default Value: Deselected | Checkbox | Activates when you deselect the From Existing Group check box. | Select this check box to create a private team. Members in the organization cannot locate private teams through search. Only the owners of the private teams can invite them to join. Whereas, any member in the organization can locate and join public teams. | ||
Add Team Owners | Fieldset | Activates when you deselect the From Existing Group check box. Use this field set to add owners for the team. | Use this fieldset to add one or more owners to the team. | ||
Owner ID Default Value: N/A | String/Expression/Suggestion | N/A | Specify the ID of the member. Alternatively, click the | ||
Number of Retries
Default Value: 0 | String/Expression | N/A | Specify the number of attempts the Snap makes to perform the selected operation in case of connection failure/unsuccessful attempts.
| ||
Retry Interval (seconds)
Default Value: 1 | String/Expression | N/A | Specify the time interval in seconds between retry attempts.
| ||
Snap Execution
Default Value: Execute only | Dropdown list | N/A | Select one of the three following modes in which the Snap executes:
|
...
|
...
|
...
Check boxes:
- If selected, <Snap behavior>.
If selected, an empty file is written when the incoming document has no data. - If selected, <behavior>. If not selected/Otherwise, <behavior>
Use "If not selected" if the first sentence is long.
If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.
- Select to <action>
Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
Select to execute the Pipeline during validation.
Text Fields
- Describe what the user must/must not do. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
The name of the account.
Enter the account ID that you want to use to log in to the endpoint.
Required if IAM Role is selected.
Do not use this field if you are using batch processing.
Numeric Text Fields
- Describe what the user must/must not do. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
Enter the number of records in a batch.
Enter the number of seconds for which you want the Snap to wait between retries.
Enter the number of seconds for which the Snap waits between retries.
Use the following special values:
* 0: Disables batching.
* 1: Includes all documents in a single request.
...
Field Sets
Specify advanced parameters that you want to include in the request.
This fieldset consists of the following fields:
- Field 1
- Field 2
- Field 3
Troubleshooting
...
Batch execution failed
...
The Pipeline ended before the batch could complete execution due to a connection error.
Verify that the Batch size field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.
Examples
Excluding Fields from the Input Data Stream
We can exclude the unrequired fields from the input data stream by omitting them in the Input schema field set. This example demonstrates how we can use the <Snap Name> to achieve this result:
<screenshot of Pipeline/Snap and description>
Download this Pipeline.
Downloads
...
|
Troubleshooting
Error | Reason | Resolution |
|---|---|---|
Team Name field is blank | You have not specified a team name. | Verify whether you have specified a team name in the Team Name field. The Team Name field is required when creating a new team. |
You do not have permission to create a team. | Only administrators or users with specific roles are allowed to create teams. | Team ID needs to be a valid GUID. |
Create Team - | The Snap request failed with 500. This indicates a server-side issue or an unexpected problem with the service. | Ensure the Snap configuration is correct, and enter valid values in your account settings. |
Examples
Initiating activity in Microsoft Teams
The following example Pipeline demonstrates how you can use the Create Team Snap and some other Snaps in the Teams Snap Pack to begin team's activity within your Microsoft Teams instance. This example assumes that you have:
Set up your application in Azure Portal with necessary permissions.
Configured the required Snap account with necessary scopes.
Created a public or private channel using the Create Channel Snap.
...
This Pipeline uses the OAuth2 user account (authorization code grant type) to create a team on behalf of a signed-in user and to allow begin their collaboration efforts. It demonstrates the following activities:
Creating a team
Adding members to the new team
Creating a public channel within the team
Collaboration through the channel
Creating a team
Use the Create Team Snap from the Teams Snap Pack to create the new team, as needed. For this Pipeline demonstration, the inputs for creating a team are passed using a Mapper Snap.
Mapper Snap | Output |
|---|---|
 |  |
The values for Team and Team_Desc are passed to the Create Team Snap. The Snap creates a new team in your Teams instance and returns the team's id and a confirmation message about the operation.
Create Team Snap | Output |
|---|---|
 |  |
Adding members to a team
To add members to the team, connect a Team Operations Snap. Select Add Members as the Operation and provide the user IDs of the members and owners for the team, as needed.
Team Operations Snap to add members to a team | Output |
|---|---|
 |  |
Creating a channel in the team
Now, let us create a channel within this new team (using Create Channel Snap) and add members to this channel, as necessary.
Create Channel Snap | Output |
|---|---|
 |  |
This Snap creates a new channel under the team and returns the channel details in its output.
Sending a message to a channel
Let us use these details to send our first message in the channel. To do so, we must connect a Send Channel Message Snap and pass the Team ID and Channel ID from the above output as inputs. The Send Channel Message Snap allows you to draft messages to the channel members using HTML markup. See the input for the Message field in the Snap.
Send Channel Message Snap | Output |
|---|---|
 |  |
Replying to a specific message
Similarly, you can use the Send Channel Message Snap to reply to a specific message in the channel (conversation) using its message ID. For demo purposes, the Snap below uses the id of the message sent above to reply to it.
Send Channel Message as a reply | Output |
|---|---|
 |  |
Downloads
| Info |
|---|
Important Steps to Successfully Reuse Pipelines
|
| Attachments | ||
|---|---|---|
|
...
Snap Pack History
...
| Expand | |
|---|---|
|
...
|
...
|
...
|
See Also
...