Flow control
A repeater is used in cases where you wish to repeat a task a set number of times. For example, if you would like to send five emails with subjects "Hello 1", "Hello 2", ... "Hello 5", this could be accomplished with connecting the Email > Send an email module after the Repeater module:
Module configuration details:
You can imagine the Repeater module as a generator of bundles outputting one bundle after another. Each bundle contains one item named i of type Number. The initial value of the i item is specified in the Initial value field. The number of repetitions (= number of bundles) is specified in the Repeats field. The value of the i item is increased in each repetition by the value specified in the Step field, which is 1 by default (toggle the Show advanced settings box to reveal it).
An iterator is a special type of module that converts an array into a series of bundles. Each array item will output as a separate bundle.
Setting up an iterator is done in the same way as setting any other module. The Array field contains the array to be converted/split into separate bundles.
In this example, the below shows how to retrieve emails with attachments and save the attachments as single files in a selected Google Drive folder.
Emails can contain an array of attachments. The Iterator module inserted after the first module enables you to handle each attachment separately. The iterator splits the array of attachments into single bundles, each bundle with one attachment will then save one at a time in a selected Google Drive folder. The Array field should contain the Attachments[] array.
For your convenience, many apps offer specialized iterator modules with a simplified setup. For example, the Email app contains the special iterator Iterate attachments that will produce the same results as the general Iterator module without having to specify the array, just the source module.
The video below is module one of the three-part lesson titled Iterator and Array Aggregator. It explains the purpose of the iterator and the array aggregator and with the help of a sample , when to use an iterator, and what to do with the output.
When an iterator does not have information about the structure of the array's items, the mapping panel in the modules following the iterator will display only two items under the iterator: Total number of bundles and Bundle order position:
The reason for this is that in , each module is responsible for providing information about items it outputs so these items can be properly displayed in the mapping panel in the following modules. However, there are several modules that might be unable to provide this information in some cases, e.g. JSON > Parse JSON or Webhooks > Custom Webhook modules with missing data structures.
The solution is to manually execute the to make the module learn about the items it outputs so it can provide the information to the following modules.
For example, if you have a JSON > Parse JSON module without a data structure and then you connect an Iterator module to it, you will not be able to map the output of the module to the Array field in the setup panel of the iterator.
To resolve this, manually start the in the editor. You can un-link the modules after the JSON > Parse JSON module to prevent the flow from proceeding further or right-click the JSON > Parse JSON module and choose Run this module only from the context menu to execute only the JSON > Parse JSON module.
Once the JSON > Parse JSON has been executed, it learns about the items it outputs and provides this information to all the following modules including the iterator. The mapping panel in the iterator's setup will then display the items:
The mapping panel in the modules connected after the iterator will display the items contained in the array's items:
If you cannot see some items in a module's mapping panel, simply run the once so all the modules can learn about the items they output and provide this information to the following modules.
An array aggregator is an aggregator module that allows you to merge several bundles into one single bundle. The following image shows a typical setup of the Array aggregator module.
Field | Description |
|---|---|
Source Module | The module from which the bundle aggregation will start. The source module is usually an iterator or a search module that outputs a series of bundles. Once you setup the aggregator's Source Module (and close the aggregator's setup), the route between the source module and the aggregator will be wrapped in a grey area to visualize the start and the end of the aggregation. |
Target structure type | The target structure into which the data shall be aggregated. The default option is Custom that enables you to choose items that should be aggregated into the Array aggregator's output bundle's Array item:  Once you connect more modules after the Array aggregator module and get back to the module's setup, the Target structure type dropdown will contain all the following modules and their fields that are of type Array of Collections, like e.g. Attachments field of the Slack > Create a Message module:  |
Group by | The aggregator's output can be split into several groups with the help of the Group by field. The Group by field can contain a formula that is evaluated for each aggregator's input bundle. The aggregator then outputs one bundle per each distinct formula's value. Each bundle contains two items:
|
Stop processing after an empty aggregation | By default, the aggregator outputs the result of the aggregation even in case no bundles reached the aggregator (e.g. because they have been all filtered out on their way). If the Stop processing after an empty aggregation option is enabled, the aggregator will not produce any output bundle in this case and the flow will stop. |
Bundles output from the source module and any other modules between the source module and the aggregator module are not output by the aggregator and thus items in these bundles are not accessible by the modules in the flow after the aggregator.
If you need to access items from bundles output from the source module and any other modules between the source module and the aggregator module, make sure to include them in the Aggregated fields field in the setup of the Array aggregator module.
If items are nested (i.e. contained in a collection item) they currently cannot be easily selected in the array aggregator's Aggregated fields field. For example, if bundles contain collection item User with two items Name and Email:
Then only the User collection item can be selected:
This setup will produce the following output:
If you wish to fully customize the Array aggregator's output structure:
Insert the JSON > Create JSON module after the Array aggregator module:
Open the JSON > Create JSON module's setup.
Setup a Data structure for the items you want to be output from the array aggregator. The data structure should be an array of collections and the collections should contain the items you want to include in the output. Here is a sample data structure with two text items Name and Email:
Open the Array aggregator module's setup.
In the Target structure type field, choose the JSON > Create JSON module's array field:
Fields corresponding to the Data structure created in step 3 will appear in the setup of the Array aggregator module. Map any items into the fields. You can now easily map nested items using the mapping panel and even use formulas:
The Array aggregator module's output will now look like this:
If you wish to save the operation performed by the JSON > Create JSON module, put it on a disabled route after a Router:
If you wish to conditionally omit an item from the module's output, use a formula that evaluates to ignore keyword:
If the 4. User: Email is empty then the Email item will be completely omitted from the output: