Microsoft Teams Chat activity¶

Introduction¶

A Microsoft Teams Chat activity, using its Microsoft Teams connection, retrieves an existing chat or creates a new chat at Microsoft Teams and is intended to be used as a target to consume data in an operation.

Create a Microsoft Teams Chat activity¶

An instance of a Microsoft Teams Chat activity is created from a Microsoft Teams connection using its Chat 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 Chat activity can be edited from these locations:

• The design canvas (see Component actions menu in Design canvas).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure a Microsoft Teams Chat activity¶

Follow these steps to configure a Microsoft Teams Chat activity:

• Step 1: Enter a name and specify settings
  Provide a name for the activity and specify either to select an existing chat or to create a new chat.

• Step 2: Review the data schemas
  Any request or response schemas generated from the endpoint are displayed.

Step 1: Enter a name and specify settings¶

In this step, provide a name for the activity and specify either to select an existing chat or to create a new chat. Each user interface element of this step is described below.

The interface used in this step of the configuration of a Microsoft Teams Chat activity depends on the Chat Selection and Create New Chat options selected:

• Select existent chat: This option will populate a list of existing chats to choose from.

• Enter chat ID manually: Select this option to manually enter the ID of a specific chat.

• Create new chat: Select this option to create a new chat instead of selecting an existing one.

Select existent chat¶

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

• Chat Selection: Choose one of the two ways to identify the chat you are looking for, either Select Existent Chat or Enter Chat ID Manually. If you want to create a new chat, scroll down past the list of existent chats and click Create New Chat.

• Select a Chat: This section displays chats available in the Microsoft Teams endpoint.

  • Selected Chat: After a chat is selected, its type and identifier are listed here.

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

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

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

    • Chat Type: The type of the chat (such as Group or One-on-One) and the chat identifier.

    • Description: The description of the chat, consisting of the chat topic and a list of chat members.

  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.

• Create New Chat: By default, this is unselected and the activity allows for the selection of an existing chat.

• 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.

Enter chat ID manually¶

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

• Chat Selection: Choose one of the two ways to identify the chat you are looking for, either Select Existent Chat or Enter Chat ID Manually. If you want to create a new chat, scroll down past the next field and click Create New Chat.

• Chat ID: Enter the chat identifier.

  Tip

  Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

• Create New Chat: By default, this is unselected and the activity allows for the selection of an existing chat.

• 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.

Create a new chat¶

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

• Create New Chat: By default, this is unselected and the activity allows for the selection of an existing chat. Select this to create a new chat. If selected, these options that follow will become available.

• Chat Type: Select between One-on-One and Group as the type of chat to be created.

  • Topic: If a Group chat was selected, a topic can be entered for the chat.

• Provide Email and Role: Provide emails for members of the chat, either as a comma-separated list or as a table:

  • If using Provide Comma-separated Emails Using Text Field:

    • Email: Enter a comma-separated list of email addresses of members to be included in the channel.
    • Owner Role: If selected, all members added to the channel will be given the owner role. It is selected by default. If different roles for different members are required, use the table method of entry.

    

  • If using Provide Emails Using Table, use the controls to add and remove entries from the table.

    • User's Email: Enter an email address of a member to be included in the channel.
    • User's Role: Enter a role for the member. By default, all members added to the channel will be given the owner role.

    

    Tip

    Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

    Important

    Fields in the Emails table display the variable icon only in edit mode. For these fields' variable values to be populated at runtime, the agent version must be at least 10.75 / 11.13.

• 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: 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. The request and response data schemas shown depends on if you specified to select an existing chat or to Create New Chat in step 1.

If you specified to select an existing chat, these data schemas are shown:

If you specified to create a new chat, these data schemas are shown:

• 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 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 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 Chat 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 Chat activities can be used as a target with these operation patterns:

• Transformation pattern
• Two-transformation pattern (as the first or second target)

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.