Field Definition tab - Properties of Script Locator window

Script Locator icon The Script Locator uses a custom script event to locate data and raises a script event that enables users to define their own extraction results. The locator field in the XDoc is prepared based on the Script Locator settings, and can be a simple field or a group field. The locator field can be filled with alternatives in the event handler. How this is done is up to you. You can take results from other locators that are defined to precede this Script Locator or initialize the alternative with custom data. All alternatives are sorted by confidence after the script event.

On the Field Definition tab, you define the output format of your Script Locator using the following settings:

Create

Select one of the following field types for this script locator:

  • Simple field icon Simple field. (Default: Selected)

    Choose this value if your Script Locator returns one or more single-result alternatives, similar to a Format Locator.

  • Group field icon Group field.

    Choose this value if your Script Locator returns one or more alternatives containing subfields, similar to an Advanced Zone Locator.

It is required that subfields defined here are created in script with matching names. Defining subfields on the Field Definition tab associates them with an extraction field.

If the Group field setting is selected, you can add, rename, or delete subfields.

The following buttons are available at the bottom of this window:

Button

Description

Close

Closes the window and saves your changes.

Show ScriptTest icon

Opens the Script Code window.

Test icon   Test

Tests the locator settings. The results are displayed on the Test Results tab that is displayed automatically when you click this button.

Depending on the locator method, this button may have additional modes if the locator uses other locators as input.

Help icon  Help

Displays the help for the open window.

Related topics: