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

RunXMap

RunXMap

The
RunXMap
action runs an XMap object as a subcomponent of a parser, a mapper, or a serializer.
The following table describes the properties of the
RunXMap
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
The input for the XMap object. You can choose one of the following options:
  • Data Holder. Use a complex type that must match the XMap input type.
  • XML string. The XML string is the input, or a simple type data holder such as xs:string. The XML root type must match the XMap input type.
If you do not use this property, the XMap object uses its default input.
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.
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
A data holder of a complex type that must match the XMap ouput type.
If you omit this property, the XMap object writes to its default output definiton.
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.
xmap
Name of the XMap. You can choose the name of an existing XMap object.


Updated September 26, 2018