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

Marker

Marker

A
Marker
anchor defines a location in a source document. It is used as a reference point, from which the Script searches for the succeeding anchors.
By default, the
phase
property of a
Marker
is
initial
, which means that the Script scans a document for
Marker
anchors before it searches for
Content
anchors. For more information, see How a Parser Searches for Anchors.
The following table describes the properties of the
Marker
anchor:
Property
Description
absent
Determines whether the specified text or pattern is absent from the document. The
absent
property has the following options:
  • Selected. If the specified text appears in the document,
    Marker
    fails.
  • Cleared. If the specified text appears in the document,
    Marker
    succeeds.
Default is cleared.
adjacent
If selected, the
Marker
must be adjacent to the anchor at the beginning of its search scope. If
direction
is set to
backward
, it must be adjacent to the anchor at the end of its search scope. If not selected, the Script can skip over text until it finds the
Marker
.
The
adjacent
property has the following options:
  • Selected. The
    Marker
    must occur immediately after the beginning of the search scope if
    direction
    is set to
    forward
    or immediately before the end of the search scope if
    direction
    is set to
    backward
    .
  • Cleared. The
    Marker
    can occur anywhere within the search scope.
Default is cleared.
count
Defines the occurrence number to find. For example, to set the
Marker
at the second newline following the preceding anchor, set
search
to
NewlineSearch
and
count
to
2
.
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.
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.
Default is initial.
remark
A user-defined comment that describes the purpose or action of the component.
search
Defines the search criteria for the
Marker
. The search criteria determine where the
Marker
is located within the search scope. For example, a
NewlineSearch
locates the
Marker
at a newline character. A
TextSearch
locates the
Marker
at a specified string. For more information, see How a Parser Searches for Anchors.
The value of this property is one of the following searcher components:
  • NewlineSearch. Searches for a newline character.
  • TextSearch. Searches for a predefined text string or for a text string that is stored in a data holder.
  • PatternSearch. Searches for a string that matches a specified regular expression.
  • OffsetSearch. Skips a predefined number of characters following the preceding reference point, or a number of characters that is stored in a data holder. The
    Marker
    is the point following the skipped characters.
  • TypeSearch. Searches for a string that conforms to a specified data type.
For more information, see the Searcher Component Reference.