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

User Guide

User Guide

RepeatingGroupSerializer

RepeatingGroupSerializer

The
RepeatingGroupSerializer
serialization anchor writes a repetitive structure to the output document.
Use a
RepeatingGroupSerializer
when the XML data contains a multiple-occurrence data holder. It iterates over the occurrences of the data holder and outputs the data. For more information, see Multiple-Occurrence Data Holders.
Under the
RepeatingGroupSerializer
, nest serialization anchors that process and output each occurrence of the data holder. You can define a separator that the
RepeatingGroupSerializer
writes to the output between the iterations.
The following table describes the properties of the
RepeatingGroupSerializer
serialization anchor:
Property
Description
count
Defines the number of iterations to run. If this property is blank, the iterations continue until the input is exhausted.
current_iteration
Defines a data holder where the
RepeatingGroupSerializer
outputs the number of the current iteration. You can use a
ContentSerializer
to write the number to the output.
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.
notifications
A list of
NotificationHandler
components that handle notifications from nested components. For more information, see Notifications.
on_fail
The action to take if the component fails. You can choose one of the following options:
  • Cleared. Take no action.
  • CustomLog. Write to the user log.
  • LogError. Write an error message to the engine log.
  • LogInfo. Write an information message to the engine log.
  • LogWarning. Write a warning message to the engine log.
  • NotifyFailure. Send a notification.
Default is cleared. For more information about handling component failures, see Failure Handling.
on_iteration_fail
Determines the action when an iteration fails. You can choose one of the following options:
  • Cleared. No action.
  • CustomLog. Writes to the user log.
  • LogError. Writes an error message to the Engine log.
  • LogInfo. Writes an information message to the Engine log.
  • LogWarning. Writes a warning message to the Engine log.
  • NotifyFailure. Triggers a notification.
Use
on_iteration_fail
to write an entry when a single iteration fails. Use the
on_fail
property to write an entry when the entire
RepeatingGroupSerializer
fails. For more information, see Failure Handling.
optional
Determines whether a component failure causes the parent component to fail. You can choose one of the following options:
  • Selected. Component failure does not cause the parent component to fail.
  • Cleared. Component failure causes the parent component to fail.
Default is cleared. For more information about component failure, see Failure Handling.
remark
A user-defined comment that describes the purpose or action of the component.
separator
Defines a serialization anchor that defines the separator string. You can choose one of the following options:
  • AlternativeSerializers
  • ContentSerializer
  • EmbeddedSerializer
  • GroupSerializer
  • RepeatingGroupSerializer
  • StringSerializer
  • User-defined Serializer
Default is blank.
separator_position
Defines the position of the
separator
relative to the sections. You can choose one of the following options:
  • after. Writes a separator after each section, including the first sections. For example,
    1|2|3|4|
  • around. Writes separators before and after each section, including the first sections. For example,
    |1|2|3|4|
  • before. Write a separator before each section, including the first sections. For example,
    |1|2|3|4
  • between. Writes a separator between the successive sections, but not before the first section and not after the last section. For example,
    1|2|3|4
Default is before.
skip_failed_iterations
Determines whether failed iterations are skipped. You can choose one of the following options:
  • Selected.
    RepeatingGroup
    skips over a failed iteration and proceeds with the next iteration. If an iteration succeeds, the
    RepeatingGroup
    succeeds.
  • Cleared.
    RepeatingGroup
    fails if any iteration fails.
The
skip_failed_iterations
property has an effect only if
separator
is defined.
Default is selected.
source
Defines a data holder that contains the source for the serialization. For more information, see Overview of Validators, Notifiers, and Failure Handling.
target
Defines a data holder that contains the result of the serialization. For more information, see Overview of Validators, Notifiers, and Failure Handling.

0 COMMENTS

We’d like to hear from you!