Add a FormXtra zone recognition profile

Use the procedure in this topic to add a FormXtra zone recognition profile.

The FormXtra recognition engine is specialized to read hand-written content in a zone.

Procedure
  1. On the Project tab, in the Configuration group, select Project Settings icon Project Settings.
  2. Select the Recognition tab to view the recognition settings.
  3. Select Add icon Zone Profile.

    A properties window is displayed.

  4. From Zone Recognition Method, select FormXtra 8.4.

    The properties displayed on the window automatically update to the selected recognition method.

  5. On the General tab, configure the following settings:

    Setting

    Description

    Field Type

    Select a field type from the following values. The value selected here affects what other settings are displayed.

    Value

    Description

    Languages

    Writing Style

    Field Type Specific Settings

    Alphanumeric (Default: Selected)

    Select when the text in a zone contains a combination of alpha and numeric characters. This zone supports the combination of characters from the alpha and numeric field types.

    All languages

    All writing styles

    User dictionaries, Template, and Special Characters

    Alpha

    Select when the text in a zone includes letters in upper, lower, or mixed case.

    All languages

    All writing styles

    User dictionaries, Template, and Special Characters

    Numeric

    Select when the text in a zone includes a number from 0 to 9.

    This field type value is available for all languages.

    All languages

    All writing styles

    User dictionaries, Template, and Special Characters

    Age.

    Select when the text in a zone is an age. This can be either a numerical value such as 37 or an alpha-numeric value such as "12 years old."

    The following abbreviations are supported:

    • Day, Days, Dys

    • Mo, Month, Months, Mos, Mths, Mth, Month Old, Months Old, Mos Old, Mths Old

    • Week, Weeks, Wk, Wks

    • Year, Years, Years Old, Yr, Yrs, Yrs Old

    English only

    Handprint and Boxed Handprint only

    User dictionaries

    Amount

    Select when the text in a zone is an amount value that may also contain several special characters, such as a space, comma ,, dash -, period ., and the dollar sign $. The currency character is not included in the extracted value.

    If amounts in other currencies are not successfully recognized, try using the Numeric field type.

    English only

    Handprint and Boxed Handprint only

    User dictionaries

    Credit Card Number

    Select when the text in a zone is a credit card number. This field type does not support other similar cards such as debit cards, prepaid cards, cash cards, etc.

    Any other data associated with a credit card, such as the name or expiration date require their own zone for extraction.

    All languages

    All writing styles

    User dictionaries

    Date

    Select when the text in a zone is a date.

    All languages

    All writing styles

    User dictionaries, Date Format, and Valid Dates

    First Name

    Select when the text in a zone is a first name. This can also include a middle initial.

    All languages

    All writing styles

    User dictionaries

    Middle Name

    Select when the text in a zone is a middle name or initial.

    All languages

    All writing styles

    User dictionaries

    Last Name

    Select when the text in a zone is a last name.

    All languages

    All writing styles

    User dictionaries

    Full Name

    Select when the text in a zone is a name, middle initial, and last name in a single field. Select when it is difficult to reliably separate the different name components with individual zones.

    All languages

    All writing styles

    User dictionaries and Name Format

    Phone Number

    Select when the text in a zone is telephone number.

    All languages

    All writing styles

    User dictionaries and Phone Format

    Social Security Number

    Select when the text in a zone is a Social Security Number. This supports the numbers 0 to 9 as well as a space, period (.), dash (-), and a slash (/).

    All languages except Russian

    All writing styles

    User dictionaries, Use Checksum, and Country

    Length

    Select when the text in a zone is a length measurement expressed in feet, inches, or both, using the apostrophe (') and quotation marks (") characters.

    For example, 3 2, 3-2, 3'2", 3' 2", 3'2", and 3' - 2" are all recognized as 3 feet and 2 inches and returned in the same format that as the extracted value.

    English only

    Handprint and Boxed Handprint only

    User dictionaries

    Language

    Select a language from the list to ensure the best recognition results for that language. (Default: English)

    The available languages include English, German, French, Russian, Portuguese (Brazilian), and Spanish (Latin American).

    The languages depend on what is selected in the Field Type setting. A language is greyed out if not available for the selected field type. See Language support for FormXtra zone field types for information on what field types are supported for the various languages.

    Writing Style

    Select the expected hand writing style in the corresponding zone. This can improve recognition results if a field uses one style only. Select one of the following values:

    Cursive:

    Select if a zone is for continuous writing or cursive handprint such as a signature.

    Handprint:

    Select if the zone is for hand printed text, such as block text. (Default: Selected)

    Boxed Handprint:

    Select if the zone is drawn around a set of boxes where hand printed block text is enclosed.

    Recognition Mode

    Select the recognition mode from the following values:

    Accurate:

    Select if you want to prioritize the recognition accuracy over the speed of recognition. If you choose this value, the recognition process takes longer.

    Fast:

    Prioritizes speed of recognition over the recognition accuracy. If you choose this value, the recognition process takes less time, but the overall recognition accuracy may decrease.

    Default:

    Executes the best recognition result between speed and accuracy at the time of recognition. (Default: Selected)

  6. The Field Type Specific Settings on the General tab depend on the value selected for Field Type. Configure the following settings if required.

    Setting

    Description

    Availability

    User dictionaries

    Adds one to four dictionaries that contains words that are likely to appear in a zone. Dictionaries can significantly improve recognition.

    Dictionary files must be a text file in ASCII format that contains a list of keywords. Each keyword must be listed on a new line with no spaces or other white space.

    Dictionary files are mandatory for all languages other than English.

    Available for all Field Type values.

    Template

    Enables you to define the format of a specific field using a string of characters and symbols that represent part or a full string.

    Depending on the selected field type, a template can include the following characters to represent a string:

    • # matches any numeral.

    • @ matches an alphabetic character. This character is not supported for Numeric fields.

    • $ matches special symbols.

    • * matches any symbol.

    For example, an insurance application number always consists of three alphabetic characters followed by four numbers. To match this pattern, use @@@#### for a template.

    Available when Field Type is set to Alphanumeric, Alpha, or Numeric.

    Special Characters

    This is a comma-separated list where you specify additional characters that are expected in a zone.

    For example, to extract an email address, set the Field Type to Alphanumeric and then include the @ symbol as a special character. There is no need to add dashes or periods as special character as these are recognized as part of the Alphanumeric field type.

    Similarly, to extract a time such as 14:37, set the Field Type to Numeric and then include the colon : symbol as a special character.

    Available when Field Type is set to Alphanumeric, Alpha, or Numeric.

    Date Format

    Specific date formats are not available for some languages. If a date format is not available for the selected language, the format is not available for selection.

    Select the expected date format from the following list of possible formats:

    • MMDDYYYY (Default: Selected) - This value recognizes dates using numerical representations for month, then day, then year. For example, 11/30/2020 or 11-30-21 .

    • MMMMDDYYYY - This value recognizes a non-numerical month, then the numerical value for day and year. For example, November 30, 2020, or NOV 30 20.

    • DDMMYYYY - This value recognizes dates using numerical representations for day, then month, then year. For example, 30/11/2020 or 30-11-20.

    • DDMMMMYYYY - This value recognizes a numerical value for the day, followed by a non-numerical month value, then a numerical year. For example, 30th November, 2020, or 30NOV20.

    • YYYY - The year only.

    • MM - The month only.

    • DD - The day only.

    • MMYYYY - The month and year only.

    • MMDD - The month and day only.

    • YYYYMMDD - The universal date format.

    • Generic US - This value includes four formats that are typically used in the US. These include MM/DD/YYYY, MMMM/DD/YYYY,, DD/MMMM/YYYY, and YYYY/MM/DD. Select when one of these supported formats is expected, but the specific format is unknown or inconsistent.

    • Generic European.

      This value includes four formats that are typically used in Europe. These include DD/MM/YYYY, MMMM/DD/YYYY, DD/MMMM/YYYY, and YYYY/MM/DD. Select when one of these supported formats is expected, but the specific format is unknown or inconsistent.

    • Unspecified (US, European) - This value indicates the format can be any of the formats supported in the Generic US and Generic European formats. Select when the specific format is unknown.

    Available when Field Type is set to Date.

    Valid Dates

    When the Field Type is set to Date it is possible to specify a minimum and maximum range to help validate the extracted dates.

    Start Date

    Select the calendar to select a minimum date. The extracted date must be later than the selected minimum date.

    End Date

    Select the calendar to select a maximum date. The extracted date must be earlier than the selected minimum date.

    Available when Field Type is set to Date.

    Name Format

    Select a format from the list that indicates how the name is displayed in the zone. Choose from:

    • First Last

    • Last, First

    Available when Field Type is set to Full Name.

    Phone Format

    Select the expected phone number from the following formats:

    • [###-]###-#### (Default: Selected)

    • ###-###-####

    • ###-####

    • ###

    The list of available phone formats is restricted to American-style phone numbers. If you want to recognize phone numbers from other countries, use the Numeric value for the Field Type setting.

    Available when Field Type is set to Phone Number.

    Use Checksum

    Helps improve the recognition results if a Social Security Number is misread. (Default: Cleared)

    The Language must be set to English when the country is set to USA. For all other countries, set the language to French.

    Available when Field Type is set to Social Security Number.

    Country

    Select the relevant country from the list. (Default: USA)

    Available when Field Type is set to Social Security Number.

    Multiline Mode

    Select if there is a possibility the corresponding Field Type spans more than one line. (Default: Cleared)

    For example, a multiline address.

    Available for all Field Type values.

  7. On the Image Cleanup tab, configure the following settings.

    Setting

    Description

    Remove Noise

    When selected, noise such as stray lines or curves that extend into the zone from above, below, or the sides, is removed from the document image. (Default: Cleared)

    Correct Skew

    When selected, any crooked images are straightened as much as possible to improve the recognition results. (Default: Cleared)

    Remove Lines

    Depending on the document, removing lines improves recognition results. You can select from the following values:

    None:

    No lines are removed from the zone. (Default: Cleared)

    Vertical Lines:

    Removes vertical lines that are printed on the document from the zone.

    Horizontal Lines:

    Removes horizontal lines that are printed on the document from the zone.

    Vertical and Horizontal Lines:

    Removes both vertical and horizontal lines that are printed on a document from the zone.

    Vertical and Horizontal Dash Lines:

    Removes both vertical dash lines and horizontal dash lines that are printed on a document from the zone.

    Remove Boxes and Combs

    Depending on the document, removing boxes or combs can improve recognition results. You can select from the following values:

    None

    No boxes or combs are removed from the zone. (Default: Cleared)

    Box Around Whole Field

    The box is removed from around the zone.

    Box and Clean Around the Box

    The box and other lines, words, or marks that interfere with the box are removed from the zone.

    Combs

    The combs that appear around the individual characters are removed from the zone.

    Boxes Around Characters

    The boxes that appear around the individual characters are removed from the zone.

    Spaced Boxes Around Characters

    The spaced boxes that appear around individual characters are removed from the zone.

  8. Optional. Rename the new profile so it has a descriptive name.
  9. Optional. Select OK to close the Project Settings window.
  10. Save the changes to your project.