2023:Scope (Property) - Revision history

Dgreenwood at 15:15, 2 March 2025

2025-03-02T15:15:06Z

← Older revision		Revision as of 10:15, 2 March 2025
Line 10:		Line 10:

	== About ==		== About ==
	An important thing to understand about '''''Scope''''' is that for nearly every activity you are telling '''Grooper''' ''what'' you want to apply the activity to. For example, '''[[~~Recognize (Activity)\|~~Recognize]]''', do you want to affect ''Pages'' or ''Folders'' (keep in mind, however, that in nearly every scenario it is considered best practice to scope '''Recognize''' to ''Page''). Or, '''[[Extract]]''', do you want to extract data from folders at level 1, or level 2, etc.		An important thing to understand about '''''Scope''''' is that for nearly every activity you are telling '''Grooper''' ''what'' you want to apply the activity to. For example, '''[[Recognize]]''', do you want to affect ''Pages'' or ''Folders'' (keep in mind, however, that in nearly every scenario it is considered best practice to scope '''Recognize''' to ''Page''). Or, '''[[Extract]]''', do you want to extract data from folders at level 1, or level 2, etc.

	=== Batch Scope ===		=== Batch Scope ===

Dgreenwood at 22:31, 28 February 2025

2025-02-28T22:31:44Z

← Older revision		Revision as of 17:31, 28 February 2025
Line 10:		Line 10:

	== About ==		== About ==
	An important thing to understand about '''''Scope''''' is that for nearly every activity you are telling '''Grooper''' ''what'' you want to apply the activity to. For example, '''[[Recognize (Activity)\|Recognize]]''', do you want to affect ''Pages'' or ''Folders'' (keep in mind, however, that in nearly every scenario it is considered best practice to scope '''Recognize''' to ''Page''). Or, '''[[~~Extract (Activity)\|~~Extract]]''', do you want to extract data from folders at level 1, or level 2, etc.		An important thing to understand about '''''Scope''''' is that for nearly every activity you are telling '''Grooper''' ''what'' you want to apply the activity to. For example, '''[[Recognize (Activity)\|Recognize]]''', do you want to affect ''Pages'' or ''Folders'' (keep in mind, however, that in nearly every scenario it is considered best practice to scope '''Recognize''' to ''Page''). Or, '''[[Extract]]''', do you want to extract data from folders at level 1, or level 2, etc.

	=== Batch Scope ===		=== Batch Scope ===
Line 18:		Line 18:
	The most common setting for the '''''Scope''''' property is ''Folder''. Using this setting exposes the '''''Folder Level''''' property, which is set to an integer like 1, 2, or 3 etc. Understanding '''Batch''' hierarchy as it relates to the '''''Folder Level''''' property is important.		The most common setting for the '''''Scope''''' property is ''Folder''. Using this setting exposes the '''''Folder Level''''' property, which is set to an integer like 1, 2, or 3 etc. Understanding '''Batch''' hierarchy as it relates to the '''''Folder Level''''' property is important.

	Setting the '''''Folder Level''''' property to something other than the default of ''1'' is most common with the '''[[~~Classify (Activity)\|~~Classify]]''', '''Extract''', and '''[[~~Export (Activity)\|~~Export]]''' activities.		Setting the '''''Folder Level''''' property to something other than the default of ''1'' is most common with the '''[[Classify]]''', '''Extract''', and '''[[Export]]''' activities.

	Consider a '''Batch''' with a '''Batch Folder''' at "Folder Level 1" that has two child '''Batch Folders''' at "Folder Level 2". The document at "Folder Level 1" is a packet made up by its two "sub" documents. For this example consider the document at "Folder Level 1" is a "Mortgage Packet" document consisting of a "Closing Disclosure" document and a "Universal Residential Loan Application" document.		Consider a '''Batch''' with a '''Batch Folder''' at "Folder Level 1" that has two child '''Batch Folders''' at "Folder Level 2". The document at "Folder Level 1" is a packet made up by its two "sub" documents. For this example consider the document at "Folder Level 1" is a "Mortgage Packet" document consisting of a "Closing Disclosure" document and a "Universal Residential Loan Application" document.
