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

User Guide

User Guide

Standard Anchor Properties

Standard Anchor Properties

The following table describes standard properties of anchors:
Property
Description
direction
A search direction for the anchor within the search scope. You can choose one of the following options:
  • backward. Search from the end of the search scope and finds the last instance of the anchor.
  • forward. Search from the start of the search scope and finds the first instance of the anchor.
For a
Marker
anchor, you can modify this behavior by using the
count
property. For example, if
direction = backward
and
count = 2
, the Script finds the second-to-last instance.
Default is forward. For more information, see How a Parser Searches for Anchors.
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.
notifications
A list of
NotificationHandler
components that handle notifications from nested components. For more information, see Notifications.
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.
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.
remark
A user-defined comment that describes the purpose or action of the component.
When it is not certain that an anchor exists in a source document, select the
optional
property. If the anchor does not exist, the
Parser
in which the anchor is nested continues.
If the anchor is nested within a
Group
anchor, the
optional
property prevents the
Group
from failing. If the anchor is in a
RepeatingGroup
, the property prevents an iteration of the
RepeatingGroup
from failing.

0 COMMENTS

We’d like to hear from you!