Retrieve Role Members Name activity

An activity that get the names of the members from a role in AgilePoint NX.



Configure the Retrieve Role Members Name activity

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

Good to Know

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 AgilePoint NX AgilePoint NX icon tab.
      2. On the AgilePoint NX AgilePoint NX icon tab, drag the Retrieve Role Members Name Retrieve Role Members Name 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 Role Members Name Retrieve Role Members Name icon.
  3. Complete the fields on the Retrieve Role Members Name Configuration screen.

    For more information, refer to Get the Names of the Member from a Role in AgilePoint NX.

  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 Role Members Name Configuration

Specifies the configuration to get the names of the members from a role in AgilePoint NX.

Screen



Fields

Field Name Definition

AgilePoint

Function:
Specifies the access token that connects to your AgilePoint NX.
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 AgilePoint NX
Function of this Screen:
Configure an access token to connect to AgilePoint NX.

Role Name

Function:
Specifies the name of a role.
Accepted Values:
  • A role name from the list.
  • A process data variable.

    You can use Process Data screen to specify a process data variable.

Default Value:
None

Store Role Members Name

Function:
Specifies the process data variable that stores the names of the members in role.
Accepted Values:
A process data variable with a text string that contains member names, separated by commas (,).
Default Value:
None
Accepts Process Data Variables:
Yes