Line 54:		Line 54:

	=== Scoping Separate ===		=== Scoping Separate ===
	Scoping for '''[[~~Separate (Activity)\|~~Separate]]''' and '''[[~~Review (Activity)\|~~Review]]''' is a bit unique as well. For these activities '''''Scope''''' is not ''what'' you are affecting, but to ''where'' you are applying the activity.		Scoping for '''[[Separate]]''' and '''[[Review]]''' is a bit unique as well. For these activities '''''Scope''''' is not ''what'' you are affecting, but to ''where'' you are applying the activity.

	You might think "I want to separate the pages of this batch into individual folders", and assume the '''''Scope''''' would be ''Page''. This would be an incorrect assumption. With '''Separate''' you don't scope it to pages, you '''''Scope''''' it to either ''Batch'' or		You might think "I want to separate the pages of this batch into individual folders", and assume the '''''Scope''''' would be ''Page''. This would be an incorrect assumption. With '''Separate''' you don't scope it to pages, you '''''Scope''''' it to either ''Batch'' or
Line 116:		Line 116:
	Consider a '''Batch''' with just one document at Folder Level 1. Consider also that this document has 1,000 pages. If the '''''Scope''''' were set to ''Folder'' and the '''''Folder Level''''' to ''1'' a '''[[Job]]''' would get created with one '''Task'''. As a result only a single CPU thread would pick up that single '''Task''' and take a very long time recognizing the text on that document's 1,000 pages.		Consider a '''Batch''' with just one document at Folder Level 1. Consider also that this document has 1,000 pages. If the '''''Scope''''' were set to ''Folder'' and the '''''Folder Level''''' to ''1'' a '''[[Job]]''' would get created with one '''Task'''. As a result only a single CPU thread would pick up that single '''Task''' and take a very long time recognizing the text on that document's 1,000 pages.

	However, if (following best practice) you set the '''Recognize''' '''''Scope''''' to ''Page'', a '''Job''' will get created with 1,000 '''Tasks''' (one '''Task''' per page object). Therefore, depending on how you've structured your '''[[Activity Processing ~~Service~~]]~~s'''~~, you could have a wide array of CPU threads tackling each '''Task''' ~~independantly~~. This would greatly ~~decress~~ the time required to recognize the text on the document.		However, if (following best practice) you set the '''Recognize''' '''''Scope''''' to ''Page'', a '''Job''' will get created with 1,000 '''Tasks''' (one '''Task''' per page object). Therefore, depending on how you've structured your '''[[Activity Processing]] services, you could have a wide array of CPU threads tackling each '''Task''' independently. This would greatly decrees the time required to recognize the text on the document.

	=== Example: Separate > Undo Separation ===		=== Example: Separate > Undo Separation ===
