Pattern Match (Extractor Type)

⚠	This article was migrated from an older version and has not been updated for the current version of Grooper. This tag will be removed upon article review and update.

This article is about the current version of Grooper.

Note that some content may still need to be updated.

2025

2023

Pattern Match is an Extractor Type that extracts values from a document that match a specified regular expression, providing data collection following a known format or pattern.

You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023). 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

Pattern Match is one of the most commonly used extractors. As per its name, it extracts data from a document matching a regex pattern entered into the Value Pattern.

This extractor is useful when you want to extract text data matching a particular pattern across a document, such as dates or social security numbers. For example, the format MM/DD/YYYY can be matched with the regex pattern: \d{2}/\d{2}/\d{4}.

For more information on regex, click the following link: RegexOne

How To

Pattern Match can be configured on both Data Type and Value Reader objects.

Configuring by Object Type

Configuring on a Value ReaderConfiguring on a Data TypeConfiguring on Other Object Types

Configuring on a Value Reader

Create or select your Value Reader. Note the three tabs: "Value Reader", "Tester", and "Advanced". Select the "Value Reader" tab. Select the drop-down icon on the far right to the far right of the Extractor property.
On the drop-down menu, select Pattern Match.
Click the "Tester" tab. In the Value Pattern box, enter the regex pattern for the text you wish to extract. Matched data will be highlighted in green and show up in the "Values" panel beneath the Document Viewer.
Save changes.

Configuring on a Data Type

The Data Type is a little more involved when picking out Pattern Match.

Create or select your Data Type. Select the drop-down icon to the far right of Local Extractor.
Select Pattern Match from the dropdown menu.
Select the ellipses to the far right of the Local Extractor.
This will bring up the Extractor Editor window Enter a pattern for the text you would like to extract. Just like with the Value Reader, matched data will be highlighted in green and appear in the "Values" panel beneath the Document Viewer. Once you've entered your pattern, and are satisfied with the results, click "OK".
Save changes.

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

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

Examples where you can use a Pattern Match include:

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

Click here to return to the top of the section

Regex Examples for Pattern Match

Social Security Numbers/Employer Identification NumbersDatesCurrency

Social Security Numbers (SSN)/Employer Identification Numbers (EIN)

SSNs and EINs are simple. As usual, note the type of number used. A SSN is structured ###-##-####, and an EIN is ##-#######. Simply enter the pattern of the data you wish to extract.

SSN: `\d{3}-\d{2}-\d{4}`
EINs will be: `\d{2}-\d{7}`.

Dates

Take note of the format of the date(s) on the document. The document here has dates in both the MM/DD/YYYY and MM/DD/YY format. Thus, we will write a regex pattern that will extract both dates.

First, enter
- \d{2}/\d{2}/\d{4}
Notice that only the first date was returned.

Now try:
- \d{2}/\d{2}/\d{2}
Kind of picks up both, except that the last two digits in the year of the first date aren't returned. So, this regex pattern won't work either.

So, how are we going to return both dates completely? Keep in mind that you can dictate a range of values within the curly braces. Hence:
- \d{2}/\d{2}/\d{2,4}
  - \d{2,4} tells Grooper to look for anywhere from two to four digits for the year. Since YY and YYYY fall within the range set, the regex pattern will extract them.
Notice that both dates are now being returned in full.

Currency

One of the most important things about currency values is to note the amounts listed—hundreds of dollars, thousands of dollars, as well as cent amounts and dollar signs. If dollar signs are provided, precede them with a backslash, \$, as the dollar sign by itself represents the end of a string in regex. Also, when writing pattern matches for currency, look for both the largest and smallest amounts provided, as this will determine the range for the placeholders.

For this example, you will build a pattern that will match all currency data listed.

To extract the first three data instances, enter the following pattern: `\$\d{1,3}\.\d{2}` Notice that the dollar sign has been escaped by the backslash, as it is part of the text data.
To extract the three remaining instances, look at the way they're written. Anywhere from one (1) to three (3) digits after the dollar sign, three (3) digits after the comma, and cent amounts provided. Thus, your regex pattern should look like this: `\$\d{1,3},\d{3}\.\d{2}` Note that while the last three pieces of date are matched, the first three are no longer being picked up.
Thus, to return all data, add parenthesis around `,\d{3}` and follow with a question mark: `\$\d{1,3}(,\d{3})?\.\d{2}` By encasing `,\d{3}` in parenthesis, you've created a Capture Group. For more information on Capture Groups, click here: RegexOne The question mark is a Lazy Quantifier, meaning that its job is to collect one to many instances of the data immediately preceding (or following) it. In this case, it will catch one to many instances of the `,\d{3}` Capture Group. If you're unsure of how large your currency amounts will be, you can substitute the question mark `?` with a star `` character. `\$\d{1,3}(,\d{3})\.\d{2}` The star is another quantifier, designed to capture zero to many instances of preceding data. For more information on quantifiers, click here: [RegexOne]

Click here to return to the top of the section

Prefix and Suffix Patterns

Prefix and Suffix Patterns act as anchors to which you can tether the data you wish to extract. As one would expect, a Prefix Pattern matches what comes before your text matched by regex pattern, a Suffix Pattern is concerned with what comes after.

For example, let's say that you want to extract data on its own line, like the title of a section. While you can enter just the title, you might get false positives if the word(s) that make up the title appear anywhere else on the document. Thus, your Prefix and Suffix Patterns will be:

Prefix Pattern:[\n\t]|^

Suffix Pattern:[\r\t]|$

The ^ character matches the beginning of a string of text.
The $ character matches the end of a string of text.