Table of Contents

Search

  1. Preface
  2. Introduction to Data Transformation
  3. Data Processor Transformation
  4. Wizard Input and Output Formats
  5. Relational Input and Output
  6. XMap
  7. Libraries
  8. Schema Object
  9. Command Line Interface
  10. Scripts
  11. Parsers
  12. Script Ports
  13. Document Processors
  14. Formats
  15. Data Holders
  16. Anchors
  17. Transformers
  18. Actions
  19. Serializers
  20. Mappers
  21. Locators, Keys, and Indexing
  22. Streamers
  23. Validators, Notifications, and Failure Handling
  24. Validation Rules
  25. Custom Script Components

Data Transformation User Guide

Data Transformation User Guide

SimpleSegment

SimpleSegment

A
SimpleSegment
component defines a data unit that contains an opening marker and a closing marker. It also defines the transformation that processes the data unit.
The opening and closing markers are defined with regular expressions. For more information about regular expression syntax, see RegularExpression.
The following table describes the properties of the
SimpleSegment
component:
Property
Description
closing_marker
Defines a regular expression that identifies the segment end. If this property is undefined, the segment end is the end of the source or the start of the next segment. Default is MarkerStreamer.
count
Defines the maximum number of segments to pass to the transformation. For example, if
count
is 3, the Streamer searches for three consecutive instances of the segment. It passes the three segments together to the transformation. If it finds only one or two segments, it passes those segments.
If the segments are small, passing multiple segments to a transformation can improve performance because it reduces the Streamer overhead. Within the transformation, use a component such as
RepeatingGroup
to process the individual segments.
Default is 1.
disabled
Determines whether the Script ignores the component and all of the child components. Use this property to test, debug, and modify a Script. You can choose one of the following options:
  • Selected. The Script ignores the component.
  • Cleared. The Script applies the component.
The default is cleared.
name
A descriptive label for the component. This label appears in the log file and the
Events
view. Use the
name
property to identify the component that caused the event.
opening_marker
Defines a regular expression that identifies the segment start. If this property is undefined, the segment start is the beginning of the source or the end of the preceding segment. Default is MarkerStreamer.
remark
A user-defined comment that describes the purpose or action of the component.
run_component
Defines a transformation that processes the segment. You can choose one of the following options:
  • The name of a Parser, Serializer, or Mapper that is configured at the global level of the Script.
  • A
    Mapper
    or
    Serializer
    component. Configure the Mapper or Serializer within the segment.
  • A
    WriteSegment
    component that copies the segment to the output. For more information, see WriteSegment.