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

FindReplaceAnchor

FindReplaceAnchor

The
FindReplaceAnchor
anchor marks the source text and specifies replacement text for transformation by the
TransformByParser
transformer.
The following table describes the properties of the
FindReplaceAnchor
anchor:
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.
marking
Determines whether an anchor is used as the start of the search scope for the succeeding anchor. You can choose one of the following options:
  • begin position. Place a reference point before the current anchor.
  • end position. Place a reference point after the current anchor.
  • full. Place a reference point before and after the current anchor.
  • none. Do not create a reference point.
For more information, see How a Parser Searches for Anchors.
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_initial_phase
Determines whether the Script searches for nested anchors in the main phase. You can choose one of the following options:
  • Cleared. Search for nested anchors according to their individual properties.
  • Selected. Search for nested anchors in the main phase.
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.
on_partial_match
Determines the behavior when
FindReplaceAnchor
does not find all its nested, non-optional anchors. You can choose one of the following options:
  • fail.
    FindReplaceAnchor
    fails. Default.
  • skip.
    FindReplaceAnchor
    removes the area spanned by the successful nested anchors from its search scope and tries to find all the nested anchors again. It repeats this process until it finds the anchors or fails.
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.
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.
replace_with
Defines a literal replacement string or a data holder that contains the replacement string.
source
Defines a sequence of data holders for input to the
FindReplaceAnchor
. Each data holder is identified by one of the following properties:
  • Locator. Identifies a single-occurrence or a multiple-occurrence data holder. For multiple-occurrence data holders, each iteration accesses a new occurrence.
  • LocatorByKey. Identifies a multiple-occurrence data holder by key.
  • LocatorByOccurence. Identifies a multiple-occurrence data holder by sequence number.
Use the
source
property when the
FindReplaceAnchor
is called by another component. For more information, see Source Property.
target
Defines a sequence of data holders for output from the
FindReplaceAnchor
. If a data holder does not yet exist, it is created. Each data holder is identified by one of the following properties:
  • Locator. Identifies a single-occurrence or a multiple-occurrence data holder. For multiple-occurrence data holders, each iteration creates a new occurrence.
  • LocatorByKey. Identifies a multiple-occurrence data holder by key.
  • LocatorByOccurence. Identifies a multiple-occurrence data holder by sequence number.
Use the
target
property when the output of the
FindReplaceAnchor
is used by another component. For more information, see Target Property.
If
FindReplaceAnchor
does not contain nested anchors, it marks all the text within its search scope. For example, if
FindReplaceAnchor
is between two
Marker
anchors, it marks the text between them.
If
FindReplaceAnchor
contains a
Marker
anchor, it marks the
Marker
for replacement.
If
FindReplaceAnchor
contains two
Marker
anchors, it marks the
Marker
anchors and the segment between them for replacement.
The replacement text can be a static replacement string or a string retrieved dynamically from the source document.
For more information, see TransformByParser.