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

WriteValue

WriteValue

The
WriteValue
action writes the value of a data holder to a location such as a file or to a string-type data holder.
If the input data holder is an XML element, the action writes both the element and any nested elements and attributes.
The following table describes the properties of the
WriteValue
action:
Property
Description
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.
input
Defines the data holder to write from.
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.
no_tags
Determines whether the result is surrounded by XML tags. You can choose one of the following options:
  • Selected. XML tags are omitted. This is appropriate only if
    input
    is a simple data holder, containing no nested elements or attributes.
  • Cleared. The result is surrounded by XML tags. This is the default.
Default is cleared.
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.
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.
output
Defines the output location. You can choose one of the following options:
  • OutputDataHolder. Writes to a data holder.
  • OutputFile. Writes to a file. Select
    Synchronize
    to lock the file so as to append data to the same file.
  • OutputPort. Defines the name of an
    AdditionalOutputPort
    where the data is written.
  • ResultFile. Writes to the default results file of the transformation.
  • StandardErrorLog. Writes to the user log. For more information, see Failure Handling.
Default is ResultFile. For more information about these options, see Action Subcomponent Reference.
phase
Determines when the Script processes the component. You can choose one of the following options:
  • initial. The Script processes the component during the initial phase.
  • main. The Script processes the component during the main phase.
  • final. The Script processes the component during the final phase.
For more information, see How a Parser Searches for Anchors.
Default is main.
remark
A user-defined comment that describes the purpose or action of the component.
transformers
Defines a list of transformers that modify the value before writing. The input to the transformers is the complete
input
data holder, including XML tags.