Batch

The 'Content Type' property determines the primary classification for this Batch Folder, controlling its data extraction, validation, and workflow behavior.

Purpose

• Assigning a Content Type enables the folder to participate in classification, extraction, and validation activities according to the associated Data Model.
• The Content Type also determines the folder's icon and whether it is treated as a document or a container in the batch hierarchy.
• Changing the Content Type may affect the available data fields, extraction logic, and downstream processing.

Usage

• Set this property to classify the folder as a specific document or content category.
• Use the Batch Folder - Assign Document Type command or automated classification activities to update this value.

Related Concepts

• Content Type: Defines the schema, extraction logic, and behaviors for documents and folders.
• Data Model: The set of data elements and validation rules associated with the content type.
• Batch Folder - Assign Document Type: Command for manual classification.
• Classify and Extract activities: Automated processes that use this property.

The 'Secondary Types' property allows a Batch Folder to be classified under multiple Content Types in addition to its primary type.

Purpose

• Secondary types enable extraction and validation for additional Data Models, supporting scenarios where a document may belong to multiple categories or require multiple schemas.
• Data for each secondary type is stored and managed independently, and can be accessed or exported as needed.

Usage

• Add secondary types to support multi-classification, composite documents, or cross-functional extraction requirements.
• Secondary types can be managed programmatically or via the property grid.

Related Concepts

• Content Type: Each secondary type provides its own schema and extraction logic.
• Data Model: Data is extracted and validated for each assigned type.
• Batch Folder: Supports both primary and secondary classification for flexible document processing.

The 'Flagged' property is used to mark a Batch Object for attention during batch processing.

• When set to true, the item is visually indicated in user interfaces and may be filtered or routed for review.
• Use the 'Flag Reason' property to provide additional context for why the item was flagged.
• Flagging is commonly used to identify exceptions, errors, or items requiring manual intervention.

You can set or clear this property programmatically, or via commands in the UI.

The 'Flag Reason' property provides a human-readable explanation for why the Batch Object was flagged.

• This property is only visible when 'Flagged' is set to true.
• Use this field to document the specific issue, exception, or review note associated with the item.
• The value is displayed in review interfaces and can be used for filtering or reporting.

Can be one of the following types:

The 'Culture' property specifies the language and locale used for the text content of this Batch Object.

• This affects OCR, extraction, and validation processes that are culture-sensitive.
• The value is typically set automatically during OCR or import, but can be changed manually if needed.
• The Detect Language activity can also be used to set the Culture.
• Use this property to ensure correct language processing, especially in multilingual batch environments.

The culture is represented as a Culture Data object, and is stored as a culture code (e.g., en-US).

The 'Process' property links the batch to a specific Batch Process, which defines the workflow and activities to be performed on the batch.

• The Batch Process determines the sequence of Batch Process Steps and the overall processing logic.
• Changing the process will affect the available steps and activities for this batch.
• This property is typically set at batch creation, but can be changed if needed.

How to Change the Batch Process

• The batch process can be changed using the Batch - Update Process command.
• Important: The batch must be paused before the process can be changed.

Use this property to review or update the workflow assigned to the batch.

The 'Step' property indicates the current step in the Batch Process workflow for this batch.

• This property determines which activity is currently being performed or is next in the workflow.
• The value can only be changed when the batch is paused.
• Use this property to manually advance or reset the batch to a different step if needed.

How to Change the Current Step

• The current step can be changed directly by setting this property.
• The step is also updated automatically when the batch process is changed using the Batch - Update Process or Batch - Reset commands.
• Important: The batch must be paused before the current step can be changed.

The available steps are defined by the associated Batch Process.

The 'Activity' property displays the name of the activity being performed at the current Batch Process Step.

• This value is determined by the configuration of the current step in the Batch Process.
• It provides a quick reference to the type of work being performed (e.g., "Recognize", "Extract", "Review").
• If no step is selected, the value will be "(none)".

