2023.1:Key-Value List (Collation Provider)

This article is about an older version of Grooper. Information may be out of date and UI elements may have changed.
2025	2023.1

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 Key-Value List is one of many Collation Providers you can use in Grooper to combine or organize extracted data based on the data's layout relationship. A Key-Value List collects a "list" of information with a spatial relationship to a label or a "Key".

You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023). The first contains a Project with resources used in examples throughout this article. The second contains one or more Batches of sample documents. Media:2023 Wiki Key-Value List Project.zip Media:2023 Wiki Key-Value List Batches.zip

How To

1. Create a Data Type with two child Value Readers: one for the Key, and one for the Value.

2. Set your Extractor property for the Key Value Reader. In this example we have set it to a List Match.

3. Configure the extractor to return the label of your list.

4. Set your Extractor property for the Value Value Reader. In this example we have set it to a Pattern Match.

5. Configure your extractor to return all text you are wanting to collect near your label.
   • It is fine if the extractor collects more than just the terms you want to return. Here we are collecting all generic text on the page.

6. Click back on the parent Data Type.
7. The Collation property by default is set to Individual.
8. Each text segment extracted by the child objects will be returned individually.

9. Change the Collation to a Key-Value List.
10. Choose the appropriate layout for the data you are collecting. Since the list in our example is aligned vertically, we are enabling the Vertical Layout property.
11. Now only the desired list is returned.

Key-Value Lists and Data Tables

1. We have created a Data Type with multiple child extractors to collect information on a table.
2. The Data Type is configured with an Ordered Array.
3. For this page in the Batch, this configuration works just fine. We are collecting all rows in the table.

4. However, for this table, our current configuration falls short.