Insert excerpt

	_Banners
	_Banners
name	actionflow
nopanel	true

Overview

Loop Node Properties

Image Modified

Use a

Insert excerpt

	_action_loop
	_action_loop
nopanel	true

when it is

neccessary

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.

Worked Example

For full details on how to create a loop node(s), including worked examples, see Loop Action Configuration.

Start Loop and End Loop

Loops consist of a

Insert excerpt

	_action_

property

loop_

tabs

start
	_action_

property

loop_

tabsnamebasic-h

start
nopanel	true

Basic Settings

FieldDescriptionExample ValueNameName given to the action node. This will be displayed on the actionflow canvas.MyJSONReaderInput Expression

The input expression provides the JSON data to be operated upon. Typically this will be a simple expression pointing at an incoming attribute such as the body from an HTTP Action or the body from an API request.

// consist of the name of the pipe and the name of a // mapped attribute.

in.body

Use Strict JSON parsing

Defines the parsing of the JSON, disabled will be lenient and enabled will be strict.

Lenient parsing relaxes validation allowing the following to be present in the JSON data:

Use of single quotes, for example: {'name': 'Some “quotes” in a string'}
Unquoted field names, for example: {name: “value”}
Unescaped control characters, including literal new lines to appear within a string.
Allow trailing commas {“name”: ”value”,}

// leaving the default option

Disabled.

Path

The JSON Path expression is evaluated against the data provided by the Input Expression and returns a list of JSON node items.

It can be used to specify which nodes are extracted from the JSON.

// JSON Path

$.main_page.title

Input Connection Points

Can Accept a single Insert excerpt_driving_input_connection_point_driving_input_connection_pointnopaneltrue.

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

To add a new input connection point

and an

Insert excerpt

	_action_loop_end
	_action_loop_end
nopanel	true

joined 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.
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
name basic-h
nopanel true
- Start Loop
Basic Settings
Field Description Example Value
Name The 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 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

to open a new input connection point and
and set its properties
; see Input Connection Points
.
To edit an existing
input connection point
Output Attribute, double-click it in the list to open its properties.
To remove an
input connection point
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_tabs
name basic-h
nopanel true
- 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.
Output Connection Points
This section has a toolbar with standard buttons.
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
Input Parameters
Can accept a single
Insert excerpt
_driving_input_connection_point
_driving_input_connection_point
nopanel true
.
The grid contains a list of all
output
input connection points and their type.
To add
a new output path
an Input Parameter, in the section toolbar click
Insert excerpt
_add
_add
nopanel true
to open a new output path and set the expression; see Output Connection Points
and set its properties.
To edit an existing
output path
Input Parameter, double-click it in the list to open its properties.
To remove an
output path
Input Parameter, select one (or more) from the list and in the section toolbar click
Insert excerpt
_delete
_delete
nopanel true
.
Output Attributes
JSON is converted into data objects that can be used by PhixFlow, this information is accessed using the syntax, _result.AttributeName.
Worked Example
Below is an example JSON object passed to the JSON Action Node:
Code Block
language js
theme Eclipse
firstline 1
title Example JSON
linenumbers true
// Example JSON string. { "main_page": {         "page": "PF Main Page",         "title": {             "name": "PF Title Text",             "data": [                 {"initials": "AA", "value" : "Alistair Andrews"},                 {"initials": "BB", "value" : "Bert Brown"}             ]         }     } }
JSON Path: $.main_page.title
This path will bring back all elements matching the JSON path including the parent/grandparents and all child elements. The path defines the starting point from which we reference the JSON nodes.
The following examples show how to reference the returned JSON data:
_result.name, returns PF Title Text
_result.^.page, returns PF Main Page
The ^ traverses up the JSON hierarchy.
listToString(_result.data.initials), returns "AA, BB"
Because there are multiple JSON nodes under  _result.data.initials, an array of data is returned. See Array Handling Functions.
Info
title Note the use of
^ traverses up the hierarchy 1 layer.
. tranverses down the heirach 1 layer.
Learn More
Understanding Actionflows
Creating Actionflows
Wiring Actionflows
For links to all pages in this topic, see Understanding Actionflows.
Input Parameters can be mapped to by clocking on the incoming connector.

Insert excerpt
_audit
_audit
nopanel true

Version	Old Version 2	New Version Current
Changes made by	Anthony George	Zoe Baldwin
Saved on	Mar 28, 2023	Jan 23, 2025

Versions Compared

Key

Loop Node Properties

Worked Example

Start Loop and End Loop

Basic Settings

Input Connection Points

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true
- Start Loop

Basic Settings

Output Attributes

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true
- End Loop

Basic Settings

Output Connection Points

Input Parameters

Output Attributes

Worked Example

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

Page Comparison

Versions Compared

Key

Loop Node Properties

Worked Example

Start Loop and End Loop

Basic Settings

Input Connection Points

Insert excerpt_property_tabs_property_tabsnamebasic-hnopaneltrue - Start Loop

Basic Settings

Output Attributes

Insert excerpt_property_tabs_property_tabsnamebasic-hnopaneltrue - End Loop

Basic Settings

Output Connection Points

Input Parameters

Output Attributes

Worked Example

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true
- Start Loop

Insert excerpt
_property_tabs
_property_tabs
name basic-h
nopanel true
- End Loop