Use this property to monitor the current processing activity for the batch.

Can be one of the following values:

The 'Status' property indicates the current processing state of the batch.

• The status is updated automatically as the batch progresses through its workflow.
• Use this property to determine if the batch is actively processing, waiting, or requires attention.

The status affects which actions are available and may control access to certain properties.

The 'Priority' property controls the order in which batches are processed.

• Lower values are processed first; higher values are processed later.
• Adjust this property to expedite or delay processing of specific batches.
• Priority can be set at creation or updated while the batch is paused.

How Priority Is Established at Import

• When a batch is created via an import provider, the initial priority is set using the 'Priority' property of Batch Creation Settings.
• Import settings may also enable automatic incrementing of the priority for each successive batch (see the 'Increment Priority' property of Batch Creation Settings).
• This allows control over the processing order of batches as they are imported.

Use this property to manage workload and ensure critical batches are handled promptly.

The 'Created' property records the timestamp when the batch was initially created.

• This value is set automatically and is read-only.
• Use this property for auditing, reporting, or tracking batch age.

The creation date can help prioritize or filter batches in large repositories.

The 'Created By' property identifies the user who created the batch.

• This value is set automatically at batch creation.
• Use this property for auditing, accountability, or filtering batches by creator.

The user id may be mapped to a display name using the 'Created By Display Name' property.

This property reflects the Batch Process associated with the current value of 'Pending To Step'.
It is primarily used in conjunction with the Route activity, which enables dynamic, rule-based routing of batches and documents into specific workflows.

How It Works

• The Route activity evaluates a set of Route Definitions to determine the appropriate downstream Batch Process and step for each batch or document.
• When a batch is routed, the 'Pending To Step' property is set to the target Batch Process Step as determined by the routing rule.
• 'Pending To Process' automatically resolves to the Batch Process that owns the selected step, providing a clear indication of the destination workflow.

Usage

• This property is read-only and is intended for informational and workflow configuration purposes.
• It is commonly used in user interfaces and automation scripts to preview or confirm the routing destination before the routing is executed.
• When routing is applied (for example, when the batch is resumed or the routing command is executed), the batch is updated to use this Batch Process and the specified step, and the routing properties are cleared.

> Note:
> The value of this property is only meaningful when 'Pending To Step' is set. If no routing is pending, this property will be null.

This property specifies the target Batch Process Step for routing operations and is typically set by the Route activity.

The Route activity evaluates routing rules (defined as Route Definitions) and, when a match is found, sets 'Pending To Step' to the first step of the destination Batch Process.

How It Works

• During execution of the Route activity, if a batch or document matches a routing rule, 'Pending To Step' is set to the appropriate step in the target Batch Process.
• This indicates that the batch is pending a move to a new workflow and step, but the routing is not applied until the batch is resumed or the routing command is executed.
• The 'Pending To Process' property will automatically reflect the Batch Process associated with the selected step.

Usage

• Set by the Route activity to stage a batch for routing into a new process and step.
• Can be reviewed or modified by users or automation scripts before routing is finalized.
• When routing is applied, the batch is updated to use the selected process and step, and both 'Pending To Step' and 'Pending To Process' are cleared.

Typical Workflow

1. The Route activity evaluates routing rules and sets 'Pending To Step' (and thus 'Pending To Process') for batches or documents to be routed.
2. The batch remains in its current state until routing is applied (typically when the batch is resumed or a routing command is executed).
3. Upon routing, the batch is moved to the specified process and step, and processing resumes from that point.

> Note:
> This property is essential for advanced workflow scenarios such as post-classification routing, exception handling, and workflow segmentation.
> If no routing is pending, this property will be null.

This is the name of the file attached to the Batch Folder, if any.

• The attachment may represent a digital document, image, or other file type.
• This value is used for file management, export, and reporting.

If no attachment is present, this property is empty.

