Dgreenwood at 21:41, 27 August 2025

2025-08-27T21:41:40Z

← Older revision		Revision as of 16:41, 27 August 2025
Line 51:		Line 51:
	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 '''''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~~.		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.

	<br>		<br>

Dgreenwood: Created page with "{{AutoVersion}}
{{#lst:Glossary|List Match}}
{|class="download-box" | File:Asset 22@4x.png | 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. * Media:2024 Wiki List-Match Batch.zip * Media:2024 Wiki List-Match Project..."

2025-08-27T20:45:41Z

Created page with "{{AutoVersion}} <blockquote>{{#lst:Glossary|List Match}}</blockquote> {|class="download-box" | File:Asset 22@4x.png | 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. * Media:2024 Wiki List-Match Batch.zip * Media:2024 Wiki List-Match Project..."

New page

{{AutoVersion}}

<blockquote>{{#lst:Glossary|List Match}}</blockquote>

{|class="download-box"
|
[[File:Asset 22@4x.png]]
|
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.
* [[Media:2024 Wiki List-Match Batch.zip]]
* [[Media:2024 Wiki List-Match Project.zip]]
|}

==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====
# 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''.

[[File:2023-List Match-How To 01.png]]

====Configuring on a Data Type====
# 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''.

[[File:2023-List Match-How To 02.png]]

====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.

<br>
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====
# 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.

[[File:2023-List Match-How To 03.png]]

#<li value=3> 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 (<code>\t</code>) make sure '''''Tab Marking''''' is set to ''Enabled'' under '''''Preprocessing''''' in your "Properties" tab.
# Save and test your extraction.

[[File:2023-List Match-How To 04.png]]

====Referencing Lexicons====
# 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.

[[File:2023-List Match-How To 05.png]]

# <li value=3>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'''.

[[File:2023-List Match-How To 08.png]]

#<li value=5> 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'''.

[[File:2023-List Match-How To 06.png]]

#<li value=7> Save and test your extraction.

[[File:2023-List Match-How To 07.png]]

==See Also==
* [[Value Reader]]
* [[Pattern Match]]

2024:List Match (Value Extractor) - Revision history

Dgreenwood at 21:41, 27 August 2025