Skip to Content

Microsoft Teams Add Channels Activity

Introduction

A Microsoft Teams Add Channels activity, using its Microsoft Teams connection, creates channels (with the option of adding members) in a team at Microsoft Teams and is intended to be used as a target to consume data in an operation.

Create a Microsoft Teams Add Channels Activity

An instance of a Microsoft Teams Add Channels activity is created from a Microsoft Teams connection using its Add Channels activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing Microsoft Teams Add Channels activity can be edited from these locations:

Configure a Microsoft Teams Add Channels Activity

Follow these steps to configure a Microsoft Teams Add Channels activity:

Step 1: Enter a Name and Select a Team

In this step, provide a name for the activity and select a team. Each user interface element of this step is described below.

Microsoft Teams Add Channels Activity Configuration Step 1

  • Name: Enter a name to identify the activity. The name must be unique for each Microsoft Teams Add Channels activity and must not contain forward slashes / or colons :.

  • Select a Team: This section displays teams available in the Microsoft Teams endpoint.

    • Selected Team: After a team is selected, it is listed here.

    • Search: Enter any part of the team name into the search box to filter the list of teams. The search is not case-sensitive. If teams are already displayed within the table, the table results are filtered in real time with each keystroke. To reload teams from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload teams from the Microsoft Teams endpoint. This may be useful if teams have been added to Microsoft Teams. This action refreshes all metadata used to build the table of teams displayed in the configuration.

    • Selecting a Team: Within the table, click anywhere on a row to select a team. Only one team can be selected. The information available for each team is fetched from the Microsoft Teams endpoint:

      • Name: The name of the team.

      • Description: The description of the team. If a team does not have a description or has a description consisting of whitespace, the connector will use the team name as the team description. This will not affect the schema, execution, or response returned.

    Tip

    If the table does not populate with available teams, the Microsoft Teams connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log. It is selected by default.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Specify Settings

In this step, specify if members are to added to the channel. This is supported only in private channels. Each user interface element of this step is described below.

Microsoft Teams Add Channels Activity Configuration Step 2

  • Add Members to Channel (Supported in Private Channels Only): Specify whether to add members to the channel (supported only in private channels) by selecting one of Private Channel or Public Channel.

    • Private Channel: If using Private Channel, these options are available:

      • Email: Enter a comma-separated list of email addresses of members to be included in the new channel.
      • Owner Role: If selected, the members added to the channel will be given the owner role. It is selected by default.

    • Public Channel: If using Public Channel, no options are available.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Review the Data Schemas

Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.

Microsoft Teams Add Channels Activity Configuration Step 3

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    Note

    Data supplied in a transformation takes precedence over the activity configuration.

    The Microsoft Teams connector uses the Microsoft Graph REST API v1.0. Refer to the API documentation for information on the schema nodes and fields.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Microsoft Teams endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Edit: Click the edit icon Edit icon above each data schema to enter the editor for that data schema. The editor allows you to add, delete, and reorganize nodes and fields and change their data types. All newly added nodes and fields are set to [0, 1] cardinality. Changes made to the data schemas must be acceptable to the endpoint and should be made only after consulting any available documentation for the endpoint.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring a Microsoft Teams Add Channels activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Microsoft Teams Add Channels activities can be used as a target with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.