2023.1:Combine (Collation Provider) - Revision history

Randallkinard at 17:49, 21 November 2024

2024-11-21T17:49:29Z

← Older revision		Revision as of 12:49, 21 November 2024
Line 220:		Line 220:

	[[File:2023.1 Combine-(Collation-Provider) 02 06 Group 05.png]]		[[File:2023.1 Combine-(Collation-Provider) 02 06 Group 05.png]]

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

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

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

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

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

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

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

Randallkinard: Randallkinard moved page Combine (Collation Provider) to 2023.1:Combine (Collation Provider)

2024-08-28T13:24:33Z

Randallkinard moved page Combine (Collation Provider) to 2023.1:Combine (Collation Provider)

← Older revision	Revision as of 08:24, 28 August 2024
(No difference)

Randallkinard at 14:22, 26 August 2024

2024-08-26T14:22:39Z

@@ Line 11: / Line 11: @@
 * [[Media:2023.1 Wiki Combine Project.zip]]
 |}
 == About ==
 The '''''Combine''''' '''''Collation Provider''''' is helpful when there are multiple text segments on a document that you wish to return as one result. There are many different ways to combine your results through different '''''Combine Methods'''''.
@@ Line 236: / Line 220: @@
 [[File:2023.1 Combine-(Collation-Provider) 02 06 Group 05.png]]

Randallkinard at 17:30, 3 May 2024

2024-05-03T17:30:59Z

@@ Line 11: / Line 11: @@
 * [[Media:2023.1 Wiki Combine Project.zip]]
 |}
 == About ==

Randallkinard at 15:52, 22 April 2024

2024-04-22T15:52:10Z

