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

XmlSegment

XmlSegment

An
XmlSegment
component defines a header or footer segment of an
XmlStreamer
input. It also defines the transformation that processes the header or footer.
An unmodified header or footer is not necessarily well-formed XML. By assigning a modifier component, you can configure the
XmlSegment
to always return well-formed XML.
The following table describes the properties of the
XmlSegment
component:
Property
Description
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.
modifier
Defines how the segment is modified before it is passed to a transformation. You can select the following modifier components:
  • AddHeaderModifier. Passes the segment together with the header of the XML section in which the segment is located.
  • AddStringModifier. Concatenates the segment with prefix or suffix strings.
  • DoNothingModifier. Does not modify the segment. This is the default.
  • WellFormedModifier. Adds closing tags and/or a root element to ensure that the segment is well-formed XML.
For more information about the modifiers, see the Streamer Subcomponent Reference. Default is WellFormedModifier.
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.
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.