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

NotificationHandler

NotificationHandler

The
NotificationHandler
component defines a list of actions to take for a specified notification.
Insert the
NotificationHandler
component in locations such as the
notifications
property of a
Group
or
RepeatingGroup
. Within the component, you can insert a
WriteValue
action that stores a message in a data holder.
The
VarNotificationDetails
variable stores information about the notification that was most recently triggered. A
NotificationHandler
writes the information stored in
VarNotificationDetails
to the output. For more information about
VarNotificationDetails
, see System Variables.
The following table describes the properties of the
NotificationHandler
component:
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.
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.
notification
Defines the name of a notification for
NotificationHandler
to process. Select a predefined notification or a notification name that is defined in a
Notification
or
NotificationGroup
component. To configure a handler that processes any notification, select
anyNotification
.
remark
A user-defined comment that describes the purpose or action of the component.
source
Defines a data holder that you can use for input to the
NotificationHandler
.
target
Defines a data holder for the output of the
NotificationHandler
.
The following figure shows a
Group
anchor that is configured with a
NotificationHandler
:
level 2 Group >> level 3 notifications = level 4 NotificationHandler >> level 5 notification = InvalidValueInGroup level 5 actions line level 5 WriteValue >> level 6 selected checkbox no_tags level 6 input = $VarnotificationDetails/*s/Value level 6 output = ResultFile() level 6 transformers = level 7 AddString >> level 8 pre = "Invalid value encountered:" level 8 post = ".013.010" level 7 = ... level 5 = ... level 4 = ...
If a component in the
Group
triggers an
InvalidValueInGroup
notification, the handler processes it. The handler writes the
VarNotificationDetails/Value
variable, together with a text string, to the result file of the transformation.