List Match (Extractor Type)

From Grooper Wiki
(Redirected from List Match)

This article is about the current version of Grooper.

Note that some content may still need to be updated.

2025 2023

List Match is an Extractor Type designed to return values matching one or more items in a defined list. By default, the List Match extractor does not use or require regular expression, but can be configured to utilize regular expression syntax.

You may download the ZIP(s) below and upload it into your own Grooper environment (version 2024). The first contains one or more Batches of sample documents. The second contains one or more Projects with resources used in examples throughout this article.

About

The List Match is one of the the simplest extractors used in Grooper. It is designed to return values matching one or more items in a defined list. This can be used to specific words or full phrases contained within a document. A List Match extractor returns an exact match including any spaces, numbers, punctuation, or special characters.

To configure a List Match, you can input the desired extracted value as a Local Entry or reference a pre-configured Lexicon.

Unlike a Pattern Match, the List Match extractor does not use or require regular expressions by default, but regex can be enabled in the properties menu. Similar to a Pattern Match, Suffix and Prefix Patterns can be added to help anchor the list item and limit the amount of false positives extracted.

How To

A List Match is most commonly used when configuring objects such as Value Readers or Data Types. It is great for extracting text information such as:

  • Specific company names
  • Field labels
  • Headers and Footers
  • Full phrases
  • Exact numbers

If the information you need to extract follows a specific pattern, such as a date or social security number, then it may be better to consider a different extractor like a Pattern Match.

Configuring by Object Type

Configuring on a Value Reader

  1. In your Node Tree, create or select a Value Reader.
    • Visit the Value Reader Wiki Page for instructions on how to create a Value Reader.
  2. Select the "Value Reader" tab.
  3. Click the drop down list next to Extractor and select List Match.

Configuring on a Data Type

  1. In your Node Tree, create or select a Data Type.
    • Visit the Data Type Wiki Page for instructions on how to create a Data Type.
  2. Select the "Data Type" tab.
  3. Click the drop down list next to Local Extractor and select List Match.

Configuring on Other Object Types

The List Match extractor can be used on a multitude of object types. Any object that has an extractor property can be configured with a List Match.

The configuration process on other objects is identical to both the Value Reader and Data Type objects. Simply select a List Match as your extractor type.


Examples where you can use a List Match include:

  • A Data Type's Value Extractor property
  • A Document Type's Positive Extractor property
  • The Labeled Value extractor's Label Extractor property
  • The Pattern-Based Separation Provider's Value Extractor property

Local Entries vs Lexicons

A List Match can be configured using a Local Entry or a Lexicon. Local Entries are simple and easy to set up, especially if you only need to add a few entries. If you plan to extract a large number of items from a list or plan on building multiple extractors using the same list, it might be more efficient to set up a Lexicon to reference first.

Configuring Local Entries

  1. For Value Readers, select the object you wish to configure and click "Tester" tab.
    • When configuring a Data Type, first click the ellipsis button at the end of the Local Extractor property with List Match selected to bring up the editing window.
  2. Make sure the "Expressions" sub-tab is selected.


  2. Under LOCAL ENTRIES, type the desired text to be extracted.
    • Hit Enter after each entry to extract multiple list items under one List Match.
  3. If needed, add a Prefix and Suffix Pattern to anchor your extraction to a regex pattern.
    • When using tabs as an anchor (\t) make sure Tab Marking is set to Enabled under Preprocessing in your "Properties" tab.
  4. Save and test your extraction.

Referencing Lexicons

  1. For Value Readers, select the object you wish to configure and click the "Tester" tab.
    • When configuring a Data Type, click the ellipsis button at the end of the Local Extractor property with List Match selected to bring up the editing window before continuing to the next step.
  2. Select the "Properties" tab.


  2. Click the arrow next to the Vocabulary property to expand its sub-properties.
  3. Click the ellipsis button at the end of the Included Lexicons property. This will open a new window where you can add pre-configured Lexicons.


  2. In the new window, click through the Projects and Folders until you find the desired Lexicon. Click the check boxes next to the desired Lexicons.
  3. Click OK to apply the Lexicons.


  2. Save and test your extraction.

See Also

Retrieved from "https://wiki.grooper.com/index.php?title=List_Match_(Extractor_Type)&oldid=26940"