Retrieve Role Members Name activity

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


Retrieve Role Members Name activity

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. 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 AgilePoint NX tab.

    AgilePoint NX tab
  3. On the AgilePoint NX tab, drag the Retrieve Role Members Name activity onto your process.

    Drag Retrieve Role Members Name activity

General Configuration

Specifies the basic settings for the Retrieve Role Members Name 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

Retrieve Role Members Name Configuration

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

Figure: Retrieve Role Members Name Configuration screen

Retrieve Role Members Name Configuration screen

Fields

Field NameDefinition

AgilePoint NX

Description:
Specifies the access token that connects to your AgilePoint NX environment.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create 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

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

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

Default Value:
None

Store Role Members Name

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