2023.1:Key-Value List (Collation Provider): Difference between revisions

From Grooper Wiki
Newer edit →
Created page with "{{AutoVersion}} {|class="wip-box" | '''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. |} <blockquote> 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 relations..."
Tag: visualeditor-switched
 
How To start // via Wikitext Extension for VSCode
Line 23: Line 23:
|}
|}


{{#lst:Grooper Colloquialisms|Glossary}}
== About ==
 
== How To ==
 
# Create a '''Data Type''' with two child '''Value Readers''': one for the Key, and one for the Value.
 
[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 01.png]]
 
 
#<li value=2> Set your '''''Extractor''''' property for the Key '''Value Reader'''. In this example we have set it to a ''List Match''.
 
[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 02.png]]
 
 
#<li value=3> Configure the extractor to return the label of your list.
 
[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 03.png]]
 
 
#<li value=4> Set your '''''Extractor''''' property for the Value '''Value Reader'''. In this example we have set it to a ''Pattern Match''.
 
[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 04.png]]
 
 
#<li value=5> Configure your extractor to return all text you are wanting to collect near your label.
#* It is fine if the extractor collects mroe than just the terms you want to return. Here we are collecting all generic text on the page.


== About ==
[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 05.png]]
 
 
#<li value=6> Click back on the parent '''Data Type'''.
# The '''''Collation''''' property by default is set to ''Individual''.
# Each text segment extracted by the child objects will be returned individually.
 
[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 06.png]]
 
 
#<li value=9> Change the '''''Collation''''' to a ''Key-Value List''.
# 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.
# Now only the desired list is returned.
 
[[File:2023.1 Key-Value-List-(Collation-Provider) 02 Key-Value-List-Configuration 07.png]]

Revision as of 15:51, 16 April 2024

This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

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

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.

About

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.


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


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


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


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


  2. Change the Collation to a Key-Value List.
  3. 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.
  4. Now only the desired list is returned.

Retrieved from "https://wiki.grooper.com/index.php?title=2023.1:Key-Value_List_(Collation_Provider)&oldid=21225"