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

ContentSerializer

ContentSerializer

The
ContentSerializer
serialization anchor writes the serialized data to the output document.
The following table describes the properties of the
ContentSerializer
serialization anchor:
Property
Description
allow_empty_values
Determines whether
data_holder
can be empty. You can choose one of the following options:
  • Selected. The
    data_holder
    can be empty.
  • Cleared. The
    data_holder
    cannot be empty, otherwise the
    ContentSerializer
    fails.
Default is cleared.
closing_str
Defines the string that the anchor writes after the
data_holder
.
data_holder
Defines the data holder that contains the serialized data.
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.
ignore_default_transformers
Determines whether the default transformers of the
Serializer
are applied to the serialized data. You can choose one of the following options:
  • Selected. The default transformers of the
    Serializer
    are not applied.
  • Cleared. The default transformers of the
    Serializer
    are applied.
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.
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.
opening_str
Defines the string that the anchor writes before the contents of the
data_holder
.
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.
transformers
Defines a list of transformers that are applied to the serialized data.


Updated September 26, 2018