Search

User Guide

User Guide

10.2.3
- 10.5.3
- 10.5.0
- 10.4.0
- 10.2.2 HotFix 1
- 10.2.2
- 10.2.1
- 10.2

Back Next

For-Each Loop Field Definitions

For-Each Loop Field Definitions

For-Each Loops are used to iterate over a collection of items such as a list of files contained in a File List or a collection of data in a RowSet.

Field	Definition
Basic Tab
Label	Specify a label for this loop.
Items Variable	Specify a variable that contains the items to iterate over. The value of this attribute must be a variable reference (e.g. ${rowset} or ${filelist}). Currently Collection and RowSet object types are supported, meaning, the value of the referenced variable must be a Collection or a RowSet.
Current Items Variable	Specify a variable name which will be populated with the item at the current index. The variable can then be used in the tasks inside the loop or anywhere in the project. The value must be a valid identifier (e.g. myItem).
Advanced Tab
ID	Specify an ID for this loop. IDs are not required, but are used to conditionally exit or iterate a loop when there are nested loops. The value must be a valid identifier. The ID must be unique in a given loop hierarchy.
Current Iteration Variable	If needed, specify a variable name to hold the current iteration count. The value of this variable is a whole number that starts at 1 and is incremented every time the loop advances.
Current Index Variable	Specify a variable name which will be populated with the index of the current item. The value must be a valid identifier (e.g. index).
Begin Index	Specify the index of the item at which the processing should start. All items before the specified value will be skipped. The value must be a whole number and should be greater than zero. It must also be less than or equal to the End Index. If not specified, this value defaults to 1, which means processing starts with the first item in the Items Variable.
End Index	Specify the index of the item after which the processing should end. All items after the specified value will be skipped. If not specified, this value defaults to the size of items in the specified Items Variable.
Step	Specify the amount by which the current index should be incremented. For example, when Step is set to 2, every other item in the specified Items Variable is processed. If not specified, this value defaults to 1, meaning every item in the specified Items Variable will be processed.
Control Tab
Log Level	Specify the level of logging to be used while executing this loop and the tasks in this loop. Valid options are - silent, normal, verbose and debug. All tasks within this loop will inherit the specified log level, which may be overridden on the individual tasks. All tasks within this Loop will inherit the specified log level from the Loop, unless the log level is specifically overridden on the individual tasks. Default Value: Inherited from parent Module Silent Only logs any errors that are encountered in the Loop. Normal Additionally logs the start and stop times of the Loop, as well as the times of any Loops and Tasks contained in the Loop. Verbose Additionally logs task-level details, such as the names of the files that were processed. Debug Additionally logs detailed debugging information, such as message responses from servers.
Disabled	Whether or not this task is disabled. Default Value: false

Watch

Comments

0 COMMENTS

We’d like to hear from you! Log in to comment.