Get Scoped Variables activity

An activity that retrieves the value from one or more scoped variables configured in the Set Scoped Variables activity.


Get Scoped Variables activity

Configure the Get Scoped Variables activity

Examples

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 Common tab.

    Open Common tab
  3. On the Common tab, drag the Get Scoped Variables activity onto your process.

    Drag Get Scoped Variables activity

General Configuration

Specifies the basic settings for the Get Scoped Variables activity.

Figure: General Configuration screen

General Configuration screen

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 Scoped Variables

Retrieves the value from a scoped variable and stores the value in a variable in the AgilePoint NX app.

Figure: Get Scoped Variables screen

Get Scoped Variables screen

Fields

Field NameDefinition

Get Scoped Variables Set In This Activity

Description:
Specifies a Set Scoped Variables activity from which to retrieve the value for a scoped variable.
Allowed Values:
  • An activity from the list.

    This field shows the internal names for the Set Scoped Variables activities in the process.

Default Value:
None
Accepts Variables:
Yes

Variable

Description:
Specifies a scoped variable whose information to retrieve.

You must specify the scoped variable configured in the Variable field on the Set Scoped Variables activity specified in the Get Scoped Variables Set In This Activity field.

Allowed Values:
A scoped variable.
Default Value:
None
Accepts Variables:
Yes

Value

Description:
Specifies a variable to store the value of the scoped variable.

The value is passed from the scoped variable to the variable specified in this field.

Allowed Values:
A variable that accepts a value of the same data type as the scoped variable.
Default Value:
None
Accepts Variables:
Yes

Add Add icon

Function:
Adds a row for the Variable and Value fields.

Delete Delete icon

Function:
Deletes the Variable and Value row.