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

Data Transformation User Guide

Data Transformation User Guide

XmlStreamer

XmlStreamer

The
XmlStreamer
component splits an XML input into header, body, and footer segments. It passes each type of segment to a predefined transformation such as a Mapper or Serializer.
The
XmlStreamer
must be defined at the global level of the Script and it must be the startup component of the transformation.
Under an
XmlStreamer
, you can nest
XmlSegment
,
ComplexXmlSegment
, and
SimpleXmlSegment
components.
The following table describes the properties of the
XmlStreamer
component:
Property
Description
allow_unmarked_text
Determines whether the segments in the
sub_elements
list can be separated by intervening text or by other elements. You can choose one of the following options:
  • Selected. The segments can be separated by intervening text or by other elements. The intervening content is ignored.
  • Cleared. The segments can be separated only by whitespace.
Default is cleared.
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.
Footer
Defines how to process the footer of the
ComplexXmlSegment
. For more information, see XmlSegment. Default is XmlSegment.
Header
Defines how to process the header of the
ComplexXmlSegment
. For more information, see XmlSegment. Default is XmlSegment.
max_lookup_size
Defines the maximum quantity of new data, in kilobytes, that the
XmlStreamer
searches for each new segment.
For optimal performance, set this property to twice the maximum possible segment size.
When an application activates a deployed
XmlStreamer
service through an API, it must set the chunk size parameter to a value that is smaller than the
max_lookup_size
.
Default is 10000.
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.
sub_elements
Defines a list of
ComplexXmlSegment
or
SimpleXmlSegment
components that define how to process the body of the XML input.


Updated September 26, 2018