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

Streamer

Streamer

The
Streamer
component splits text input into segments. It passes each type of segment to a predefined transformation such as a Parser, mapper, or serializer.
The
Streamer
must be defined at the global level of the Script and it must be the startup component of the transformation.
Under a
Streamer
, you must nest a
ComplexSegment
. The
ComplexSegment
can contain nested
SimpleSegment
or
ComplexSegment
components.
The following table describes the properties of the
Streamer
component:
Property
Description
contains
Defines the overall structure of the source. Default is ComplexSegment.
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.
max_lookup_size
Defines the maximum quantity of new data, in kilobytes, that the
Streamer
searches for each new segment.
For optimal performance, set this property to twice the maximum possible segment size.
When an application activates a deployed
Streamer
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.
on_end_of_input
Defines a transformation that runs at the end of the input stream. For example, the transformation can output a summary message. 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 Streamer.
remark
A user-defined comment that describes the purpose or action of the component.
root_tag
Defines an XML tag in which the
Streamer
wraps the combined output from all the segments. For more information, see Output of a Streamer.


Updated March 18, 2021