2023:PDF Data Mapping (Behavior) - Revision history

Dgreenwood at 16:01, 2 September 2025

2025-09-02T16:01:10Z

Dgreenwood: /* Configure PDF Generation for Annotations */

2024-06-26T15:15:43Z

Configure PDF Generation for Annotations

← Older revision		Revision as of 10:15, 26 June 2024
Line 228:		Line 228:

	=== Configure PDF Generation for Annotations ===		=== Configure PDF Generation for Annotations ===

			{\|class="attn-box"
			\|
			⚠
			\|
			'''''BE AWARE: PDF Data Mapping cannot insert annotations on PDF pages with form fields.'''''

			If a PDF page is form-fillable, it is ill advised to insert annotations and widgets on top of these form fields. This can result in a corrupted PDF when it is generated by '''''Merge''''' or '''''Export'''''. '''''PDF Data Mapping''''' will not allow you to insert annotations and widgets on PDF pages with form fields.
			\|}

	<tabs style="margin:20px">		<tabs style="margin:20px">

Randallkinard at 20:48, 19 April 2024

2024-04-19T20:48:07Z

← Older revision		Revision as of 15:48, 19 April 2024
Line 1:		Line 1:
	{{AutoVersion}}		{{AutoVersion}}
	~~<section begin="glossary" />~~
	<blockquote>		<blockquote>{{#lst:Glossary\|PDF Data Mapping}}</blockquote>
	~~'''''~~PDF Data Mapping''''' is a '''Content Type''' '''''Behavior''''' designed to create an exportable PDF file with additional native PDF elements, using the classification and extraction content of a '''Batch Folder'''. This includes capabilities to export extracted data as PDF metadata, inserting bookmarks, and creating PDF annotations, such as highlighting, checkbox and signature widgets.
	</blockquote>
	~~<section end="glossary" /~~>

	{\|class="download-box"		{\|class="download-box"
Line 16:		Line 13:

	== About ==		== About ==

	The '''''PDF Data Mapping''''' behavior allows Grooper users to more fully leverage the capabilities of the PDF file type. The standard PDF '''''Export Format''''' in Grooper will use the page image files and their text data to create a multipage PDF file for each document folder upon '''Export'''. However, this is just the "display information" required to open and read the document. There's a lot more to what a PDF can be than just a multipage document with page images and machine readable text. PDF content can also include metadata, keywords, bookmarks, annotations, and more!		The '''''PDF Data Mapping''''' behavior allows Grooper users to more fully leverage the capabilities of the PDF file type. The standard PDF '''''Export Format''''' in Grooper will use the page image files and their text data to create a multipage PDF file for each document folder upon '''Export'''. However, this is just the "display information" required to open and read the document. There's a lot more to what a PDF can be than just a multipage document with page images and machine readable text. PDF content can also include metadata, keywords, bookmarks, annotations, and more!

Randallkinard: Randallkinard moved page 2023:PDF Data Mapping to 2023:PDF Data Mapping (Behavior) without leaving a redirect: new naming convention

2024-04-18T13:43:52Z

Randallkinard moved page 2023:PDF Data Mapping to 2023:PDF Data Mapping (Behavior) without leaving a redirect: new naming convention

← Older revision	Revision as of 08:43, 18 April 2024
(No difference)

Rpatton: zips // via Wikitext Extension for VSCode

2024-03-19T19:14:50Z

zips // via Wikitext Extension for VSCode

← Older revision		Revision as of 14:14, 19 March 2024
Line 11:		Line 11:
	\|		\|
	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.		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:Wiki - ~~PDF~~ Data Mapping ~~- 2023 -~~Batch-.zip]]		* [[Media:2023 Wiki PDF-Data-Mapping Batch.zip]]
	* [[Media:Wiki - ~~PDF~~ Data Mapping ~~- 2023 -~~Project-.zip]]		* [[Media:2023 Wiki PDF-Data-Mapping Project.zip]]
	\|}		\|}

Dgreenwood: /* Configure PDF Data Mapping for Metadata */

2024-01-25T22:03:35Z

Configure PDF Data Mapping for Metadata

← Older revision		Revision as of 17:03, 25 January 2024
Line 859:		Line 859:
	⚠		⚠
	\|		\|
	Notice what's not included in this list is the exported document's ''filename'' (i.e. "Im_a_file.pdf"). Filename mappings are always configured using an ''Export Behavior''.		Notice what's not included in this list is the exported document's ''filename'' (e.g. "Im_a_file.pdf"). Filename mappings are always configured using an ''Export Behavior''.
	\|}		\|}
	\|		\|

