2023:Key-Value Pair (Collation Provider) - Revision history

Dgreenwood at 21:17, 27 August 2025

2025-08-27T21:17:50Z

← Older revision		Revision as of 16:17, 27 August 2025
Line 69:		Line 69:
	\|valign=top\|		\|valign=top\|
	# Name the '''Data Type'''. Here we are naming it "KVP - Home Phone"		# Name the '''Data Type'''. Here we are naming it "KVP - Home Phone"
	~~#* ''Visit the [[Asset Management]] article for our best practices guide to naming your extractors.''~~
	# Press the "OK" button to create it.		# Press the "OK" button to create it.
	\|		\|

Randallkinard at 21:21, 21 November 2024

2024-11-21T21:21:45Z

← Older revision		Revision as of 16:21, 21 November 2024
Line 293:		Line 293:
	</tab>		</tab>
	</tabs>		</tabs>

	~~== Glossary ==~~
	~~<u><big>'''Batch'''</big></u>: {{#lst:Glossary\|Batch}}~~

	~~<u><big>'''Collation Provider'''</big></u>: {{#lst:Glossary\|Collation Provider}}~~

	~~<u><big>'''Content Model'''</big></u>: {{#lst:Glossary\|Content Model}}~~

	~~<u><big>'''Data Type'''</big></u>: {{#lst:Glossary\|Data Type}}~~

	~~<u><big>'''Extract'''</big></u>: {{#lst:Glossary\|Extract}}~~

	~~<u><big>'''Key-Value List'''</big></u>: {{#lst:Glossary\|Key-Value List}}~~

	~~<u><big>'''Key-Value Pair'''</big></u>: {{#lst:Glossary\|Key-Value Pair}}~~

	~~<u><big>'''Labeled Value'''</big></u>: {{#lst:Glossary\|Labeled Value}}~~

	~~<u><big>'''List Match'''</big></u>: {{#lst:Glossary\|List Match}}~~

	~~<u><big>'''Node Tree'''</big></u>: {{#lst:Glossary\|Node Tree}}~~

	~~<u><big>'''Pattern Match'''</big></u>: {{#lst:Glossary\|Pattern Match}}~~

	~~<u><big>'''Project'''</big></u>: {{#lst:Glossary\|Project}}~~

	~~<u><big>'''Recognize'''</big></u>: {{#lst:Glossary\|Recognize}}~~

	~~<u><big>'''Reference'''</big></u>: {{#lst:Glossary\|Reference}}~~

	~~<u><big>'''Tab Marking'''</big></u>: {{#lst:Glossary\|Tab Marking}}~~

	~~<u><big>'''Value Reader'''</big></u>: {{#lst:Glossary\|Value Reader}}~~

Randallkinard at 14:58, 27 August 2024

2024-08-27T14:58:28Z

@@ Line 20: / Line 20: @@
 * [[Media:2023 Wiki Key-Value-Pair-(Collation-Provider) Batch.zip]]
 |}
 == About ==
@@ Line 326: / Line 293: @@
 </tab>
 </tabs>

Randallkinard at 15:09, 10 May 2024

2024-05-10T15:09:56Z

@@ Line 21: / Line 21: @@
 |}
 == About ==
 The ''Key-Value Pair'' Collation Provider utilizes the [[Data Context|spatial relationship]] between two related extractor results to return a single result, typically looking for a piece of data (the value) next to a label (the key).

Randallkinard at 15:51, 22 April 2024

2024-04-22T15:51:05Z

← Older revision		Revision as of 10:51, 22 April 2024
Line 8:		Line 8:

	[[file:kvp 1.png\|right\|border\|200px]]		[[file:kvp 1.png\|right\|border\|200px]]
	~~<section begin="glossary" />~~
	<blockquote>		<blockquote>{{#lst:Glossary\|Key-Value Pair}}</blockquote>
	''Key-Value Pair~~'' is a [[Collation Provider]] for '''[[Data Type]]''' extractors. It uses the layout relationship between a key and a value on a document to return a result.~~
	</blockquote>
	~~<section end="glossary" />~~
	''Key-Value Pair'' collation is one of the most commonly used Collation Providers. It provides an excellent way to extract data when a value exists next to a label on a document, whether next to it horizontally, vertically, or even in a "right-to-left & top-to-bottom" text flow.		''Key-Value Pair'' collation is one of the most commonly used Collation Providers. It provides an excellent way to extract data when a value exists next to a label on a document, whether next to it horizontally, vertically, or even in a "right-to-left & top-to-bottom" text flow.
	{\|class="download-box"		{\|class="download-box"

Dgreenwood at 20:45, 26 March 2024

2024-03-26T20:45:41Z

← Older revision		Revision as of 15:45, 26 March 2024
Line 14:		Line 14:
	<section end="glossary" />		<section end="glossary" />
	''Key-Value Pair'' collation is one of the most commonly used Collation Providers. It provides an excellent way to extract data when a value exists next to a label on a document, whether next to it horizontally, vertically, or even in a "right-to-left & top-to-bottom" text flow.		''Key-Value Pair'' collation is one of the most commonly used Collation Providers. It provides an excellent way to extract data when a value exists next to a label on a document, whether next to it horizontally, vertically, or even in a "right-to-left & top-to-bottom" text flow.
			{\|class="download-box"
			\|
			[[File:Asset 22@4x.png]]
			\|
			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-Pair-(Collation-Provider) Project.zip]]
			* [[Media:2023 Wiki Key-Value-Pair-(Collation-Provider) Batch.zip]]
			\|}


	== About ==		== About ==

Dgreenwood: /* How To */

2024-03-26T20:45:21Z

How To

← Older revision		Revision as of 15:45, 26 March 2024
Line 44:		Line 44:

	== How To ==		== How To ==

	~~{\|class="download-box"~~
	\|
	~~[[File:Asset 22@4x.png]]~~
	\|
	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-Pair-(Collation-Provider) Project.zip]]
	* [[Media:2023 Wiki Key-Value-Pair-(Collation-Provider) Batch.zip]]
	\|}

	=== Create A Key-Value Pair Extractor ===		=== Create A Key-Value Pair Extractor ===

Rpatton: zips // via Wikitext Extension for VSCode

2024-03-11T15:36:34Z

zips // via Wikitext Extension for VSCode

← Older revision		Revision as of 10:36, 11 March 2024
Line 44:		Line 44:

	== How To ==		== How To ==

			{\|class="download-box"
			\|
			[[File:Asset 22@4x.png]]
			\|
			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-Pair-(Collation-Provider) Project.zip]]
			* [[Media:2023 Wiki Key-Value-Pair-(Collation-Provider) Batch.zip]]
			\|}

	=== Create A Key-Value Pair Extractor ===		=== Create A Key-Value Pair Extractor ===

Dgreenwood at 15:42, 12 January 2024

2024-01-12T15:42:21Z

← Older revision		Revision as of 10:42, 12 January 2024
Line 155:		Line 155:
	\|}		\|}

	{\|~~cellpadding~~="~~10" cellspacing="5~~"		{\|class="fyi-box"
	\|~~-style="background-color:#36b0a7; color:white"~~		\|
	~~\|style="font-size:14pt"\|~~'''FYI'''\|\|It is possible to enable multiple '''''Layouts''''' and use multiple layouts on a single '''Data Type''', but do so with caution.		'''FYI'''
			\|
			It is possible to enable multiple '''''Layouts''''' and use multiple layouts on a single '''Data Type''', but do so with caution.

	If there is only a ''single'' key found by the "Key Extractor" (This is often the case), only a ''single'' result will return, using a single '''''Layout'''''. Be careful when enabling multiple '''''Layouts''''' as there is a certain order of operations when it comes to which layout is used first. It is as follows: First, the '''''Horizontal Layout's''''' result is returned. If there is no result from that layout, then the '''''Flow Layout's''''' result is returned. Last, if no other layouts produce results, the '''''Vertical Layout's''''' result is returned.		If there is only a ''single'' key found by the "Key Extractor" (This is often the case), only a ''single'' result will return, using a single '''''Layout'''''. Be careful when enabling multiple '''''Layouts''''' as there is a certain order of operations when it comes to which layout is used first. It is as follows: First, the '''''Horizontal Layout's''''' result is returned. If there is no result from that layout, then the '''''Flow Layout's''''' result is returned. Last, if no other layouts produce results, the '''''Vertical Layout's''''' result is returned.

Dgreenwood at 14:54, 12 January 2024

2024-01-12T14:54:38Z

← Older revision		Revision as of 09:54, 12 January 2024
Line 1:		Line 1:
	{{AutoVersion}}		{{AutoVersion}}
	{\|class="attn-box"		{\|class="attn-box"
	\|-		\|
	\|⚠		⚠
	\|		\|
	While '''''Key-Value Pair''''' can still be performed in Grooper 2023, it is generally much more efficient to utilize the '''''Labeled Value''''' functionality to get these results. Please see the [[Labeled Value]] article for more information on how to set up this alternative extractor.		While '''''Key-Value Pair''''' can still be performed in Grooper 2023, it is generally much more efficient to utilize the '''''Labeled Value''''' functionality to get these results. Please see the [[Labeled Value]] article for more information on how to set up this alternative extractor.
Line 221:		Line 221:
	:* Note: We set the '''''Maximum Distance''''' property back to blank. We're not cheating here.		:* Note: We set the '''''Maximum Distance''''' property back to blank. We're not cheating here.

	{\|~~cellpadding~~="~~10" cellspacing="5~~"		{\|class="attn-box"
	\|~~-style="background-color:#f89420; color:white"~~		\|
	~~\|style="font-size:14pt"\|'''~~⚠~~'''\|~~\|This will only work if the document has line location information in its folder or page's LayoutData.json file. This information must be obtained ''before'' the extractor runs via the [[Image Processing]] or [[Recognize]] activity.		⚠
			\|
			This will only work if the document has line location information in its folder or page's LayoutData.json file. This information must be obtained ''before'' the extractor runs via the [[Image Processing]] or [[Recognize]] activity.
	\|}		\|}
	\|		\|

← Older revision		Revision as of 16:21, 21 November 2024
Line 293:		Line 293:
	</tab>		</tab>
	</tabs>		</tabs>

	~~== Glossary ==~~
	~~<u><big>'''Batch'''</big></u>: {{#lst:Glossary\|Batch}}~~

	~~<u><big>'''Collation Provider'''</big></u>: {{#lst:Glossary\|Collation Provider}}~~

	~~<u><big>'''Content Model'''</big></u>: {{#lst:Glossary\|Content Model}}~~

	~~<u><big>'''Data Type'''</big></u>: {{#lst:Glossary\|Data Type}}~~

	~~<u><big>'''Extract'''</big></u>: {{#lst:Glossary\|Extract}}~~

	~~<u><big>'''Key-Value List'''</big></u>: {{#lst:Glossary\|Key-Value List}}~~

	~~<u><big>'''Key-Value Pair'''</big></u>: {{#lst:Glossary\|Key-Value Pair}}~~

	~~<u><big>'''Labeled Value'''</big></u>: {{#lst:Glossary\|Labeled Value}}~~

	~~<u><big>'''List Match'''</big></u>: {{#lst:Glossary\|List Match}}~~

	~~<u><big>'''Node Tree'''</big></u>: {{#lst:Glossary\|Node Tree}}~~

	~~<u><big>'''Pattern Match'''</big></u>: {{#lst:Glossary\|Pattern Match}}~~

	~~<u><big>'''Project'''</big></u>: {{#lst:Glossary\|Project}}~~

	~~<u><big>'''Recognize'''</big></u>: {{#lst:Glossary\|Recognize}}~~

	~~<u><big>'''Reference'''</big></u>: {{#lst:Glossary\|Reference}}~~

	~~<u><big>'''Tab Marking'''</big></u>: {{#lst:Glossary\|Tab Marking}}~~

	~~<u><big>'''Value Reader'''</big></u>: {{#lst:Glossary\|Value Reader}}~~