2.72:Scope (Property): Difference between revisions

Latest revision as of 10:03, 5 August 2025

This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

2025

2023

The Scope property of a edit_document Batch Process Step, as it relates to an Activity, determines at which level in a inventory_2 Batch hierarchy the Activity runs.

Activities can run at different levels in a Batch.

They can run on the following:

Batch
Batch Folders within the batch (including document folders and generic folders)
Individual Batch Page level

About

One example of how scope is used in Grooper is seen below. In this example the Separate activity using the Undo Separation provider was run on a Batch containing multiple folder levels. The activity was run at three scope levels:

The Batch level
The first Batch Folder level
The second Batch Folder level

The original Batch with three Batch Folder levels	Undo Separation ran at the Batch scope. All folders are removed.	Undo Separation ran at Folder > Level 1 scope. All folders below the first level are removed.	Undo Separation ran at Folder > Level 2 scope. All folders below the second level are removed.

@@ Line 1: / Line 1: @@
-[[Activity|Activities]] can run at different levels in a [[Batch]].
+__NOINDEX__
+{{AutoVersion}}
+<blockquote>{{#lst:Glossary|Scope}}</blockquote>
+'''Activities''' can run at different levels in a '''Batch'''.
 They can run on the following:
-* [[Batch]]
+* '''Batch'''
-* [[Batch Folder]]s within the batch (including document folders)
+* '''Batch Folders''' within the batch (including document folders and generic folders)
-* Individual [[Batch Page]] level.
+* Individual '''Batch Page''' level
+== About ==
+One example of how scope is used in Grooper is seen below.  In this example the '''Separate''' activity using the '''''[[Undo Separation]]''''' provider was run on a Batch containing multiple folder levels.  The activity was run at three scope levels:
+# The '''Batch''' level
+# The first '''Batch Folder''' level
+# The second '''Batch Folder''' level
+{|cellspacing="5" cellpadding="10"
+|-valign="top"
+|The original '''Batch''' with three '''Batch Folder''' levels
+|Undo Separation ran at the ''Batch'' scope.
+*All folders are removed.
+|Undo Separation ran at ''Folder > Level 1'' scope.
+*All folders below the first level are removed.
+|Undo Separation ran at ''Folder > Level 2'' scope.
+*All folders below the second level are removed.
+|-valign="top"
+|[[image:undo separation 1.png|border|center|200px]]||[[image:undo separation 4.png|border|center|200px]]||[[image:undo separation 2.png|border|center|200px]]||[[image:undo separation 3.png|border|center|200px]]
+|}
+[[Category:Articles]]
+[[Category:Stub]]
+<!---EDITOR'S NOTE
+"Scope" is a broad concept.  As explained here, we're talking specifically about activity processing.  This information is critical to understanding how to property configure steps in a Batch Process.  This information absolutely should be present in a "Batch Process" or "Batch Processing Basics" article.
+This article either needs to be deleted OR this could be a more generalized "scope processing considerations" article, with sections devoted to:
-At which level the [[Activity]] runs is set by the "Scope" property.
+) Batch Processing Scope (what we got so far, but probably with re-writes)
+) Content Model Hierarchy Scope (important for hierarchical data extraction.  i.e. Data Models at Content Model, Content Category and Document Type levels)
+) Data Model Hierarchy Scope (important for Calculate/Validate Expressions, Data Rules, Database Lookups, Export Mappings etc)