Configure regions

By default, locators operate on the entire page for every page in a document. To expedite processing, you can define regions that restrict the locator to portions of a page or to certain pages. This is useful if, for example, you know that an item always is displayed at the bottom of the first page.

When it comes to regions, there are two different ways that you can restrict a locator. First of all, you can restrict each individual region to look on a specific page or pages. In addition, you can restrict the locator itself to search specific pages. Because of this, the best practice when configuring regions is to always use the Page value to restrict a region and not the Enable locator for setting.

You can define whether a page has full text recognition performed by Transformation Server by configuring the Enable locator for setting on the Regions tab. You can restrict full text recognition to certain pages, but this setting is ignored if any of the other defined locators for this class use the default All pages value.

Some locator methods, such as the Invoice Header Locator, the Line Item Matching Locator, or the Table Locator always require full text recognition on all pages.

Regions are configured on the Regions tab.

The following locators support the use of regions:

Procedure
  1. Expand the Project Tree and select the class that contains the locator.
  2. Optional. View the class contents if they are not already displayed.

    The hidden class contents are displayed.

  3. Open the locator properties.
  4. Select the Regions tab and use the Add and Delete buttons to configure your regions with the following settings.

    Setting

    Description

    Enable locator for

    Select one or more of the following values:

    • All pages (Default: Selected)

    • First page

    • Middle pages

    • Last page

    This setting restricts the actual locator to the selected page. If you want to restrict a specific region, use the Page setting for that region in the table once it is added. The two values cannot conflict each other however. For example, you cannot restrict the locator to the first page and then search for a region on the last page.

    Access

    Select one of the following to restrict the region:

    • Outside the regions (Default: Selected)

    • Inside the regions

  5. Optional. Double-click the name of your new region, enter a new descriptive name, and press Enter.

    The name of the region is updated.

  6. Optional. Select a value for the Page column.

    The selected value restricts the region to a specific page or pages. If All is selected, the region is duplicated on all pages of the document and searched. As a result, if you have a multi-page document, the best practice is to restrict the region using a value from this list. If this is not possible, use the default value.

    The value here cannot conflict with the Enable locator for value specified in step 5. For example, you cannot restrict the locator to the first page and then set the Page value to Last.

  7. Ensure that your newly added region is selected in the table and then reposition and resize that region by following these steps:
    1. Open a document with the appropriate content and page count in the Document Viewer.

      A grey box with a green outline is in the upper left corner of the document. If you selected a specific page, the region may not be on the first page.

    2. To reposition the region, select the grey box and drag it to the appropriate location on that page.
    3. To resize the region, select the green handles and drag one or more of them in turn, until you have the required region size.

      You can use the values in the regions table to modify the size and position of the region. However, the best practice is to use your mouse and the Document Viewer. It is easier to visualize and reposition a zone with your mouse. It also ensures that you do not need to know the precise measurements of your data and their location on your pages.

    Optional. Add additional regions as required.

  8. Open a test document and select Test to test your settings.
  9. Select Close to close the locator properties window.
  10. Save the changes to your project.