Activity

Represents a unit of work to be performed on objects in a Batch during a Batch Process Step.

Remarks

Overview

A Batch Processing Activity defines a discrete operation or task that is executed as part of a Batch Process Step within a Batch.
Activities can be either performed by a human operator (attended) or executed automatically by the Activity Processing service (unattended).

---

Activity Types

• Attended Activities:
  Require user interaction, such as reviewing or correcting data.
• Code Activities:
  Are performed automatically by the system, such as extraction, classification, or export.

---

Usage

Activities are configured as part of a Batch Process Step and determine the work performed on each Batch object.
Each activity can log custom statistics using the 'LogStatValue' method, and exposes a set of possible statistic names via the 'StatNames' property.

---

Best Practices

• Choose the appropriate activity type (attended or code) based on the required user involvement.
• Override the 'StatNames' property in derived classes to ensure all relevant statistics are available for logging and reporting.
• Use the 'ActivityStats' dictionary to track custom metrics for monitoring and optimization.

---

Related Concepts

• Batch: The collection of documents or items being processed.
• Batch Process Step: A stage in the batch process workflow, containing one or more activities.
• Activity Processing: The service responsible for executing code activities.

Derived Types

There are 37 implementations of Activity.

Review	Defines a human review activity to be performed on the Review Page within a Batch Process.
Cleanup & Recognition
Correct	Performs spell correction and word splitting on OCR text or extracted data fields.
Detect Language	Performs AI-based language detection using an LLM.
Detect Language (Legacy)	Detects the dominant language of each document or page, and marks it with the appropriate ISO culture code.
Image Processing	Applies permanent image cleanup to images in a Batch.
Recognize	Recognizes the internal content of a document or page, and saves the resulting data for use by subsequent activities.
Document Processing
Apply Rules	Applies one or more Data Rules to a document and updates the document metadata if changes are made.
Attach	Combines documents in a batch according to attachment markers set by Mark Attachments.
Classify	Automatically classifies documents by assigning a Document Type.
Convert Data	Converts a document to another Content Type.
Export	Exports document content files and/or data to an external system.
Extract	Performs data extraction on a document and saves the resulting Document Instance.
Fill Data	Executes one or more Data Fill Methods on Batch Folders to populate or enrich data fields according to configured logic.
Mark Attachments	Marks documents for attachment to neighboring documents using configurable rules for use by Attach.
Redact	Redacts information from the image associated with a Batch Page.
Separate	Separates a sequence of loose pages into documents.
Microform Processing
Clip Frames	Crops individual frames from a fiche card strip.
Detect Frames	Detects frame locations in a fiche card strip.
Initialize Card	Initializes a newly-imported fiche card.
Transform
Burst Book	Extracts individual page images from a photograph of a book, automatically splitting, cropping, and dewarping pages for downstream processing.
Merge	Merges the contents of all child objects to a multi-page file, and saves the result an attachment or custom file.
Render	Renders the attachment stored on a Batch Folder to PDF using the native application for the file type.
Split Pages	Splits a multi-page document into individual Batch Pages for downstream processing.
Split Text	Splits a text document into smaller documents using extractors or line counts.
Text Transform	Generates a text file from document data using a configurable template.
Translate	Translates the text content of a document into another language, generating a PDF output document in the target language.
XML Transform	Applies an XSLT transform to XML data associated with a Grooper document.
Utilities
Batch Transfer	Transfers a Batch to another Grooper repository using API Services.
Deduplicate	Detects and processes duplicate child documents using configurable comparison and disposition options.
Dispose Batch	Applies a disposition to Batches when they have completed processing.
Execute	Executes a sequence of commands and/or activities on Batch Folder, Batch Page, or Batch objects.
Launch Process	Launches an external process, and optionally waits for that process to terminate.
Remove Level	Removes one or more folder levels which exist below a Batch Folder or Batch.
Route	Routes a Batch or Batch Folder into a batch process based on its Content Type.
Send Mail	Sends an e-mail message using SMTP as part of a Grooper process.
Spawn Batch	Creates a new batch using a filtered set of folders from the current batch.
Train Lexicon	Creates a text file using the results of an extractor.

Used By

Batch Process StepProcessing Job