Auto Complete Settings

When enabled, provides pop-up completion lists during field editing.

Remarks

Defines how autocomplete suggestions are presented and managed for a Data Field during user entry.

Overview

When assigned to a Data Field, this object enables a pop-up list of suggestions as the user types. Suggestions can be sourced from:

• Values extracted from the document using a Value Extractor (set via 'Entry Extractor').
• Pre-defined entries in a Lexicon (set via 'Entry Lexicon').
• User-provided values, which can be stored for future suggestions (controlled by 'User Training' and 'Training Lexicon').
• Recently used values, tracked per field type.

Key Features

• Dynamic Suggestions: Use a Value Extractor to populate suggestions from the current document's content.
• Static Suggestions: Reference a Lexicon to provide a managed list of allowed or recommended values.
• User Training: Allow users to add new values to the autocomplete list, either manually or automatically, and optionally store them in a separate Lexicon.
• Browser Integration: Control browser-level autocomplete behavior using 'Suggest Mode', which maps to the HTML autocomplete attribute.
• Highlighting: Optionally highlight values entered manually by users in the document view.
• MRU (Most Recently Used): Maintains a per-type list of recently used values to prioritize common entries.

Configuration Guidance

• Assign an AutoCompleteSettings object to a Data Field via the 'AutoComplete' property.
• Set 'Entry Extractor' to extract suggestions from document content, or 'Entry Lexicon' to use a static list.
• Enable 'User Training' to allow users to add new entries, and specify 'Training Lexicon' if user entries should be stored separately from the main Lexicon.
• Adjust 'Suggest Mode' to control browser-level suggestions (e.g., disable for sensitive fields).
• Enable 'Auto Highlight' to visually mark new user-entered values in the document.

Example Use Cases

• Invoice Number Field: Use a Value Extractor to suggest invoice numbers found in the document, and allow users to add missing numbers to the Lexicon.
• State/Province Field: Reference a Lexicon of valid states, and disable user training to restrict input to known values.
• Name Field: Enable browser suggestions for previously entered names, and allow user training for new names.

Related Types

• Value Extractor: Used to extract dynamic suggestions from document content.
• Lexicon: Stores static or user-trained autocomplete entries.
• Data Field: The field to which these settings are applied.

For best results, configure the properties to match the data entry needs and security requirements of your field.

Properties

