Looking for Iguana v.5 or v.6? Learn More or see the Help Center.
Segment Iterator Object |
The segment iterator object allows you to programmatically iterate through and access the segments and fields of a message. This is the main object used in scripted transformation. The following shows the methods on the object.
| Method | Description |
|---|---|
| move_next(segmentname) | Move to the next segment named by the provided parameter. Returns false if no such segment exists. |
| move_one() | Move forward by one segment. Returns false if no segment exists. |
| reset(message) | Resets iterator to the top of the message. The message parameter is optional; if it is provided, reset() resets the iterator to the top of message and reconstructs the list of segments to be iterated over. This allows a transformation script to perform scripted transformation on a new or modified message, or on individual parts of a batch message, or on individual Transaction Sets such as in EDI X12 messages. |
| segment_id() | Returns the label of the current segment. |
| apply_transform() | Applies outbound Python scripts to the current segment. |
| count_of_field() | Returns the number of fields in a segment. |
| field(FieldIndex) | Returns a field object at the specified index. For more information, see Field Object Methods/Properties. |
| output() | Returns a string with the current segment. |
For more information on how the segment iterator object is used in scripted transformation, see Examining the Lab Message Transformation Script.
 | ||
|
New Feature in Iguana 4.5 The optional message parameter for the reset() method is new in Iguana 4.5. | ||
 |
 | ||
The segment iterator object can only be used in transformation scripts. It cannot be used when parsing or generating HL7 messages, or in Global Inbound scripts. | ||
 |