Skip to main content

Folder Iterator

Folder Iterator

Iterates all files in a given folder and executes those files against a sub flow.

Folder Iterator

The sub flow must return either 0 or 1 as the output for the loop to succeed. Any other return output from the sub flow will abort the iteration and the failure output of the Folder Iterator will be called.

  • Output 0 from the sub flow is returned when the sub flow has no more flow elements to call, ie a connection path is left disconnected.
  • Output 1 from the sub flow is called via the Output or Output 1 flow element.

Flow​

This is the sub flow to execute all the files against.

Folder​

The folder whose files will be iterated.

Pattern​

Any optional pattern to limit the files for iteration, this can be a wildcard pattern starting with a * or a regular expression.

There are the following magic strings that can be used as the pattern

| Pattern | Regular Expression | | IMAGES | \.(jpg|jpeg|jpe|png|gif|bmp|webp)$ | | VIDEOS | \.(ts|mp4|mkv|avi|mpe|mpeg|mov|mpv|flv|wmv|webm|avchd|h264|h265)$ | | AUDIO | \.(mp3|wav|ogg|aac|wma|flac|alac|m4a|m4p)$ |

Leaving this blank all files will be iterated.

Recursive​

If files in all sub folders should also be iterated, or if only the top level files should be iterated.

Variables​

  • IterationIndex Passed into the subflow for each file. This represents the zero-based index of the current file being iterated.

  • IterationTotal Passed into the subflow for each file. This represents the total number of files that will be iterated.

Outputs​

  1. Files have been iterated successfully.

Failure Output​

A return code from the sub flow was unexpected.