Dgreenwood at 21:54, 25 January 2024

2024-01-25T21:54:52Z

@@ Line 5: / Line 5: @@
 </blockquote>
 <section end="glossary" />
 == About ==

Dgreenwood at 21:45, 25 January 2024

2024-01-25T21:45:34Z

← Older revision		Revision as of 16:45, 25 January 2024
Line 155:		Line 155:

	The following tutorials use a mock UNESCO Laura W. Bush Traveling Fellowship application to detail a more specific set up for a '''''PDF Data Mapping'''''. This is a packet of documents from a single applicant containing five different kinds of documents.		The following tutorials use a mock UNESCO Laura W. Bush Traveling Fellowship application to detail a more specific set up for a '''''PDF Data Mapping'''''. This is a packet of documents from a single applicant containing five different kinds of documents.

	~~{\|class="download-box"~~
	\|
	~~[[File:Asset 22@4x.png]]~~
	\|
	You may download and import the file below into your own Grooper environment (version 2021). This contains a '''Batch''' with the example document(s) discussed in this tutorial and a '''Content Model''' configured according to its instructions.
	* [[Media:PDF Data Mapping (v2021).zip]]
	\|}

	<tabs style="margin:20px">		<tabs style="margin:20px">

Dgreenwood at 16:32, 12 January 2024

2024-01-12T16:32:36Z

