Insert excerpt

	_Banners
	_Banners
name	actionflow
nopanel	true

Overview

Image RemovedImage Added

Use a

Insert excerpt

	_action_loopforeach
	_action_loopforeach
nopanel	true

when it is necessary to repeat an action or set of actions multiple times.

There are three types of supported looping:

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

Start Loop and End Loop

Loops consist of a Insert excerpt_action_loop_start_action_loop_startnopaneltrue and an Insert excerpt_action_loop_end_action_loop_endnopaneltruejoined by a loop connector which returns the result of the End Node to the Start Node. Each part of the 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 passthrough as well as attributes mapped in from the End Loop. This allows the original passthrough values to be referenced and if the loop is manipulating the incoming attributes, 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.

Insert excerpt_property_tabs_property_tabsnamebasic-hnopaneltrue - Start Loop

Basic Settings

FieldDescriptionExample ValueNameThe name given to the node and displayed on the canvas.My LoopEnd 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 Points

This section has a toolbar with standard buttons. iterate over a set of records, or a list of values, and generate an output record of each one.

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Field Description Example Value

Name The name given to the node and displayed on the canvas. MyForEach

Input Expression

The Input Expression iterates over the data provided in the Input Parameters and the records are passed to the Output Attributes in the form _result.value.

Input Parameters are referenced using their name, prefixed with the name of the connector. For example, in.MyAttribute

If an empty record set or list is provided then no output will be generated.

// Receives a list of Invoice IDs, these are iterated over using

in.InvoiceID

Inputs Parameters

Can accept a single

Insert excerpt

	_driving_input_connection_point
	_driving_input_connection_point
nopanel	true

.

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

To add an Input Parameter, in the section toolbar click
Insert excerpt
_add
_add
nopanel true
and set its properties.
To edit an existing Input Parameter, double-click it in the list to open its properties.
To remove an Input Parameter, select one (or more) from the list and in the section toolbar click
Insert excerpt
_delete
_delete
nopanel true
.

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

Output Attributes

The grid contains a list of all Output Attributes.

To add an Output Attribute, in the section toolbar click
Insert excerpt
_add
_add
nopanel true
and set its properties.
To edit an existing Output Attribute, double-click it in the list to open its properties.
To remove an Output Attribute, select one (or more) from the list and in the section toolbar click
Insert excerpt
_delete
_delete
nopanel true
.

Insert excerpt_property_tabs

_property_tabsnamebasic-hnopaneltrue - End Loop

Basic Settings

Field	Description	Example Value
Name	The 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 output	Sets 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 Expression	An 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 Loops	This is a safety net designed to stop infinite loops. The number entered here will stop	//Defaults to 10000 10000

Inputs Parameters

Can accept a single

Invoices

Type

Defines the type of data to be returned.

See Understanding Data Types

String

Expression

This is a PhixScript expression. Values returned by the Input Expression are available in this expression as:

_result.value

If the Input Expression returns multiple values these can be assigned using standard notation. For example

_result.value.1

_result.value.2

To work in a larger popup window, click

Insert excerpt

	_

driving_input_connection_point

editor_expand
	_

driving_input_connection_point

editor_expand
nopanel	true

.

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

To add an Input Parameter, in the section toolbar click Insert excerpt_add_addnopaneltrue and set its properties.

To edit an existing Input Parameter, double-click it in the list to open its properties.

To remove an Input Parameter, select one (or more) from the list and in the section toolbar click

Versions Compared

Old Version 2

New Version 3

Key

Overview

Start Loop and End Loop

Basic Settings

Output Connection Points

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true

Inputs Parameters

Output Attributes

Basic Settings

Inputs Parameters

Page Comparison

Versions Compared

Old Version 2

New Version 3

Key

Overview

Start Loop and End Loop

Basic Settings

Output Connection Points

Insert excerpt_property_tabs_property_tabsnamebasic-hnopaneltrue

Inputs Parameters

Output Attributes

Basic Settings

Inputs Parameters

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true