Line 149:		Line 149:

	==== Batch, Folder, or Page ====		==== Batch, Folder, or Page ====
	* [[~~Execute (Activity)\|~~Execute]]		* [[Execute]]
			** Applicable scope is dependent on the command executed by this step.

	==== Batch and Folder ====		==== Batch and Folder ====
	* [[~~Deduplicate (Activity)\|~~Deduplicate]]		* [[Deduplicate]]
	* [[~~Export (Activity)\|~~Export]]		* [[Export]]
	* [[~~Remove Level (Activity)\|~~Remove Level]]		* [[Remove Level]]
	* [[~~Review (Activity)\|~~Review]]		* [[Review]]
	* [[~~Send Mail (Activity)\|~~Send Mail]]		* [[Send Mail]]
	* [[~~Separate (Activity)\|~~Separate]]		* [[Separate]]

	==== Folder and Page ====		==== Folder and Page ====
	* [[~~Burst Book (Activity)\|~~Burst Book]]		* [[Burst Book]]
	* [[~~Correct (Activity)\|~~Correct]]		* [[Correct]]
	* [[~~Detect Language (Activity)\|~~Detect Language]]		* [[Detect Language]]
	* [[~~Image Processing (Activity)\|~~Image Processing]]		* [[Image Processing]]
	* [[~~Recognize (Activity)\|~~Recognize]]		* [[Recognize]]
	* [[~~Train Lexicon (Activity)\|~~Train Lexicon]]		* [[Train Lexicon]]

	==== Batch Only ====		==== Batch Only ====
	* [[~~Batch Transfer (Activity)\|~~Batch Transfer]]		* [[Batch Transfer]]
	* [[~~Dispose Batch (Activity)\|~~Dispose Batch]]		* [[Dispose Batch]]
	* [[~~Launch Process (Activity)\|~~Launch Process]]		* [[Launch Process]]
	* [[~~Spawn Batch (Activity)\|~~Spawn Batch]]		* [[Spawn Batch]]

	==== Folder Only ====		==== Folder Only ====
	* [[~~Apply Rules (Activity)\|~~Apply Rules]]		* [[Apply Rules]]
	* [[~~Classify (Activity)\|~~Classify]]		* [[Classify]]
	* [[~~Clip Frames (Activity)\|~~Clip Frames]]		* [[Clip Frames]]
	* [[~~Convert Data (Activity)\|~~Convert Data]]		* [[Convert Data]]
	* [[~~Detect Frames (Activity)\|~~Detect Frames]]		* [[Detect Frames]]
	* [[~~Extract (Activity)\|~~Extract]]		* [[Extract]]
	* [[~~Initialize Card (Activity)\|~~Initialize Card]]		* [[Initialize Card]]
	* [[~~Merge (Activity)\|~~Merge]]		* [[Merge]]
	* [[~~Render (Activity)\|~~Render]]		* [[Render]]
	* [[~~Split Pages (Activity)\|~~Split Pages]]		* [[Split Pages]]
	* [[~~Split Text (Activity)\|~~Split Text]]		* [[Split Text]]
	* [[~~Text Transform (Activity)\|~~Text Transform]]		* [[Text Transform]]
	* [[~~Translate (Activity)\|~~Translate]]		* [[Translate]]
	* [[~~XML Transform (Activity)\|~~XML Transform]]		* [[XML Transform]]

	==== Page Only ====		==== Page Only ====
	* [[~~Redact (Activity)\|~~Redact]]		* [[Redact]]

Dgreenwood at 22:20, 28 February 2025

2025-02-28T22:20:16Z

