Retrieve Group Members activity

An activity that gets information about the users who are members of an Active Directory group.



Configure the Retrieve Group Members activity

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

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • Based on the properties that you map, this activity gets information, such as display name, e-mail address, or phone number of the users who are members of an Active Directory group.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Active Directory Active Directory icon tab.
      2. On the Active Directory Active Directory icon tab, drag the Retrieve Group Members Retrieve Group Members icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a System Activity.

  2. Click Retrieve Group Members Retrieve Group Members icon
  3. Complete the fields on the Retrieve Group Members Configuration screen.

    For more information, refer to Get User Information from an Active Directory Group.

  4. (Optional) Click Advanced Advanced icon > E-mail Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the common information for a system activity.

Screen



Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Retrieve Group Members

Specifies the configuration to get the information about users from an Active Directory group.

Screen



Fields

Field Name Definition

Active Directory

Function:
Specifies the access token that connects to your Active Directory.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No

Add Token Add Token icon

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

Group Member Names

Function:
Specifies the name of the users in Active Directory group whose information to get.
Accepted Values:
A list of Active Directory user names in the group, separated by semi-colons (;).
Default Value:
None
Accepts Process Data Variables:
Yes

Group Name

Function:
Specifies the name of the Active Directory group.
Accepted Values:
A valid Active Directory group name.

When you select the access token from the Active Directory field, a list of group names shows in this field.

Default Value:
None
Accepts Process Data Variables:
Yes

Map Response to AgilePoint Schema

Function:
Specifies the connection of the Active Directory API response parameter, such as display name, e-mail address, or phone number to your schema.
To Open this Field:
  1. On the Retrieve Group Members screen, click the Response tab.
Accepted Values:
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.

Default Value:
None