← Older revision		Revision as of 10:52, 22 April 2024
Line 1:		Line 1:
	{{AutoVersion}}		{{AutoVersion}}

	<blockquote>		<blockquote>{{#lst:Glossary\|Combine}}</blockquote>
	~~The '''''~~Combine~~''''' [[Collation Provider\|collation provider]] takes individual results and "combines" them into one. There are several methods by which Grooper can obtain these results and combine them.~~
	</blockquote>

	{\|class="download-box"		{\|class="download-box"

Rpatton: final // via Wikitext Extension for VSCode

2024-04-11T15:34:16Z

final // via Wikitext Extension for VSCode

← Older revision		Revision as of 10:34, 11 April 2024
Line 28:		Line 28:


	<big>'''Individual'''</big>		<big>'''[[#The Individual Combine Method\|Individual]]'''</big>

	The '''''Combine Method''''' is set to ''Individual'' by default when using '''''Combine''''' for your '''''Collation Provider'''''. Grooper simply will take the individual results from a '''Data Type's''' child objects and put them all together into one result one right after the other.		The '''''Combine Method''''' is set to ''Individual'' by default when using '''''Combine''''' for your '''''Collation Provider'''''. Grooper simply will take the individual results from a '''[[image:GrooperIcon_DataType.png]]Data Type's''' child objects and put them all together into one result one right after the other.


	<big>'''Sum'''</big>		<big>'''[[#The Sum Combine Method\|Sum]]'''</big>

	The ''Sum'' '''''Combine Method''''' takes numeric results from a '''Data Type's''' child objects and adds them up. The sum of those numbers is returned as a single result.		The ''Sum'' '''''Combine Method''''' takes numeric results from a '''Data Type's''' child objects and adds them up. The sum of those numbers is returned as a single result.

	There are more practical and efficient ways to sum up numeric data from a document such as '''''Calculated Value'''''. It is not advised to use the ''Sum'' '''''Combine Method''''' unless absolutely necessary and is primarily used for repositories upgraded from previous versions of Grooper.		There are more practical and efficient ways to sum up numeric data from a document such as the '''''Calculated Value''''' function. It is not advised to use the ''Sum'' '''''Combine Method''''' unless absolutely necessary and is primarily used for repositories upgraded from previous versions of Grooper.


	<big>'''Flow'''</big>		<big>'''[[#The Flow Combine Method\|Flow]]'''</big>

	The ''Flow'' '''''Combine Method''''' returns everything within the "flow" of the text of the document from whatever is returned in between the '''Data Type's''' first and second child objects. The full text is returned as a single result.		The ''Flow'' '''''Combine Method''''' returns everything within the "flow" of the text of the document from whatever is returned in between the '''Data Type's''' first and second child objects. The full text is returned as a single result.


	<big>'''Geometric'''</big>		<big>'''[[#The Geometric Combine Method\|Geometric]]'''</big>

	The ''Geometric'' '''''Combine Method''''' requires multiple child objects that return text in multiple areas on the page. When the '''''Combine Method''''' is then set to ''Geometric'', everything within the bounds of those extracted objects will be returned.		The ''Geometric'' '''''Combine Method''''' requires multiple child objects that return text in multiple areas on the page. When the '''''Combine Method''''' is then set to ''Geometric'', everything within the bounds of those extracted objects will be returned.


	<big>'''Group'''</big>		<big>'''[[#The Group Combine Method\|Group]]'''</big>

	The ''Group'' '''''Combine Method''''' allows you to choose one element from your extraction to be returned. If you have three child objects extracting different text segments, you can select just one of them to return a result instead of all three.		The ''Group'' '''''Combine Method''''' allows you to choose one element from your extraction to be returned. If you have three child objects extracting different text segments, you can select just one of them to return a result instead of all three.
Line 57:		Line 57:

	=== The Individual Combine Method ===		=== The Individual Combine Method ===

			In the example below, we want to collect a date. However, on the document the month, day, and year are listed separately. The goal will be to take the month, day, and year and combine the values to return a single date for extraction.

	# Create a '''Data Type''' with children objects extracting the information you want to combine.		# Create a '''Data Type''' with children objects extracting the information you want to combine.
Line 73:		Line 75:
	#<li value=6> By default, the '''''Combine Method''''' property is set to ''Individual''.		#<li value=6> By default, the '''''Combine Method''''' property is set to ''Individual''.
	# Now the extracted text for all child objects have been combined into one result.		# Now the extracted text for all child objects have been combined into one result.

			However, this value is just a set of numbers and does not immediately look like a date. The next section will solve this problem.

	[[File:2023.1 Combine-(Collation-Provider) 02 01 Combine 03.png]]		[[File:2023.1 Combine-(Collation-Provider) 02 01 Combine 03.png]]


	==== The Result Separator ====		==== The Result Separator ====

			Sometimes just combining all of the extracted text into one result is not enough. It can be difficult to read or it may lack syntactic context (see the [[Data Context]] article) to give us an idea of what information the text is conveying.

			By using a '''''Result Separator''''', we can add spaces, dashes, slashes, or any character to separate out the text in the returned result. In this case we are going to add dashes to make our result easier to identify as a date.

	# Enter in your '''''Result Separator'''''. It can be anything. To make the result in our example look more like a date, we have entered in a dash (-) for the '''''Result Separator'''''.		# Enter in your '''''Result Separator'''''. It can be anything. To make the result in our example look more like a date, we have entered in a dash (-) for the '''''Result Separator'''''.
Line 85:		Line 94:

	=== The Sum Combine Method ===		=== The Sum Combine Method ===

			For this example we have three numbers in a table and we want Grooper to add them up and return the result.

	# Create a '''Data Type''' with child objects that collect the individual results you want to sum up.		# Create a '''Data Type''' with child objects that collect the individual results you want to sum up.
Line 111:		Line 122:

	=== The Flow Combine Method ===		=== The Flow Combine Method ===

			For this example, we have a text sample that looks similar to a college transcript. We want to collect the whole block of text to capture all of the semester information. We can use the ''Flow'' '''''Combine Method''''' to do this.

	# Create a '''Data Type''' with child extractors that return text at the start and end of the section of text you want to capture.		# Create a '''Data Type''' with child extractors that return text at the start and end of the section of text you want to capture.
Line 117:		Line 130:

	[[File:2023.1 Combine-(Collation-Provider) 02 04 Flow 01.png]]		[[File:2023.1 Combine-(Collation-Provider) 02 04 Flow 01.png]]


	#<li value=4> Set the '''''Collation''''' property to ''Combine''.		#<li value=4> Set the '''''Collation''''' property to ''Combine''.
Line 144:		Line 158:

	=== The Geometric Combine Method ===		=== The Geometric Combine Method ===

			In this example we have two sections of text, but we only want to collect the Personal Information section on the left. We can use the ''Geometric'' '''''Combine Method''''' to do so.

	# Create a '''Data Type''' with child objects extracting information that encompass the height and width of the geometric location where you want to extract data.		# Create a '''Data Type''' with child objects extracting information that encompass the height and width of the geometric location where you want to extract data.
Line 156:		Line 172:

	[[File:2023.1 Combine-(Collation-Provider) 02 05 Geometric 02.png]]		[[File:2023.1 Combine-(Collation-Provider) 02 05 Geometric 02.png]]


	#<li value=6> Click the hamburger icon to the right of the '''''Combine Method''''' property to access the drop down menu.		#<li value=6> Click the hamburger icon to the right of the '''''Combine Method''''' property to access the drop down menu.
Line 175:		Line 192:

	=== The Group Combine Method ===		=== The Group Combine Method ===

			For this example, we are going to revisit the text we collected for the ''Individual'' '''''Combine Method'''''. Instead of collecting the full date, in this case we only want to collect the year.

	# Create a '''Data Type''' with multiple children objects that extract different text segments on the page.		# Create a '''Data Type''' with multiple children objects that extract different text segments on the page.

Rpatton: final // via Wikitext Extension for VSCode

2024-04-10T21:27:21Z

final // via Wikitext Extension for VSCode

← Older revision		Revision as of 16:27, 10 April 2024
Line 1:		Line 1:
	{{AutoVersion}}		{{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>		<blockquote>
Line 19:		Line 10:
	\|		\|
	You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023.1). 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.		You may download the ZIP(s) below and upload it into your own Grooper environment (version 2023.1). 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.
	* [[Media:~~Wiki~~ 2023.1 Combine ~~(Collation Provider) Batches~~.zip]]		* [[Media:2023.1 Wiki Combine Batch.zip]]
	* [[Media:~~Wiki~~ 2023.1 Combine ~~(Collation Provider)~~ Project.zip]]		* [[Media:2023.1 Wiki Combine Project.zip]]
	\|}		\|}

Rpatton: draft // via Wikitext Extension for VSCode

2024-04-10T21:24:02Z

draft // via Wikitext Extension for VSCode

Show changes

Rpatton: draft // via Wikitext Extension for VSCode

2024-04-10T15:28:46Z

draft // via Wikitext Extension for VSCode

← Older revision		Revision as of 10:28, 10 April 2024
Line 44:		Line 44:
	The ''Sum'' '''''Combine Method''''' takes numeric results from a '''Data Type's''' child objects and adds them up. The sum of those numbers is returned as a single result.		The ''Sum'' '''''Combine Method''''' takes numeric results from a '''Data Type's''' child objects and adds them up. The sum of those numbers is returned as a single result.

	~~{\|class="attn-box"~~
	\|
	⚠
	\|
	There are more practical and efficient ways to sum up numeric data from a document such as '''''Calculated Value'''''. It is not advised to use the ''Sum'' '''''Combine Method''''' unless absolutely necessary and is primarily used for repositories upgraded from previous versions of Grooper.		There are more practical and efficient ways to sum up numeric data from a document such as '''''Calculated Value'''''. It is not advised to use the ''Sum'' '''''Combine Method''''' unless absolutely necessary and is primarily used for repositories upgraded from previous versions of Grooper.
	\|}

	<big>'''Flow'''</big>		<big>'''Flow'''</big>

Rpatton: draft // via Wikitext Extension for VSCode

2024-04-10T15:27:28Z

draft // via Wikitext Extension for VSCode

← Older revision		Revision as of 10:27, 10 April 2024
Line 25:		Line 25:
	== About ==		== About ==

	The '''''Combine''''' ~~collation provider~~ is helpful when there are multiple text segments on a document that you wish to return as one result.		The '''''Combine''''' '''''Collation Provider''''' is helpful when there are multiple text segments on a document that you wish to return as one result. There are many different ways to combine your results through different '''''Combine Methods'''''.

			There are five different '''''Combine Methods''''':
			* Individual
			* Sum
			* Flow
			* Geometric
			* Group

			Which method you choose depends on the documents you are extracting from and what data you want to collect.

			<big>'''Individual'''</big>

			The '''''Combine Method''''' is set to ''Individual'' by default when using '''''Combine''''' for your '''''Collation Provider'''''. Grooper simply will take the individual results from a '''Data Type's''' child objects and put them all together into one result one right after the other.

			<big>'''Sum'''</big>

			The ''Sum'' '''''Combine Method''''' takes numeric results from a '''Data Type's''' child objects and adds them up. The sum of those numbers is returned as a single result.

			{\|class="attn-box"
			\|
			⚠
			\|
			There are more practical and efficient ways to sum up numeric data from a document such as '''''Calculated Value'''''. It is not advised to use the ''Sum'' '''''Combine Method''''' unless absolutely necessary and is primarily used for repositories upgraded from previous versions of Grooper.
			\|}

			<big>'''Flow'''</big>

			The ''Flow'' '''''Combine Method''''' returns everything within the "flow" of the text of the document from whatever is returned in between the '''Data Type's''' first and second child objects. The full text is returned as a single result.

			<big>'''Geometric'''</big>

			The ''Geometric'' '''''Combine Method''''' requires multiple child objects that return text in multiple areas on the page. When the '''''Combine Method''''' is then set to ''Geometric'', everything within the bounds of those extracted objects will be returned.

			<big>'''Group'''</big>

			The ''Group'' '''''Combine Method''''' allows you to choose one element from your extraction to be returned. If you have three child objects extracting different text segments, you can select just one of them to return a result instead of all three.

			== How To ==

			=== Setting the Combine Collation Property ===

			[[File:2023.1 Combine-(Collation-Provider) 02 01 Combine 01.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 01 Combine 02.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 01 Combine 03.png]]

			=== The Result Separator ===

			[[File:2023.1 Combine-(Collation-Provider) 02 02 Result-Separator 01.png]]


			=== The Sum Combine Method ===

			[[File:2023.1 Combine-(Collation-Provider) 02 03 Sum 01.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 03 Sum 02.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 03 Sum 03.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 03 Sum 04.png]]


			=== The Flow Combine Method ===

			[[File:2023.1 Combine-(Collation-Provider) 02 04 Flow 01.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 04 Flow 02.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 04 Flow 03.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 04 Flow 04.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 04 Flow 05.png]]


			=== The Geometric Combine Method ===

			[[File:2023.1 Combine-(Collation-Provider) 02 05 Geometric 01.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 05 Geometric 02.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 05 Geometric 03.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 05 Geometric 04.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 05 Geometric 05.png]]


			=== The Group Combine Method ===

			[[File:2023.1 Combine-(Collation-Provider) 02 06 Group 01.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 06 Group 02.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 06 Group 03.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 06 Group 04.png]]


			[[File:2023.1 Combine-(Collation-Provider) 02 06 Group 05.png]]