The MIME type describes the format of the attached file, such as application/pdf or image/tiff.

• Used to select the appropriate Attachment Type for processing.
• If not explicitly set, Grooper will infer the MIME type from the file extension.

Displays the size of the attached file, if present.

• Useful for monitoring storage usage and verifying file integrity.
• If no attachment is present, this value is 0 bytes.

The 'Attachment Type' property exposes the Attachment Type which is most appropriate for the attached file.

Purpose and Role

• The Attachment Type determines the available commands and metadata for the attached file.
• It provides a unified interface for interacting with a wide variety of file formats, including PDF, Word, Excel, images, archives, and more.
• The Attachment Type is selected automatically based on the file's extension and/or MIME type.

Commands and Automation

• Each Attachment Type exposes a set of context-sensitive commands (such as "Convert to PDF", "Remove PDF Version", "Rename Attachment", or custom actions) that can be executed manually via the UI or programmatically using the Execute activity.
• These commands are surfaced in the context menu for the file and can be targeted in automation workflows for batch processing, conversion, or integration scenarios.
• Developers can extend Grooper by creating custom Attachment Types in an Object Library, by inheriting a class from MimeTypeHandler.

Metadata and Expressions

• Properties exposed by the Attachment Type (such as file name, MIME type, page count, author, etc.) are available for use in expressions, Data Fields, Data Actions, and Export operations.
• This enables dynamic extraction, reporting, and automation based on file-specific metadata.

Usage Notes

• The Attachment Type is automatically determined and updated whenever the attachment is set or changed.
• For advanced scenarios, custom Attachment Types can be registered to handle proprietary or specialized file formats.
• Use this property to access file-type-specific features, commands, and metadata in both manual and automated workflows.

Related Concepts

• Batch Folder: The container for documents and attachments.
• Attachment Type: Exposes metadata and commands for specific file types.
• Command: Actions exposed by the Attachment Type for file management and processing.
• Execute activity: Used to automate command execution on attachments.
• Data Field, Data Action, Export: Can access attachment metadata for automation and reporting.

For more information, see the documentation for Attachment Type, Batch Folder, and Execute activity.

The 'Has Local Attachment' property determines if the file attached to this Batch Folder is physically stored within the Grooper repository, or if it is referenced externally using a Content Link.

Local vs. Sparse Attachments

• If this property returns true, the attachment file is present and accessible directly from the Grooper file store.
• If it returns false, the attachment is considered sparse: the file is not stored in Grooper, but is instead referenced by a Content Link (such as a Document Link) that points to an external location (e.g., a file share, CMIS repository, or mail server).

Sparse Documents and Import Provider

Sparse documents are created when importing content using an Import Provider with the "Sparse Import" option enabled. In this mode, Grooper does not copy the file into its repository. Instead, it creates a Content Link on the Batch Folder that records the external file's location and metadata. This approach is ideal for high-volume or integration scenarios where duplicating content is unnecessary or undesirable.

• Benefits of Sparse Import:

  • Reduces storage requirements by avoiding file duplication.
  • Enables rapid ingestion of large document sets.
  • Supports integration with external content management systems.

• How It Works:

  • During import, the Import Provider creates a Content Link (typically a Document Link) and attaches it to the Batch Folder.
  • The actual file remains in its original location; Grooper loads or processes the content on demand via the link.

Working with Sparse Attachments

• When a Batch Folder has a sparse attachment, Grooper will automatically use the Content Link to access the file as needed for processing, viewing, or export.
• Many activities and commands (such as Extract, Export, or Remove Attachment) are designed to work seamlessly with both local and sparse attachments.
• You can convert a sparse attachment to a local one by explicitly importing or copying the file into Grooper, or remove the link to detach the reference.

Usage Notes

• Use this property to determine if a file is available locally for immediate access, or if Grooper must retrieve it from an external source.
• For workflows that require all content to be stored within Grooper, ensure this property is true before proceeding with file-dependent operations.
• For integration or storage-optimized workflows, leverage sparse attachments and Content Links to minimize repository size and maximize flexibility.

