Iterator Step
The Iterator step allows you to choose an Iterator for a process. The Iterator component is used to extract individual parts from a larger data object. The iterator places the individual parts into message objects returned by the GetMessage action. Each subsequent call to GetMessage returns the next part. Iterators do not change the source data object. A typical application of an Iterator component includes breaking apart EDI documents to allow processing of the document contents.
To add an Iterator step:
1. Drag and drop an 
Iterator step from the Palette to the canvas.
Iterator step from the Palette to the canvas.2. Double-click the step on the canvas to open the Step Properties tab.
3. Type a unique name for the step.
4. Create an instance of this component in one of the following ways:
• By clicking the Select Iterator dropdown and then selecting Add a New Iterator.
• From the Configuration tab > Message Components section.
5. Specify the step properties.
For more information, see Adding Steps.
Iterator Step Properties.
Name | Description |
|---|---|
Name | Unique name for the step. You can use alphabets, numbers, and special characters such as -, _. . , and #. |
Description | (Optional) Description of the step. |
Enabled | Select this option to enable the step for execution. If it is not enabled, then the step on the canvas is greyed-out. This option is useful when troubleshooting a process, especially when there are numerous steps in the process. You can also enable or disable the step using the right-click menu options. If the step is enabled, then to disable the step, right-click on the step and select Disable Step. If the step is disabled, then to enable the step, right-click on the step and select Enable Step. |
Error Handling | Select either of the following: • Stop Process - (Default) All the steps after the current step are skipped or the entire process is stopped (depending on how you have the error logging options set) if this step stops due to an error. • Ignore Error - The remaining steps in this process are executed even if this step stops due to an error. This is useful when you want to write a Decision step that can test for the error state of a previous step. Note: The Break after first error Logging Option on the Configuration tab overrides the Ignore Error option in the step level, hence when you set the Ignore Error option at step level, you should uncheck (disable) the Break after first error Logging option for the Ignore Error to be effective. |
Select Iterator | Select an Iterator instance. These instances are displayed when you add message components in the Configuration tab. For more information, see Adding Message Components in Configuring Processes. |
Action | Select an action for the iterator instance. |
Parameters | Parameters for the selected action. Specify values for the parameters. |
Properties | Properties for the selected action. Specify values for the properties. |
Note: The Actions, Parameters, and Properties are specific to the component type. For information about this, based on the component instance selected in the Select Iterator drop-down list, click the component type in the Iterator Step Components section below.
Iterator Step Components
Last modified date: 02/09/2024