Name	Type		Description
Entry Extractor	Value Extractor	►	An extractor which captures autocomplete entries from the text content of the document. EditorEditor ConverterConverter Can be one of the following types: Value Description Reference Delegates extraction to another configured extractor, enabling reuse and centralization of extraction logic. AI Column Extractor Extracts structured content from documents with two-column layouts. Ask AI Executes a completion using a large language model (LLM) and returns one hit for each choice in the response. Detect Signature Detects a signature within a specified region of a document page by measuring the percentage of the area that is filled. Entity Recognition Identifies and categorizes entities such as people, organizations, locations, and quantities in unstructured text. Field Match Matches the value stored in a previously-extracted field or table column. Find Barcode Searches for barcode values in document Layout Data previously detected during image processing. Highlight Zone Defines a region of a document to be visually highlighted, without extracting any data values. Key Phrase Extraction Identifies key concepts and topics in text using Azure AI Language key phrase extraction. Label Match Matches a list of one or more label values, using matching options defined by a Labeling Behavior. Labeled OMR Reads a group of one or more checkboxes located nearby text labels. Labeled Value Extracts a field presented as a label-value pair within a document, associating labels and values based on their spatial relationship. List Match Extracts values from document text that match any entry in a list of search terms. Ordered OMR Reads one or more checkboxes with a consistent order of appearance inside a rectangular region. Pattern Match Extracts values from document text that match a specified regular expression pattern. Pii Entity Recognition Identifies, categorizes, and redacts sensitive information (PII) in unstructured text using Azure AI Language Services. Query HTML Extracts values from an HTML document using a CSS or XPath selector. Query XML Extracts values from XML documents using XPATH queries, enabling structured data extraction from XML content in Grooper. Read Barcode Extracts barcode values from document images using configurable barcode recognition. Read Metadata Reads a metadata value from a document by accessing a property on an attachment or content link. Read Zone Extracts text content from a specified rectangular region (zone) of a document. Select Page Selects and outputs the full content of one or more pages from a document, based on page number and/or content criteria. Word Match Extracts individual words and multi-word phrases (N-grams) from document text for use in classification, data extraction, and normalization. Zonal OMR Reads one or more checkboxes using manually-configured zones. Set this property to a Value Extractor to dynamically generate autocomplete suggestions from the current document's content. This is useful for fields where likely values can be found within the document itself, such as invoice numbers, names, or codes. If not set, suggestions will be limited to those provided by the 'Entry Lexicon', user training, and recent values.
Entry Lexicon	Lexicon	►	A lexicon containing pre-defined autocomplete entries. EditorNode Reference Editor Assign a Lexicon to provide a static or managed list of suggestions for this field. The Lexicon can be populated with allowed or recommended values, such as a list of states, departments, or product codes. If both 'Entry Extractor' and 'Entry Lexicon' are set, suggestions from both sources will be combined.
Suggest Mode	BrowserSuggestMode	►	Enables or disables browser autocomplete suggestions based on previous user input. Defaultoff Can be one of the following values: Name Value Description off 0 The browser is not permitted to automatically enter or select a value for this field. on 1 The browser is allowed to automatically complete the input. No guidance is provided as to the type of data expected in the field, so the browser may use its own judgement. name 2 The field expects the value to be a person's full name. honorific_prefix 3 The prefix or title, such as "Mrs.", "Mr.", "Miss", "Ms.", "Dr.", or "Mlle.". given_name 4 The given (or "first") name. additional_name 5 The middle name. family_name 6 The family (or "last") name. honorific_suffix 7 The suffix, such as "Jr.", "B.Sc.", "PhD.", "MBASW", or "IV". nickname 8 A nickname or handle. email 9 An email address. username 10 A username or account name. new_password 11 A new password. current_password 12 The user's current password. one_time_code 13 A one-time code used for verifying user identity. organization_title 14 A job title, or the title a person has within an organization, such as "Senior Technical Writer", "President", or "Assistant Troop Leader". organization 15 A company or organization name, such as "Acme Widget Company" or "Girl Scouts of America". street_address 16 A street address. This can be multiple lines of text, and should fully identify the location of the address within its second administrative level (typically a city or town), but should not include the city name, ZIP or postal code, or country name. address_line1 17 The first line of the street address. These should only be present if the "street-address" is not present. address_line2 18 The second line of the street address. These should only be present if the "street-address" is not present. address_line3 19 The third line of the street address. These should only be present if the "street-address" is not present. address_level4 20 The finest-grained administrative level, in addresses which have four levels. address_level3 21 The third administrative level, in addresses with at least three administrative levels. address_level2 22 The second administrative level, in addresses with at least two of them. In countries with two administrative levels, this would typically be the city, town, village, or other locality in which the address is located. address_level1 23 The first administrative level in the address. This is typically the province in which the address is located. In the United States, this would be the state. In Switzerland, the canton. In the United Kingdom, the post town. country 24 A country or territory code. country_name 25 A country or territory name. postal_code 26 A postal code (in the United States, this is the ZIP code). cc_name 27 The full name as printed on or associated with a payment instrument such as a credit card. Using a full name field is preferred, typically, over breaking the name into pieces. cc_given_name 28 A given (first) name as given on a payment instrument like a credit card. cc_additional_name 29 A middle name as given on a payment instrument or credit card. cc_family_name 30 A family name, as given on a credit card. cc_number 31 A credit card number or other number identifying a payment method, such as an account number. cc_exp 32 A payment method expiration date, typically in the form "MM/YY" or "MM/YYYY". cc_exp_month 33 The month in which the payment method expires. cc_exp_year 34 The year in which the payment method expires. cc_csc 35 The security code for the payment instrument; on credit cards, this is the 3-digit verification number on the back of the card. cc_type 36 The type of payment instrument (such as "Visa" or "Master Card"). transaction_currency 37 The currency in which the transaction is to take place. transaction_amount 38 The amount, given in the currency specified by "transaction-currency", of the transaction, for a payment form. language 39 A preferred language, given as a valid BCP 47 language tag bday 40 A birth date, as a full date. bday_day 41 The day of the month of a birth date. bday_month 42 The month of the year of a birth date. bday_year 43 The year of a birth date. sex 44 A gender identity (such as "Female", "Fa'afafine", "Male"), as freeform text without newlines. tel 45 A full telephone number, including the country code. tel_country_code 46 The country code, such as "1" for the United States, Canada, and other areas in North America and parts of the Caribbean. tel_national 47 The entire phone number without the country code component, including a country-internal prefix. For the phone number "1-855-555-6502", this field's value would be "855-555-6502". tel_area_code 48 The area code, with any country-internal prefix applied if appropriate. tel_local 49 The phone number without the country or area code. tel_extension 50 A telephone extension code within the phone number, such as a room or suite number in a hotel or an office extension in a company. impp 51 A URL for an instant messaging protocol endpoint, such as "xmpp:username@example.net". url 52 A URL, such as a home page or company web site address as appropriate given the context of the other fields in the form. photo 53 The URL of an image representing the person, company, or contact information given in the other fields in the form. Corresponds directly to the HTML autocomplete attribute.
User Training	UserTrainingMode	►	Specifies whether review users may interactively train the list of auto complete entries. DefaultDisabled Can be one of the following values: Name Value Description Disabled 0 User training of the autocomplete list is disabled. Manual 1 User will be allowed to manually add autocomplete entries. Auto 2 The autocomplete list will be automatically updated any time the user enters or edits the field value.
Training Lexicon	Lexicon	►	The lexicon to which user training should be added. EditorNode Reference Editor If set, new values added by users (via user training) will be stored in this Lexicon instead of the main 'Entry Lexicon'. This allows you to keep user-provided values separate from the main list of suggestions, which can be useful for review or curation. If not specified, user training entries are added to the 'Entry Lexicon'.
Auto Highlight	Boolean	►	Controls whether manually-entered values are automatically highlighted on the document. DefaultFalse When enabled, any value entered by a user that is not already present in the autocomplete list will be visually highlighted in the document view. This helps reviewers quickly identify new or unusual entries that may require attention or validation.

See Also

Value ExtractorLexicon

Used By

Data ColumnData Field