2023:List Match (Value Extractor)

WIP	This article is a work-in-progress or created as a placeholder for testing purposes. This article is subject to change and/or expansion. It may be incomplete, inaccurate, or stop abruptly. This tag will be removed upon draft completion.

A List Match is an extractor type that can be used when configuring several data extraction tools such as a Value Reader or Data Type. It is 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 expressions (regex).

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 extract numbers, 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 expression 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 ReaderConfiguring on a Data Type

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. Select the "Value Reader" tab. Click the drop down list next to Extractor and select List Match.

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. Select the "Data Type" tab. Click the drop down list next to Local Extractor and select List Match.

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 EntriesReferencing Lexicons

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. Make sure the "Expressions" sub-tab is selected.
Under LOCAL ENTRIES, type the desired text to be extracted. Hit Enter after each entry to extract multiple list items under one List Match. 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. Save and test your extraction.

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. Select the "Properties" tab and click the arrow next to the Vocabulary property to expand its sub-properties. 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.
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. Click OK to apply the Lexicons.
Save and test your extraction.

See Also

• Value Reader
• Pattern Match