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. Using the IntelliScript Editor
  7. XMap
  8. Libraries
  9. Schema Object
  10. Command Line Interface
  11. Scripts
  12. Parsers
  13. Script Ports
  14. Document Processors
  15. Formats
  16. Data Holders
  17. Anchors
  18. Transformers
  19. Actions
  20. Serializers
  21. Mappers
  22. Locators, Keys, and Indexing
  23. Streamers
  24. Validators, Notifications, and Failure Handling
  25. Validation Rules
  26. Custom Script Components

SimpleXmlSegment

SimpleXmlSegment

A
SimpleXmlSegment
component defines a body segment of an
XmlStreamer
input. It defines the element containing the segment and the transformation that should process the segment.
Because a
SimpleXmlSegment
is an XML element, the segment is always well-formed. You can apply a modifier that alters the segment before you pass the segment to a transformation.
The following table describes the properties of the
SimpleXmlSegment
component:
Property
Description
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.
locator
Defines a data holder.
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.
  • 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 DoNothingModifier.
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.


Updated March 18, 2021