Value Reader

Defines a primitive data extraction operation.

Remarks

The Value Reader is a foundational extraction object in Grooper, used to define how values are extracted from document content. Value Readers are referenceable objects that encapsulate a Value Extractor and can be reused by multiple extraction elements, such as Data Fields, Data Types, or Field Classes.

Overview

• Value Readers are created as children of a Project or the "Local Resources" folder of a Content Type.
• They allow you to configure and test extraction logic in a single, reusable location.
• Value Readers do not perform extraction on their own; they must be referenced by another object.

Configuration

• The main property to configure is 'Extractor', which determines the extraction method (such as pattern matching, OMR, barcode, or zonal extraction).
• Once an extractor type is selected, additional configuration options become available, tailored to the chosen method.
• The 'Tester' tab provides a dynamic panel for configuring and testing the extractor, along with viewers for batch, document, and results.

Usage Scenarios

• Pattern Matching:
  Extract values using regular expressions or lists of known values.
• OMR (Optical Mark Recognition):
  Extract checkbox or bubble values from forms.
• Barcode Extraction:
  Read values encoded in barcodes on the document.
• Zonal Extraction:
  Extract text from a specific region of the page.
• Reference Extraction:
  Reuse extraction logic from another Value Reader, Data Type, or Field Class.

Best Practices

• Use Value Readers to centralize and reuse extraction logic across multiple fields or document types.
• Test and refine extraction settings using the built-in tester before referencing the Value Reader in production extraction elements.
• Choose the extractor type that best matches your data and document structure.

Properties

Name	Type		Description
Extractor	Value Extractor	►	Specifies the Value Extractor used to perform data extraction. EditorEditor ConverterConverter Requiredtrue 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. The Extractor property determines the extraction logic for this Value Reader. Select an extractor type to define how values are found in document content. Extractor types include pattern matching, OMR (optical mark recognition), barcode reading, zonal extraction, and reference extraction. When set to 'none', a drop-down menu of available extractor types is shown. After selecting a type, an ellipsis button opens a dialog with configuration panels for the chosen extractor. The dialog includes a dynamic panel for extractor-specific settings, as well as viewers for batch, document, and results. Configuration properties for the selected extractor are also available as sub-properties of this property. Extractor Type Categories Text Parsing Extractors: Use regular expressions, value lists, or text parsing to extract values (e.g., Pattern Match, List Match). OMR Extractors: Extract values from checkboxes or bubbles using optical mark recognition (e.g., Labeled OMR, Ordered OMR). Barcode Extractors: Read values encoded in barcodes (e.g., Find Barcode, Read Barcode). Zonal Extractors: Extract text from a defined region of the page (e.g., Highlight Zone, Read Zone). Reference Extractor: Return results from another Value Reader, Data Type, or Field Class. > Note: > Once the extractor type is changed from 'none', the property must be reset before another type can be selected.
Description	String	►	Specifies a description for the item. EditorNode Description Editor

Design Tabs

General	View or edit properties of a node.
Reports	View reports for a node.
Tester	Test an Extractor Node on documents in a test batch.
Advanced	View or edit advanced details about a node.

Context Menu Commands

Command	Shortcut	Description
pin Convert To Data Type		Converts this Value Reader to a Data Type with equivalent functionality.

See Also

Value Extractor

Used By

ReferenceRender