# Process List

<!-- meta: type=iterator; location=Logic; category=Logic; platforms=Joomla and WordPress (where applicable) -->

## Overview

Takes a list (such as several articles or rows) and runs the steps after this node once for each item.

This step executes when the flow reaches it along a wired path. It does not call external services by itself unless combined with API or CMS steps — it shapes *how* the flow continues.

## Why use this node

Process List is a **logic step** in the **Logic** group. Logic steps control how data moves through the flow: branch on conditions, loop over lists, pause, merge parallel paths, or reshape payloads.

Typical reasons teams add **Process List** to a flow:

- Create one CMS record per row returned from a database query
- Send a personalised message for each item in an API list response
- Process each attachment or line item from a webhook payload

## Example workflows

Common patterns on the canvas:

1. **Select Row** (many users) → **Iterator** → **Send Email** (one per user)
2. **API REST GET** (list) → **Iterator** → **Create Article** (sync each item)

## How to set it up

On the Design tab, point to where the list lives in the data from the step directly before this one.

## Good to know

Common after a database query that returns many rows, or an API call that returns a list.

## Properties panel

The designer shows these tabs for this node:

| Tab | Purpose |
|-----|---------|
| **Info** | Plain-language description and output payload fields for downstream steps |
| **General** | Canvas label and read-only node ID |
| **AI** | Optional assistant to help draft settings from plain language |
| **Design** | Node-specific configuration fields |

### System (automatic — not edited by the user)

These fields are managed by the designer or runtime — you do not type into them directly:

| Property key | Label | Type | Required | Visible when | Notes |
|--------------|-------|------|----------|--------------|-------|
| `_nodeId` | Node ID | `node-id` | No | — | — |
| `_payloadFields` | Available Fields | `payload-panel` | No | — | — |

### User-configured — General tab

| Property key | Label | Type | Required | Visible when | Notes |
|--------------|-------|------|----------|--------------|-------|
| `label` | Label | `text` | No | — | Node label |

### User-configured — Design tab

| Property key | Label | Type | Required | Visible when | Notes |
|--------------|-------|------|----------|--------------|-------|
| `listPath` | Items to process | `iterator-list-path` | **Yes** | — | — |

### CMS site configuration (not on this node's properties panel)

Credentials, API keys, mailers, SMTP, and integration defaults are configured in the CMS plugin under **Node Configuration**, not per step on this node. Link the flow to a domain before testing CMS-backed fields.

## Output payload fields

After this step runs, later nodes can reference these fields using placeholders such as
`{{process_list.index}}`.

| Field key | Type | Description |
|-----------|------|-------------|
| `index` | number | Zero-based index of the current list item. |
| `total` | number | Total number of items being iterated. |
| `itemCount` | number | Number of items in the current list. |
| `listPath` | string | Payload path used to read the list for iteration. |
| `success` | boolean | Whether the operation completed successfully. |
| `item` | object | One element from the list at listPath for this iteration. |

## Validation rules

- **Items to process** (`listPath`) must be filled before the flow can be saved.

## Related nodes

Other steps in the same area of the palette:

- **Array to String** (`join-array-to-text`) — Logic
- **Check Condition** (`if`) — Logic
- **Filter List** (`filter-list`) — Logic
- **Logger** (`debug`) — Logic
- **Match Text** (`match-regex`) — Logic
