2023.1:Combine (Collation Provider): Difference between revisions

From Grooper Wiki
← Older editNewer edit →
WIP 1 // via Wikitext Extension for VSCode
draft // via Wikitext Extension for VSCode
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]]

Revision as of 10:27, 10 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.

The Combine collation provider takes individual results and "combines" them into one. There are several methods by which Grooper can obtain these results and combine them.

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.

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.

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.

Individual

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.

Sum

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.

Flow

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.

Geometric

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.

Group

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



The Result Separator


The Sum Combine Method





The Flow Combine Method






The Geometric Combine Method






The Group Combine Method





Retrieved from "https://wiki.grooper.com/index.php?title=2023.1:Combine_(Collation_Provider)&oldid=20854"