Array Split Documentation

Version: 3.1.0 
Retrieved: 2025-10-09 15:15:13

Array Split

The module accepts arrays and split them into individual messages sent to the next module(s).

This module is designed to be located in the middle of a flow.

Settings

The array is selected by Source Property. If the content is a simple object (int, string etc) the Target Property have to be defined. If a definition is missing the default target property (data) will be used.

Name Requirements Purpose Default
Source Property Length: 1-64 The property that contains the array data
Target Property Length: 0-64 The property to write the value to. Mandatory for simple objects data
Keep Properties true/false If true all properties on the object passed in will be included side by side with each object in the array when sent to the next module(s) true
Add Array Information true/false If true an array element will be added to the output together with the array element containing information of the current array to be used by other modules later on in the flow false
Array Information Property Length: 0-64. 1-64 if Add Array Information is true. The property to write the eventual array element to. Must be set if array information should be written. array

Input

The input must have a property that matches the Source Property property.

Name Required Type Description
[Source Property] yes string The property containing the array to split

Output

Output will be 0-N, each output will be the n-th item in the array. If Add Array Element if set, an extra property Array Information Property will be added containing data that an eventual Array Join module later on in the flow will use if it is configured with Auto mode.

Array Information Property object

Property Description
arrayId Unique id for the splitted array
indexOfElement Index for the current element from the array
arrayLength Total length of the splitted array
includeInJoin Flag telling any eventual Array Join module if this element should be included when the array is joined. true by default.

Example

# Settings:
Source Property = data
Target Property = data
Keep Properties = true
Add Array Information = true
Array Information Property = array

# Incoming messages:
{
    "data": [1, 2, 3]
}

# Outgoing message 1:
{
    "data": 1,
    "array": {
        "arrayId": "7397edd4-37e7-4194-9e53-c0bd92e16c39",
        "indexOfElement": 0,
        "arrayLength": 3,
        "includeInJoin": true
    }
}

# Outgoing message 2:
{
    "data": 2,
    "array": {
        "arrayId": "7397edd4-37e7-4194-9e53-c0bd92e16c39",
        "indexOfElement": 1,
        "arrayLength": 3,
        "includeInJoin": true
    }
}

# Outgoing message 3:
{
    "data": 3,
    "array": {
        "arrayId": "7397edd4-37e7-4194-9e53-c0bd92e16c39",
        "indexOfElement": 2,
        "arrayLength": 3,
        "includeInJoin": true
    }
}

Search Documentation

Analytics Modules