2023.1:Pattern-Based Separation (Separation Provider)

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.

Pattern-Based Separation is a Separation Provider that creates a new document folder every time a value returned by a defined pattern is encountered on a page.

About

The Pattern-Based Separation Provider separates documents based on whether or not a defined pattern returns a value from a page in your Batch.

A Data Extractor is used to find a value on a page. When the extractor returns a result on a page, the page is placed in a new folder, creating a new document. If the extractor does not return a result on the following page, that page is included behind the previous page in the newly created folder. Once the extractor does produce a result on a subsequent page (even if it is the same result as the previous page) it will be placed in a new folder, creating a new document.

How To

Simple Example

1. Add a Separate Batch Process Step to your Batch Process.
2. Set the Provider property to Pattern-Based Separation.

1. When the "Provider" window pops up, click the hamburger icon next to the Value Extractor property to access the drop-down menu and select a value extractor.
2. For this tutorial we are going to use a List Match, but you can use any value extractor you wish.

1. Once your extractor is selected, click the ellipsis button to the right of the property.

1. When the "Value Extractor" window pops up, configure your extractor. Here we have entered in the titles located on the first page of each document.
2. Click "OK" in the top right of the window when you are finished configuring your extractor.

1. Click "OK" on the "Provider" window to save your changes.

1. Click over to the "Activity Tester" tab to test separation.
2. Select the Batch Folder in the Batch Viewer.
3. Click the play button in the top right corner of the Batch Viewer to test.

1. In the screenshot below, you can see that Grooper has created folders and separated the documents appropriately.