Iterator Parameters

Each iterator uses parameters unique to its purpose. Some common parameters are used across the iterators.

Parameter

Description

Iterating Document State

Documents carry state (such as error state, encoding, and so on) as well as payload. You can affect the state as the iteration progresses.

  • Transient. The state in the next iteration reflects the state from the last. For example, if the last state set it into an error state, it will remain in an error state.
  • Original. The state is that of the input document.
  • Reset. Always reset at start of iteration to no error, and so on.

Output Document

Determines the final document to be passed out of the iterator at the end of the iteration. Accumulations are memory intensive.

  • Status. A status document. This is a standard status document.
  • Original. The original document arriving at the iterator.
  • Accum In. Accumulation of the documents coming out of the loop and back into the iterator.
  • Accum Out. Accumulation of the documents passed into each iteration.

Parameters for IterTest and IterCond

Iterate Rule

Determines whether this iteration should be treated as a do-until or a do-while.

  • do_until. Iterate until the condition is true.
  • do_while. Iterate until the condition is false.


iWay Software