← Older revision		Revision as of 11:32, 12 January 2024
Line 461:		Line 461:
	<tab name="Checkbox Widget" style="margin:20px">		<tab name="Checkbox Widget" style="margin:20px">
	=== Checkbox Widget ===		=== Checkbox Widget ===
	{\|~~cellpadding~~="~~10" cellspacing="5~~"		{\|class="wip-box"
	\|~~-style="background-color:#ed2330; color:white"~~		\|
	~~\|style="font-size:14pt"\|~~'''~~WIP~~'''\|\|The ''Checkbox Widget'' documentation needs to be finalized after getting some guidance from dev. If it seems incomplete or images don't match up with text, that is why.		'''WPI'''
			\|
			The ''Checkbox Widget'' documentation needs to be finalized after getting some guidance from dev. If it seems incomplete or images don't match up with text, that is why.
	\|}		\|}

Dgreenwood at 15:41, 12 January 2024

2024-01-12T15:41:22Z

← Older revision		Revision as of 10:41, 12 January 2024
Line 127:		Line 127:


	{\|~~cellpadding~~="~~10" cellspacing="5~~"		{\|class="fyi-box"
	\|~~-style="background-color:#36b0a7; color:white"~~		\|
	~~\|style="font-size:14pt"\|~~'''FYI'''		'''FYI'''
	\|		\|
	'''''Export Behaviors''''' can also be configured on the '''Export''' activity as local '''''Export Behaviors''''' to the activity configuration.		'''''Export Behaviors''''' can also be configured on the '''Export''' activity as local '''''Export Behaviors''''' to the activity configuration.
Line 432:		Line 432:
	\|}		\|}

	{\|~~cellpadding~~="~~10" cellspacing="5~~"		{\|class="fyi-box"
	\|~~-style="background-color:#36b0a7; color:white"~~		\|
	~~\|style="font-size:14pt"\|~~'''FYI'''		'''FYI'''
	\|		\|
	{\|cellpadding=10 cellspacing=5		{\|class="inner-box" cellpadding=10 cellspacing=5
	\|valign=top style="width:50%"\|		\|valign=top style="width:50%"\|
	In the case of every '''''Annotation Type''''', '''''PDF Data Mapping''''' inserts the annotation by overlaying it on top of the document. This can be important to keep in mind for all annotations but is often particularly relevant when inserting radio buttons using the '''''Radio Group Widget'''''.		In the case of every '''''Annotation Type''''', '''''PDF Data Mapping''''' inserts the annotation by overlaying it on top of the document. This can be important to keep in mind for all annotations but is often particularly relevant when inserting radio buttons using the '''''Radio Group Widget'''''.
Line 675:		Line 675:


	{\|~~cellpadding~~="~~10" cellspacing="5~~"		{\|class="fyi-box"
	\|~~-style="background-color:#36b0a7; color:white"~~		\|
	~~\|style="font-size:14pt"\|~~'''FYI'''		'''FYI'''
	\|		\|
	This certainly isn't the '''only''' way to set up a '''Data Field''' for a ''Textbox Widget''. This is just how we did it for the point of illustrating the ''Textbox Widget'' functionality. You are not '''required''' to use the ''Highlight Zone'' extractor type. You can use whatever extractor type best suits your document's needs. Often Grooper users will use the ''Reference'' extractor to point to a '''Data Type's''' results and adjust the size of the ''Textbox Widget'' using its '''''Padding''''' property.		This certainly isn't the '''only''' way to set up a '''Data Field''' for a ''Textbox Widget''. This is just how we did it for the point of illustrating the ''Textbox Widget'' functionality. You are not '''required''' to use the ''Highlight Zone'' extractor type. You can use whatever extractor type best suits your document's needs. Often Grooper users will use the ''Reference'' extractor to point to a '''Data Type's''' results and adjust the size of the ''Textbox Widget'' using its '''''Padding''''' property.
Line 787:		Line 787:
	\|}		\|}

	{\|~~cellpadding~~="~~10" cellspacing="5~~"		{\|class="fyi-box"
	\|~~-style="background-color:#36b0a7; color:white"~~		\|
	~~\|style="font-size:14pt"\|~~'''FYI'''		'''FYI'''
	\|		\|
	There are many ways to separate and classify documents, including ''[[ESP Auto Separation]]'' which both separates and classifies documents with a single activity (just '''Separate'''). But this is the general idea to get us where we need to go.		There are many ways to separate and classify documents, including ''[[ESP Auto Separation]]'' which both separates and classifies documents with a single activity (just '''Separate'''). But this is the general idea to get us where we need to go.

← Older revision		Revision as of 11:01, 2 September 2025
Line 560:		Line 560:
	#* Whatever result is returned by the selected '''Data Fields''' will be used to draw and insert the signature box widget.		#* Whatever result is returned by the selected '''Data Fields''' will be used to draw and insert the signature box widget.
	#* You may use the '''''Padding''''' property to adjust the size of the signature box if you desire.		#* You may use the '''''Padding''''' property to adjust the size of the signature box if you desire.
	#* Zonal based extraction methods (such as '''''Signature Detection''''' and '''''Highlight Zone''''') are typically used as the '''Data Field's''' extractor ~~type~~.		#* Zonal based extraction methods (such as '''''Signature Detection''''' and '''''Highlight Zone''''') are typically used as the '''Data Field's''' extractor.
	# When the window pops up, check the boxes next to the '''Data Fields''' you wish to use to create the checkboxes.		# When the window pops up, check the boxes next to the '''Data Fields''' you wish to use to create the checkboxes.
	#* In our case, we are choosing the "Signature" '''Data Field'''. Once collected by the '''Extract''' activity, Grooper will be supplied the size and location of the '''Data Field's''' extraction zone, which will form the size and location of the PDF signature widget. The '''''Signature Widget''''' annotation will then insert the form-fillable signature box into the generated PDF as seen in the "''After Annotation''" image above.		#* In our case, we are choosing the "Signature" '''Data Field'''. Once collected by the '''Extract''' activity, Grooper will be supplied the size and location of the '''Data Field's''' extraction zone, which will form the size and location of the PDF signature widget. The '''''Signature Widget''''' annotation will then insert the form-fillable signature box into the generated PDF as seen in the "''After Annotation''" image above.
Line 569:		Line 569:
	Just like any '''''Annotation Type''''', the extraction result from the '''Data Field''' is critical for placing the signature annotation on the generated PDF. Let's look at the "Signature" '''Data Field's''' result to understand a little better how these results are used to create the signature widget.		Just like any '''''Annotation Type''''', the extraction result from the '''Data Field''' is critical for placing the signature annotation on the generated PDF. Let's look at the "Signature" '''Data Field's''' result to understand a little better how these results are used to create the signature widget.

	In our case, we're using the '''''Detect Signature''''' ~~extractor type~~ to supply these results. The '''''Detect Signature''''' extractor is perfectly suited for the '''''Signature Widget''''' '''''Annotation Type'''''.		In our case, we're using the '''''Detect Signature''''' Value Extractor to supply these results. The '''''Detect Signature''''' extractor is perfectly suited for the '''''Signature Widget''''' '''''Annotation Type'''''.
	* It actually combines both Zonal and OMR based extraction techniques to determine if a signature is present in the zone. It sets the boundaries of where you expect to find a signature using Zonal based methods and detects if the signature is present by counting the percentage of filled pixels in the zone, which is the basis of OMR based extraction methods. You can then output different values if the zone is filled above or below a certain percentage. In this case, the extractor returns "Not Signed" because there aren't enough pixels present in the extraction zone to count as filled. If there were a signature present, there'd be more pixels present, accounting for a higher filled percentage.		* It actually combines both Zonal and OMR based extraction techniques to determine if a signature is present in the zone. It sets the boundaries of where you expect to find a signature using Zonal based methods and detects if the signature is present by counting the percentage of filled pixels in the zone, which is the basis of OMR based extraction methods. You can then output different values if the zone is filled above or below a certain percentage. In this case, the extractor returns "Not Signed" because there aren't enough pixels present in the extraction zone to count as filled. If there were a signature present, there'd be more pixels present, accounting for a higher filled percentage.

Line 604:		Line 604:


	The '''''Textbox Widget''''' '''''Annotation Type''''' will insert editable text boxes into the generated PDF. One simple way to use this functionality is to use the '''''Highlight Zone''''' extractor ~~type~~ to place a blank zone where you want to place an empty text box on the PDF. However, any extractor ~~type~~ can be used to define the textbox's location. Furthermore, if the '''Data Field''' used to create the annotation collects a valued during the '''Extract''' activity, not only will a textbox be inserted into the generated PDF, but it will be prefilled with the '''Data Field's''' extracted value upon export.		The '''''Textbox Widget''''' '''''Annotation Type''''' will insert editable text boxes into the generated PDF. One simple way to use this functionality is to use the '''''Highlight Zone''''' extractor to place a blank zone where you want to place an empty text box on the PDF. However, any extractor (Extractor Node or Value Extractor) can be used to define the textbox's location. Furthermore, if the '''Data Field''' used to create the annotation collects a valued during the '''Extract''' activity, not only will a textbox be inserted into the generated PDF, but it will be prefilled with the '''Data Field's''' extracted value upon export.

	For example, we will use the '''''Textbox Widget''''' functionality to fill out the blank coversheet on the first page of our application packet. We will end up using a '''''Highlight Zone''''' extractor to define the size and location of the text box. However, we're going to go one step further and populate the '''Data Field's''' used with some information from other '''Data Field's''' in our '''Data Model'''. By the end of it, '''''PDF Data Mapping''''' will not only insert editable textboxes into the generated PDF, but fill them in with text. By the end of it, we end up with this blank coversheet automatically populated with some information collected during the '''Extract''' activity.		For example, we will use the '''''Textbox Widget''''' functionality to fill out the blank coversheet on the first page of our application packet. We will end up using a '''''Highlight Zone''''' extractor to define the size and location of the text box. However, we're going to go one step further and populate the '''Data Field's''' used with some information from other '''Data Field's''' in our '''Data Model'''. By the end of it, '''''PDF Data Mapping''''' will not only insert editable textboxes into the generated PDF, but fill them in with text. By the end of it, we end up with this blank coversheet automatically populated with some information collected during the '''Extract''' activity.
Line 651:		Line 651:
	As far as looking behind the scenes, there's at least two things going on with how we've set up these '''Data Fields'''' extraction, ultimately supplying the result used to insert the ''Textbox Widget'' annotation.		As far as looking behind the scenes, there's at least two things going on with how we've set up these '''Data Fields'''' extraction, ultimately supplying the result used to insert the ''Textbox Widget'' annotation.

	First, we used the ''Highlight Zone'' extractor ~~type~~ to draw the textbox, defining the size and location of the annotation upon generating the PDF.		First, we used the ''Highlight Zone'' extractor to draw the textbox, defining the size and location of the annotation upon generating the PDF.

	# We have selected the "Candidate" '''Data Field''' in our ''''Data Model'''.		# We have selected the "Candidate" '''Data Field''' in our ''''Data Model'''.
Line 688:		Line 688:
	'''FYI'''		'''FYI'''
	\|		\|
	This certainly isn't the '''only''' way to set up a '''Data Field''' for a ''Textbox Widget''. This is just how we did it for the point of illustrating the ''Textbox Widget'' functionality. You are not '''required''' to use the ''Highlight Zone'' extractor ~~type~~. You can use whatever extractor ~~type~~ best suits your document's needs. Often Grooper users will use the ''Reference'' extractor to point to a '''Data Type's''' results and adjust the size of the ''Textbox Widget'' using its '''''Padding''''' property.		This certainly isn't the '''only''' way to set up a '''Data Field''' for a ''Textbox Widget''. This is just how we did it for the point of illustrating the ''Textbox Widget'' functionality. You are not '''required''' to use the ''Highlight Zone'' extractor. You can use whatever extractor (Extractor Node or Value Extractor) that best suits your document's needs. Often Grooper users will use the ''Reference'' extractor to point to a '''Data Type's''' results and adjust the size of the ''Textbox Widget'' using its '''''Padding''''' property.
	\|}		\|}
	\|		\|