Initialize Loop activity

An activity that repeats an action for a process data variable with a Boolean data type until the value of the variable is set to true. When the value of the variable is true, the loop completes, and the process moves forward.


Initialize Loop activity

Configure the Initialize Loop activity

To configure the Initialize Loop activity, do the procedure in this topic.

Examples

Prerequisites

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • When you configure a Next Loop activity immediately after a Condition activity, the variables defined in the Initialize Loop activity are populated in the Next Loop activity. If you try to use the variables in any activity between the Condition and the Next Loop, the variables will not have the correct data.
  • 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?

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 Utilities Utilities icon tab.
      2. On the Utilities Utilities icon tab, drag the Initialize Loop Initialize Loop 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 Looping Init Looping Init icon.
  3. Complete the fields on the Loop Configuration screen.

    For more information, refer to Do a Loop to Repeat an Action.

  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 basic settings for the Initialize Loop activity.

Figure: General Configuration screen

General Configuration 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:
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
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

Loop Configuration

Configures the details for your loop.

Figure: Loop Configuration screen

Loop Configuration screen

Fields

Field Name Definition

Source Dataset
Function:
Specifies the repeating schema element from the Process Data > Form Data or Model Data tab that stores the list of child elements.
Accepted Values:
A valid repeating XML schema element.
Default Value:
None
Accepts Process Data Variables:
Yes

Current Row Variable
Function:
Specifies a process data variable that stores the values of a column in a data source.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes

Dataset Column Name
Function:
Shows the list of child elements from a repeating schema element.
Accepted Values:
A valid child element name.
Default Value:
None.

If you specify the repeating schema element in the Source Dataset field, the name of the child element shows.

Accepts Process Data Variables:
Yes

Exit loop when following variable set to true
Function:
Specifies a process data variable with a Boolean data type to exit the loop. When the variable is set to true, the loop completes, and the process moves forward.
Accepted Values:
A process data variable.
Default Value:
None
Accepts Process Data Variables:
Yes

Add Add icon
Function:
Creates a row.

Delete Delete icon
Function:
Deletes the row.