Get Group Chat Members activity

An activity that retrieves one or more users who are members of a group chat from Microsoft Teams.


Get Group Chat Members activity

Configure the Get Group Chat Members activity

To configure the Get Group Chat Members activity, do the procedure in this topic.

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Microsoft Teams tab.

    Open Microsoft Teams tab
  3. On the Microsoft Teams tab, drag the Get Group Chat Members activity onto your process.

    Drag Get Group Chat Members activity

General Configuration

Specifies the basic settings for the Get Group Chat Members activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Get Group Chat Members Configuration

Specifies the configuration to retrieve one or more users who are members of a Microsoft Teams group chat.

Figure: Get Group Chat Members Configuration screen

Get Group Chat Members Configuration screen

Fields

Field NameDefinition

Microsoft Teams

Description:
Specifies the access token that connects to your Microsoft Teams service.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for Microsoft Teams
Function of this Screen:
Configure an access token to connect to Microsoft Teams.

Group Chat ID

Description:
Specifies the ID of the group chat from which to retrieve the users.

The group chat ID comes from Microsoft Teams.

Allowed Values:
A group chat ID from Microsoft Teams.
Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Map Response To App Schema / Store Response In This Variable

Description:
Specifies where to store the response from Microsoft Teams.
Allowed Values:
  • Map Response To App SchemaSelect this option if you want to map the information from the Microsoft Teams data model to your process schema.

    Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

    Use this screen to connect the response to the data model for your process.

  • Store Response In This VariableSelect this option if you want to store the information from Microsoft Teams to a variable in the AgilePoint NX app.

    In the text field, specify a variable that accepts an alphanumeric string in JSON format.

Default Value:
Map Response To App Schema
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?