For more information, see the documentation for Content Link, Import Provider, and Export Definition.

The 'Has PDF Version' property determines if a Batch Folder currently has a PDF rendition available for its attachment.

How PDF Versions Are Determined

• Returns true if either:
  • The folder's attachment is a native PDF (i.e., the original file is a PDF), or
  • A Grooper-generated PDF rendition exists and is stored in the repository as Grooper.PdfVersion.pdf.
• Returns false if neither condition is met.

Native vs. Generated PDF Versions

• Native PDF:
  If the original attachment's MIME type is application/pdf or its file extension is .pdf, the folder is considered to have a native PDF version. In this case, the PDF is available directly from the original attachment.
• Generated PDF:
  If the attachment is not a native PDF, Grooper can generate a PDF rendition using built-in conversion commands and activities. The generated PDF is stored as a supplemental file and can be accessed or exported as needed.

How PDF Versions Are Created

PDF versions can be created in several ways, depending on the type of the original attachment:

• Image and Multi-Page Documents:
  The RenderDocument process is used to convert images or multi-page documents (such as TIFFs) into a PDF rendition. This process assembles the images into a single PDF file, preserving page order and image quality.

• HTML Documents:
  The HTML Document - Convert to PDF command leverages the WebKit rendering engine to convert HTML content to PDF. This supports a wide range of HTML and CSS, and allows configuration of page size, orientation, margins, and image quality. The resulting PDF can be saved as a new rendition, replace the original attachment, or be added as a supplemental file.

• Microsoft Word and Related Formats:
  The Word Document attachment type provides the Word Document - Convert to PDF command, which uses Microsoft Office Interop to open and convert Word documents (.doc, .docx, .rtf, etc.) to PDF. The resulting PDF is attached to the Batch Folder as the PDF version, enabling standardized export and downstream processing.

Notes

• Attachment Type exposes a "Remove PDF Version" command which can be used to delete a generated PDF rendition.
• The presence of a PDF version does not guarantee that the content is identical between the native and generated versions; always verify the source if fidelity is critical.
• If a PDF version is not present, you may use Grooper's conversion commands or activities (such as Render, HTML Document - Convert to PDF, or Word Document - Convert to PDF) to generate one as needed.
• For more information, see the documentation for Batch Folder, Attachment Type, Render, HTML Document - Convert to PDF, Word Document, and Export Definition.

The 'Links' property contains all Content Links associated with this Batch Folder, including references created during import, export, or file bursting operations.

Purpose and Usage

• Content Links enable Grooper to reference external content (such as files on a file system or documents in a CMIS Repository) without duplicating the file in the repository.
• This property supports scenarios such as sparse import, external content management, and export tracking.
• The most recent link is available as 'Content Link', and the original import link (if present) is available as 'Import Link'.

Command Execution on Links

• Commands can be executed on individual links in this list using the Execute activity configured with an Execute Command` step.
• Link commands can be access via the context menu in user interface.
• Execute Command class allows you to specify a command (such as "Remove Link", "Update Link", or custom commands defined on the Content Link type) and target a specific link by name.
• This enables advanced automation scenarios, such as removing obsolete links, updating references after export, or triggering custom integration logic for external content.

Management and Integration

• Links are managed automatically during import and export, but can also be added or removed via user commands.
• The collection supports manual manipulation for advanced integration, migration, or cleanup scenarios.
• Each Content Link in the list exposes its own set of properties and commands, which can be accessed and executed individually.

Related Concepts

• Content Link: Represents a reference to external content.
• Import Provider: May create links during sparse import.
• Export Definition: May generate links to exported content.
• Execute activity: Used to automate command execution on links via ExecuteCommand.

For more information, see the documentation for Content Link, Import Provider, Export Definition, and Execute activity.