← Older revision		Revision as of 17:20, 28 February 2025
Line 116:		Line 116:
	Consider a '''Batch''' with just one document at Folder Level 1. Consider also that this document has 1,000 pages. If the '''''Scope''''' were set to ''Folder'' and the '''''Folder Level''''' to ''1'' a '''[[Job]]''' would get created with one '''Task'''. As a result only a single CPU thread would pick up that single '''Task''' and take a very long time recognizing the text on that document's 1,000 pages.		Consider a '''Batch''' with just one document at Folder Level 1. Consider also that this document has 1,000 pages. If the '''''Scope''''' were set to ''Folder'' and the '''''Folder Level''''' to ''1'' a '''[[Job]]''' would get created with one '''Task'''. As a result only a single CPU thread would pick up that single '''Task''' and take a very long time recognizing the text on that document's 1,000 pages.

	However, if (following best practice) you set the '''Recognize''' '''''Scope''''' to ''Page'', a '''Job''' will get created with 1,000 '''Tasks''' (one '''Task''' per page object). Therefore, depending on how you've structured your '''[[Activity Processing (Service~~)\|Activity Processing Services~~]]''', you could have a wide array of CPU threads tackling each '''Task''' independantly. This would greatly decress the time required to recognize the text on the document.		However, if (following best practice) you set the '''Recognize''' '''''Scope''''' to ''Page'', a '''Job''' will get created with 1,000 '''Tasks''' (one '''Task''' per page object). Therefore, depending on how you've structured your '''[[Activity Processing Service]]s''', you could have a wide array of CPU threads tackling each '''Task''' independantly. This would greatly decress the time required to recognize the text on the document.

	=== Example: Separate > Undo Separation ===		=== Example: Separate > Undo Separation ===

Randallkinard at 15:28, 22 November 2024

2024-11-22T15:28:35Z

← Older revision		Revision as of 10:28, 22 November 2024
Line 191:		Line 191:
	==== Page Only ====		==== Page Only ====
	* [[Redact (Activity)\|Redact]]		* [[Redact (Activity)\|Redact]]

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

	~~<u><big>'''Activity Processing'''</big></u>: {{#lst:Glossary\|Activity Processing Service}}~~

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Randallkinard at 15:26, 27 August 2024

2024-08-27T15:26:35Z

Show changes

Randallkinard: /* Glossary */

2024-05-10T17:59:34Z

Glossary

← Older revision		Revision as of 12:59, 10 May 2024
Line 10:		Line 10:

	== Glossary ==		== Glossary ==
	<u><big>'''Activity Processing'''</big></u>: {{#lst:Glossary\|Activity Processing}}		<u><big>'''Activity Processing'''</big></u>: {{#lst:Glossary\|Activity Processing Concept}}

	<u><big>'''Activity Processing'''</big></u>: {{#lst:Glossary\|Activity Processing}}		<u><big>'''Activity Processing'''</big></u>: {{#lst:Glossary\|Activity Processing Service}}

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

Randallkinard at 17:59, 10 May 2024

2024-05-10T17:59:19Z

← Older revision		Revision as of 12:59, 10 May 2024
Line 9:		Line 9:
	* ''Page'' - One task will be created for each page.		* ''Page'' - One task will be created for each page.

			== Glossary ==
			<u><big>'''Activity Processing'''</big></u>: {{#lst:Glossary\|Activity Processing}}

			<u><big>'''Activity Processing'''</big></u>: {{#lst:Glossary\|Activity Processing}}

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

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

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

			<u><big>'''Batch Process Step'''</big></u>: {{#lst:Glossary\|Batch Process Step}}

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

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

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

			<u><big>'''Clip Frames'''</big></u>: {{#lst:Glossary\|Clip Frames}}

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

			<u><big>'''Detect Frames'''</big></u>: {{#lst:Glossary\|Detect Frames}}

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

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

			<u><big>'''Export Behavior'''</big></u>: {{#lst:Glossary\|Export Behavior}}

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

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

			<u><big>'''Image Processing'''</big></u>: {{#lst:Glossary\|Image Processing}}

			<u><big>'''Image Processing'''</big></u>: {{#lst:Glossary\|Image Processing}}

			<u><big>'''Initialize Card'''</big></u>: {{#lst:Glossary\|Initialize Card}}

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

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

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

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

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

			<u><big>'''Send Mail'''</big></u>: {{#lst:Glossary\|Send Mail}}

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

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

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

			<u><big>'''Split Pages'''</big></u>: {{#lst:Glossary\|Split Pages}}

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

			<u><big>'''Undo Separation'''</big></u>: {{#lst:Glossary\|Undo Separation}}

			<u><big>'''XML Transform'''</big></u>: {{#lst:Glossary\|XML Transform}}

	== About ==		== About ==

Randallkinard at 16:45, 29 April 2024

2024-04-29T16:45:20Z

← Older revision		Revision as of 11:45, 29 April 2024
Line 1:		Line 1:
	{{AutoVersion}}		{{AutoVersion}}
	~~<section begin="glossary" />~~
	<blockquote>		<blockquote>{{#lst:Glossary\|Scope}}</blockquote>
	~~The '''''~~Scope~~''''' property of a '''[[Batch Process Step]]''', as it relates to an '''[[Activity]]''', determines at which level in a '''[[Batch]]''' hierarchy the '''Activity''' runs.~~
	</blockquote>
	~~<section end="glossary" />~~
	'''Activities''' can be scoped to different levels in a '''Batch''':		'''Activities''' can be scoped to different levels in a '''Batch''':

Randallkinard: Randallkinard moved page 2023:Scope to 2023:Scope (Property) without leaving a redirect: new naming convention

2024-04-18T16:19:47Z

Randallkinard moved page 2023:Scope to 2023:Scope (Property) without leaving a redirect: new naming convention

← Older revision	Revision as of 11:19, 18 April 2024
(No difference)

Randallkinard: /* About */

2024-03-29T20:29:39Z

About

← Older revision		Revision as of 10:28, 22 November 2024
Line 191:		Line 191:
	==== Page Only ====		==== Page Only ====
	* [[Redact (Activity)\|Redact]]		* [[Redact (Activity)\|Redact]]

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

	~~<u><big>'''Activity Processing'''</big></u>: {{#lst:Glossary\|Activity Processing Service}}~~

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

← Older revision		Revision as of 12:59, 10 May 2024
Line 9:		Line 9:
	* ''Page'' - One task will be created for each page.		* ''Page'' - One task will be created for each page.

			== Glossary ==
			<u><big>'''Activity Processing'''</big></u>: {{#lst:Glossary\|Activity Processing}}

			<u><big>'''Activity Processing'''</big></u>: {{#lst:Glossary\|Activity Processing}}

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

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

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

			<u><big>'''Batch Process Step'''</big></u>: {{#lst:Glossary\|Batch Process Step}}

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

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

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

			<u><big>'''Clip Frames'''</big></u>: {{#lst:Glossary\|Clip Frames}}

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

			<u><big>'''Detect Frames'''</big></u>: {{#lst:Glossary\|Detect Frames}}

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

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

			<u><big>'''Export Behavior'''</big></u>: {{#lst:Glossary\|Export Behavior}}

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

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

			<u><big>'''Image Processing'''</big></u>: {{#lst:Glossary\|Image Processing}}

			<u><big>'''Image Processing'''</big></u>: {{#lst:Glossary\|Image Processing}}

			<u><big>'''Initialize Card'''</big></u>: {{#lst:Glossary\|Initialize Card}}

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

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

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

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

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

			<u><big>'''Send Mail'''</big></u>: {{#lst:Glossary\|Send Mail}}

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

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

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

			<u><big>'''Split Pages'''</big></u>: {{#lst:Glossary\|Split Pages}}

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

			<u><big>'''Undo Separation'''</big></u>: {{#lst:Glossary\|Undo Separation}}

			<u><big>'''XML Transform'''</big></u>: {{#lst:Glossary\|XML Transform}}

	== About ==		== About ==

← Older revision		Revision as of 15:29, 29 March 2024
Line 20:		Line 20:
	=== Folder Scope ===		=== Folder Scope ===
	The most common setting for the '''''Scope''''' property is ''Folder''. Using this setting exposes the '''''Folder Level''''' property, which is set to an integer like 1, 2, or 3 etc. Understanding '''Batch''' hierarchy as it relates to the '''''Folder Level''''' property is important.		The most common setting for the '''''Scope''''' property is ''Folder''. Using this setting exposes the '''''Folder Level''''' property, which is set to an integer like 1, 2, or 3 etc. Understanding '''Batch''' hierarchy as it relates to the '''''Folder Level''''' property is important.


	Setting the '''''Folder Level''''' property to something other than the default of ''1'' is most common with the '''[[Classify (Activity)\|Classify]]''', '''Extract''', and '''[[Export (Activity)\|Export]]''' activities.		Setting the '''''Folder Level''''' property to something other than the default of ''1'' is most common with the '''[[Classify (Activity)\|Classify]]''', '''Extract''', and '''[[Export (Activity)\|Export]]''' activities.
Line 62:		Line 61:
	You might think "I want to separate the pages of this batch into individual folders", and assume the '''''Scope''''' would be ''Page''. This would be an incorrect assumption. With '''Separate''' you don't scope it to pages, you '''''Scope''''' it to either ''Batch'' or		You might think "I want to separate the pages of this batch into individual folders", and assume the '''''Scope''''' would be ''Page''. This would be an incorrect assumption. With '''Separate''' you don't scope it to pages, you '''''Scope''''' it to either ''Batch'' or
	''Folder''. The separation may be affecting the pages, but the activity itself is pointed at the container of the pages, not the pages themselves.		''Folder''. The separation may be affecting the pages, but the activity itself is pointed at the container of the pages, not the pages themselves.


	Setting the '''''Scope''''' to ''Batch'' is typical when pages have been physically scanned and they exist at the root of a '''Batch'''. This would separate the '''Batch Page''' objects of the '''Batch''' into '''Batch Folders'''.		Setting the '''''Scope''''' to ''Batch'' is typical when pages have been physically scanned and they exist at the root of a '''Batch'''. This would separate the '''Batch Page''' objects of the '''Batch''' into '''Batch Folders'''.


	Setting the '''''Scope''''' to ''Folder'' and the '''''Folder Level''''' to ''1'' (assuming there are documents at "Folder Level 1", and the '''[[Split Pages (Activity)\|Split Pages]]''' activity has been performed) is typical of digital documents that have been imported. This would separate the '''Batch Page''' objects of the "Folder Level 1" '''Batch Folders''' into '''Batch Folders''' that would exist at "Folder Level 2".		Setting the '''''Scope''''' to ''Folder'' and the '''''Folder Level''''' to ''1'' (assuming there are documents at "Folder Level 1", and the '''[[Split Pages (Activity)\|Split Pages]]''' activity has been performed) is typical of digital documents that have been imported. This would separate the '''Batch Page''' objects of the "Folder Level 1" '''Batch Folders''' into '''Batch Folders''' that would exist at "Folder Level 2".
Line 78:		Line 75:
	** '''''Folder Level''''': ''1''		** '''''Folder Level''''': ''1''
	This will create 5 ''Review'' '''[[Job\|Jobs]]''', one for each document at '''''Folder Level''''' ''1''. Each '''Job''' will have a single '''[[Task]]'''.		This will create 5 ''Review'' '''[[Job\|Jobs]]''', one for each document at '''''Folder Level''''' ''1''. Each '''Job''' will have a single '''[[Task]]'''.


	Conversely, assume the following:		Conversely, assume the following:
Line 85:		Line 81:
	** '''''Scope''''': ''Batch''		** '''''Scope''''': ''Batch''
	This will create one ''Review'' '''Job''' with 5 '''Tasks''' in that one job to confirm.		This will create one ''Review'' '''Job''' with 5 '''Tasks''' in that one job to confirm.


	This of course is a consideration of end users interacting with '''Review'''. Are five uers each individually assigned their own '''Review''' '''Job''' with a signle '''Task''', or is one user completing a single '''Job''' with five '''Tasks'''?		This of course is a consideration of end users interacting with '''Review'''. Are five uers each individually assigned their own '''Review''' '''Job''' with a signle '''Task''', or is one user completing a single '''Job''' with five '''Tasks'''?
Line 102:		Line 97:
	** '''''Processing Level''''': ''Level1''		** '''''Processing Level''''': ''Level1''
	This will create 2 ''Review'' '''Jobs''', one for each document at "Folder Level 2". Each '''Job''' would have a single '''Task'''.		This will create 2 ''Review'' '''Jobs''', one for each document at "Folder Level 2". Each '''Job''' would have a single '''Task'''.


	Conversely, assume the following:		Conversely, assume the following:
Line 111:		Line 105:
	** '''''Processing Level''''': ''Level2''		** '''''Processing Level''''': ''Level2''
	This will create the same amount of '''Jobs''' and '''Tasks''' as the above example.		This will create the same amount of '''Jobs''' and '''Tasks''' as the above example.


	Finally, assume the following:		Finally, assume the following: