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

LocatorByKey

LocatorByKey

The
LocatorByKey
component identifies an occurrence of a multiple-occurrence data holder in the
source
and
target
properties.
Before you use
LocatorByKey
, you must define a
Key
at the global level of the Script. The
Key
specifies the data holders that uniquely identify the occurrence.
The following table describes the properties of the
LocatorByKey
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.
key
Defines the XPath predicate representation of the key. For example, if you have defined
Hobbies/Hobby/@name
as a
Key
, select
Hobbies/Hobby[@name=$1]
. This property is required.
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.
params
Defines the values of the parameters in the XPath predicate. Each value has a dollar sign ($) and an integer that represents the position of the parameter in the list of parameters. This property is required.
remark
A user-defined comment that describes the purpose or action of the component.


Updated September 26, 2018