Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
nameactionflow
nopaneltrue

Overview

Use a 

Insert excerpt
_action_loop
_action_loop
nopaneltrue
 when it is necessary to repeat an action or set of actions multiple times. 

There are three types of supported looping:

  1. Polling, repeating the same operation multiple times with the same parameters until a desired result is obtained and then generating a single output record. Output results are only generated at the end of the iterations. For example, polling an HTTP API until the results are available.

  2. Accumulation, repeating the same operation multiple times, where each iteration accumulates the progress results and triggers the next iteration with the updated result. Generates a single output record. For example, calling the DB to get the parent record, and repeating with the parent until the root has been reached.

  3. Paging, repeating an operation multiple times with different parameters and generating the next parameters with a set of output records for each iteration of the loop. For example, reading from a paging API, where each iteration gives you the link for the next iteration and a set of output records.

For a worked example, see Loop Action Configuration.

Start Loop and End Loop

Loops consist of a

Insert excerpt
_action_loop_start
_action_loop_start
nopaneltrue
  and an 
Insert excerpt
_action_loop_end
_action_loop_end
nopaneltrue
joined by a loop connector which returns the result of the End Node to the Start Node. Each part of the loop Loop has its own set of properties described below.

The key concept of a loop is that the attributes passed into it are available as a passthrough and as well as attributes mapped in attributesfrom the End Loop. This allows for the original passthrough value values to be referenced and if the loop is manipulating the incoming attributeattributes, for example incrementing a number, this is also available. The mapped attributes that are manipulated by the loop are shown with a loop icon, passthrough attributes will be shown with the icon of where they have come from, for example a calculated action.

Tip

Loops wait until all their internal nodes have completed their tasks before beginning the next iteration of a loop.


Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue
 -  Start Loop

Basic Settings

FieldDescriptionExample Value
NameThe name given to the node and displayed on the canvas.My Loop
End Loop Action

A read-only field that states the end loop node associated with the start loop node.

// The End Loop Node will initially take the name of the Start Loop // Node and prefix it with "end".

End My Loop

Output

Connection PointsThis section has a toolbar with standard buttons

Attributes

The grid contains a list of all output connection pointsOutput Attributes.

  • To add a new output pathan Output Attribute, in the section toolbar click 
    Insert excerpt
    _add
    _add
    nopaneltrue
     to open a new output path and set the expression; see Output Connection Points and set its properties.
  • To edit an existing output path Output Attribute, double-click it in the list to open its properties.
  • To remove an output path Output Attribute, select one (or more) from the list and in the section toolbar click 
    Insert excerpt
    _delete
    _delete
    nopaneltrue
    .

Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue
 -  End Loop

Basic Settings

FieldDescriptionExample Value
NameThe name given to the node and displayed on the canvas. The name will default to the Start Loop name prefixed with end.End My Loop
Records to outputSets whether to output all records from the loop or just the final record.All Records or Final Record
Output Mode

A read-only field that states the end loop node associated with the start loop node.

// The End Loop Node will initially take the name of the Start Loop // Node and prefix it with "end".

End My Loop

Until ExpressionAn expression that is checked on each cycle of the loop, and once the expression returns true the loop will end.  

// Where myValue is being sent into the End Loop Node on a pipe // called in.

in.myValue == 10

Max LoopsThis is a safety net designed to stop infinite loops. The number entered here will stop 

//Defaults to 10000

10000

Input

Connection Points

Parameters

Can Accept accept a single

Insert excerpt
_driving_input_connection_point
_driving_input_connection_point
nopaneltrue
.

The grid contains a list of all input connection points and their type.

  • To add a new input connection pointan Input Parameter, in the section toolbar click 
    Insert excerpt
    _add
    _add
    nopaneltrue
     to open a new input connection point and  and set its properties; see Input Connection Points.
  • To edit an existing input connection pointInput Parameter, double-click it in the list to open its properties.
  • To remove an input connection pointInput Parameter, select one (or more) from the list and in the section toolbar click 
    Insert excerpt
    _delete
    _delete
    nopaneltrue
    .

Output Connection Points

This section has a toolbar with standard buttonsThe grid contains a list of all output connection points.

To add a new output path, in the section toolbar click  Insert excerpt_add_addnopaneltrue to open a new output path and set the expression; see Output Connection Points.
  • To edit an existing output path, double-click it in the list to open its properties.
  • To remove an output path, select one and in the section toolbar click 

    Input Parameters can be mapped to by clocking on the incoming connector.


    Insert excerpt
    _

    delete

    audit
    _

    delete

    audit
    nopaneltrue

    .