Batch Folder Batch FolderA Batch Folder is a container object within the hierarchical structure of a Batch, which is used to represent logical folders and multipage documents.
Batch Folders may contain Batch Page objects or other folders as children.
Batch Folder objects may be created in a variety of ways. If a Separation Profile is assigned in the Scan activity, then folders will be created in real time during scanning. The Separate activity can be used to split an existing sequence of pages into folders using a variety of Separation Providers. When an Import Provider is used to ingest digital documents, or a digital document is pasted into Grooper, one folder object is created for each imported file. Users can also organize pages into folders using manual separation methods.
A Batch Folder which has a Document Type assigned is considered a document. The process of assigning a Document Type to a Batch Folder object is called classification. Folders may be classified automatically during separation, by executing the Classify activity on a pre-separated document, or by using the Batch Folder - Assign Document Type command to manually assign a Document Type.
When Batch Folder objects are created by importing digital documents through an Import Provider, a Content Link is stored on the folder which links the Grooper document to the document on the system of origin. The Document Export activity also provides an option to create a link at export time. This link can be used to update, move, or delete the document later in the process using the Execute activity.
Links also provide the ability to operate on documents without making a copy of each file in Grooper. If an Import Provider is configured to run in sparse mode, then a link will be created, but the actual content file will not be copied. The resulting document is called a sparse document. Grooper activities are all designed to operate on sparse documents the same way they work on regular documents, by dynamically fetching the content through the link each time it is needed.
Inherits from: Batch Object
The following 15 properties are defined.
| Property Name | Description |
|---|---|
| General | |
| Content Type | Type: Content Type
The content type assigned to this folder. |
| Has Index Data | Type: Boolean, Default: False
Indicates whether this folder has index data associated with it. |
| Index Data Valid | Type: Boolean, Default: False
Indicates whether the data saved on this folder is valid, or whether it has validation errors. This flag is set at the time index data is saved, and therefore indicates if the data was valid at the time it was saved. |
| Flagged | Type: Boolean, Default: False
Indicates that the item has been flagged for review. |
| Flag Reason | Type: String
The reason why the item has been flagged. |
| Description | Type: String
Generic property allowing an administrator to document the purpose of this Grooper Node. |
| Content Stream | |
| File Name | Type: String
Returns the Native Version filename, if a Native Version exists on this Batch Folder. |
| MIME Type | Type: String
The MIME type of the native file. |
| File Type Description | Type: String
A description of the native file type. |
| MIME Type Info | Type: MIME Type Handler
Custom information regarding the file type associated with this folder. |
| Has Local Copy | Type: Boolean, Default: False
Indicates whether the native file has been copied onto the folder object. |
| Has PDF Version | Type: Boolean, Default: False
Indicates whether this folder object has a PDF version. |
| Content Link | Type: Content Link
Defines a link to external document content. |
| Recognition | |
| Culture | Type: Culture Data
Indicates the primary culture of the text content. |
| Results | Type: Object
The output generated by the Recognize activity. |
| Command Name | Shortcut Keys | Description | |
|---|---|---|---|
 |
Add Multiple Items | Creates multiple items as children of the selected object. | |
 |
Batch Folder - Assign Document Type | Ctrl+Shift+A | Assigns a Document Type to the currently selected folder. |
 |
Clear Children | Deletes all children of the selected object(s). | |
 |
Batch Object - Clear Flag | Ctrl+Shift+L | Clears any existing flags on selected items. |
 |
Export to Zip Archive | Exports a set of Grooper nodes to a ZIP archive. | |
 |
Batch Object - File System | Exports the selected folders or documents to a file system directory. | |
 |
Batch Object - Flag Item | Ctrl+L | Marks the selected items as flagged. |
 |
Batch Object - Mail Recipient | Launches the default mail client, creating an email with the selected folders or documents attached. | |
 |
Batch Object - Printer | Prints the selected items to a printer device. | |
 |
Publish to Grooper Repository | Publishes one or more Nodes to one or more Target Grooper Repositories. | |
 |
Batch Folder - Remove Native Version | Deletes the locally-stored native file version from this folder object. | |
 |
Batch Object - Remove PDF Version | Deletes the Grooper-generated PDF version from this item. | |
 |
Batch Folder - Revert To Loose Pages | Moves all descendant page objects to the root of the folder, and deletes all subfolders. | |
 |
Batch Object - Test Batch | Appends a copy of the selected items to a test batch. | |
 |
Unpublish | Unpublishes a set of Grooper Nodes to a Target Grooper Repository. | |
 |
Batch Object - ZIP File | Exports the selected folders or documents to a ZIP archive. |
| Tab Name | Description |
|---|---|
| Batch Folder - General | Provides a user interface displaying the properties of a Batch Folder, a Batch Viewer for viewing and managing the children of the Batch Folder, and a Page Viewer for displaying the contents of the Batch Folder and its children. |
| Batch Folder - Index Data | Provides a user interface displaying all Index Data associated with the Batch Folder as well as an Image Viewer to display each Data Element. Only applicable if the Batch Folder is assigned a Document Type with an associated Data Model. |
| Batch Folder - Instance Viewer | Provides a user interface displaying Data Instances associated with a Batch Folder as well as a view of each data instance image, a text view, and an OCR Results View. Only applicable if the Batch Folder is assigned a Document Type with an associated Data Model. |
| Grooper Node - Scripting | Provides script viewing, compilation, management, and basic editing features. |
| Grooper Node - Contents | Provides a user interface for viewing and managing the children of a Grooper Node. |
| Grooper Node - Advanced | Displays detailed information about Grooper Node objects, and provides administrative functions for managing them. |
Content Link, Content Type, Culture Data, MIME Type Handler