│ Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Code Activity

Activity Grooper.Core

Represents an automated activity performed by code as part of a Batch Process.

Remarks

A Code Activity defines a unit of unattended work executed by the Activity Processing service within a Batch Process.
These activities are designed for automated processing of Batch Objects, such as image cleanup, recognition, extraction, or transformation, without requiring user intervention.

Purpose and Usage

  • Use a Code Activity to implement custom, automated logic that operates on Batch Objects.
  • Code Activities are executed by the Activity Processing service, typically as part of a Batch Process Step with an unattended scope.
  • Each Code Activity must override the ProcessTask method to define its processing logic.

Error Handling

  • The 'Error Disposition' property controls how errors are handled during execution:
    • Flag: The affected Batch Folder or Batch Page will be flagged for review.
    • Log: Errors are written to the Grooper event log.
    • Stop: Processing is halted, and the Batch is set to an error state.
  • The 'Maximum Consecutive Errors' property determines how many errors can occur before a critical stop is triggered.

Parallel Processing

  • The 'Concurrency Mode' property specifies whether the activity can be executed in parallel across multiple items.
  • This affects which Processing Queue the activity is submitted to and how tasks are distributed.

Integration and Extensibility

  • Code Activities are typically configured as part of a Batch Process Step, allowing them to be reused and composed into complex workflows.
  • Custom activities can be created by inheriting from this class and implementing the required logic.

For more information, see the documentation for Activity Processing, Batch Object, and Batch Process Step.

Properties

NameTypeDescription

Derived Types

There are 36 implementations of Code Activity.

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 JobBatch Object - Run ActivityExecute Activity

Notification