Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

Use You can use this Snap to perform the following operations:

  • Create a new team.

  • 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

Works in Ultra Pipelines

Limitations

...

None.

& Known Issues

None.

Snap

...

Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

A document containing details of the team to create.

Output

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • JSON Formatter + File Writer

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:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

...

Info
  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star)): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ((blue star)): Indicates that you can add fields in the field set.

  • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

Group ID

Field Name

Field Type

Field Dependency

Description

Label*

 

Default ValueCreate Team
Example: Create Marketing 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.

Not selectedSelected

Select to create a team from an existing group.

Group ID

Default Value: N/A
Example: All Company : 12a345c6-78c9-0b1c-b2f3-ab45e678d980

String/Expression/Suggestion

Activates when you select the From Existing Group check box.

Enter the

Specify the ID of the group from which to copy the team. Alternatively, click the Image Modified icon to fetch a list of group IDs associated with the account. 

NTeam Name

Team Name

Default Value: N/A

All Company : 12a345c6-78c9-0b1c-b2f3-ab45e678d980

Example: Marketing Team

String/Expression

Activates when you deselect the From Existing Group check box.

Enter the

Specify the name for the new team.

NTeam Description

Team Description

Default Value: N/A

Marketing Team

Example: Marketing team for the ABC Projects

String/Expression

Activates when you deselect the From Existing Group check box.

Enter a

Specify a brief description about the new team.

N/A

Marketing team for the ABC Project

Private Team

Check box

Default Value: Deselected

Checkbox

Activates when you deselect the From Existing Group check box.

Select this check box to create a private team.

InfotitleNote

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.

Not selectedSelected

Add Team Owners

Fieldset

Activates when you deselect the From Existing Group check box.

Use this field set to add owners for the team.

This field set consists of the Owner ID field

Use this fieldset to add one or more owners to the team.

Owner ID

Default Value: N/A
Example: e12b3456-7c89-012b-345f-67c89dca0bcd

String/Expression/Suggestion

Enter the

N/A

Specify the ID of the member. Alternatively, click the Image Modified icon to fetch a list of member IDs within the organization.

 You

 You can use each row to specify an owner or include all the owners in the same row separated by a comma.

N/Ae12b3456-7c89-012b-345f-67c89dca0bcd

Number of Retries

 

Default Value0
Example3

String/Expression

Enter the

N/A

Specify the number of attempts the Snap makes to perform the selected operation in case of connection failure/unsuccessful attempts. 

Info
title

To avoid 502 Bad Gateway error

Use a higher value (such as 3, 4, or more) in this field to ensure the Snap/Pipeline runs successfully. 

03

Retry Interval (seconds)

 

Default Value1
Example6

String/Expression

Enter the

N/A

Specify the time interval in seconds between retry attempts.

Info
titleSnap ExecutionDrop-down listSpecifies the execution type

To avoid 502 Bad Gateway error

Use a higher value (such as 3, 4, or more) in this field to ensure the Snap/Pipeline runs successfully. 

16

Snap Execution

 

Default ValueExecute only
ExampleValidate & Execute

Dropdown list

N/A

Select one of the three following modes in which the Snap executes:

  • Validate & Execute

: Performs
  • . Performs limited execution of the Snap

(up to 50 records)
  • and generates a data preview during Pipeline validation

;
  • , then performs full execution of the Snap (unlimited records) during Pipeline

execution
  • runtime.

  • Execute only

: Performs
  • . Performs full execution of the Snap during Pipeline

execution; does not execute the Snap during Pipeline validation
  • execution without generating preview data.

  • Disabled

: Disables
  • . Disables the Snap and

, by extension, its downstream Snaps.Execute onlyValidate & Execute
  • all Snaps downstream from it.

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 -
API returned error in Create Team operation.

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:

...

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. In For this Pipeline demonstration, the inputs for creating a team are passed using a Mapper Snap. 

Mapper Snap

Image Removed

Output

Output
Image Added
Image Removed
Image Added

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

Image Removed
Image Added
Image Removed
Image Added

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

Image Removed
Image Added
Image Removed
Image Added

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

Image Removed
Image Added

Image Removed
Image Added

This Snap creates a new channel under the team and returns the channel details in its output.

...

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

Image Removed

Output

Output
Image Added

Image Removed
Image Added

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

Image Removed

Output

Output
Image Added

Image Removed
Image Added

Download this Pipeline.

Downloads

Noteinfo
title

Important Steps to Successfully Reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts as applicable.

  3. Provide Pipeline parameters as applicable.

Attachments
patterns*.slp, *.zip

...

Snap Pack History

Expand

Multiexcerpt-include-macro
nameTeams

...

_SPH
templateData[]
pageTeams Snap Pack

...

addpanel

...

false

...

Related Content