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

Route

Code Activity Grooper.Activities

Routes a Batch or Batch Folder into a batch process based on its Content Type.

Remarks

The Route activity enables dynamic, rule-based branching of both Batches and Batch Folders into specific workflows within Grooper.

Overview

Route evaluates the Content Type of each Batch or Batch Folder and applies the first matching Route Definition from the configured list.
This allows you to direct entire batches or individual folders into different Batch Processes based on classification, business rules, or custom logic.

How Routing Works

  • Each Route Definition specifies a Content Type to match, a destination Batch Process, and optional conditions using a boolean trigger expression.
  • Routes are evaluated in order. Only the first matching route is applied to each batch or folder.
  • Items can be moved or cloned into the target batch. Cloning retains the original for audit or parallel processing.
  • Routed batches can be started in a paused state for review or further configuration.
  • If no route matches, the item remains in its current batch or process.

Data Transformation

  • When routing between different Content Types, you can define Data Actions to map, copy, or transform data fields as part of the process.
  • This supports scenarios where the source and target Content Types have different data models or require normalization.

Example Scenarios

  • Batch-Level Routing: Route entire batches to different processes after initial import or classification.
  • Folder-Level Routing: Route individual folders (documents) within a batch to specialized workflows, such as exception handling or parallel processing.
  • Post-Classification Routing: After classification, send invoices and contracts to different Batch Processes for specialized handling.
  • Exception Handling: Route unclassified or exception documents to a dedicated Batch Process for manual review.
  • Parallel Processing: Clone documents or batches into multiple workflows for audit, export, or additional processing.

Batch-Level Routing with Cloning Disabled

When the Route activity operates at the batch level and cloning is disabled in the Route Definition, the routing logic leverages the routing functionality of the Batch object. This ensures that the current step (which is executing this activity) can complete without interruption, while still allowing the batch to be routed to a new Batch Process and step as defined by the routing rules.

  • The batch is moved to the target folder, and its routing properties — 'Pending To Step' and 'Pending To Process' — are set to indicate the target Batch Process and step as determined by the routing rule.
  • The batch remains in its current state until routing is applied (typically when the batch is resumed or a routing command is executed).
  • When routing is applied, the batch is updated in-place to use the new Batch Process and step, and any configured Content Type or Data Actions are applied as specified by the Route Definition.
  • This approach enables seamless workflow transitions for entire batches without the overhead of moving or cloning data, and supports advanced scenarios such as post-classification routing, escalation, or workflow segmentation.

Configuration Tips

  • Order your Route Definitions from most specific to most general to ensure correct routing.
  • Use the 'Clone' option to retain originals when needed for compliance or parallel workflows.
  • Use the 'Start Paused' option to allow for human review or additional configuration before processing.

> Note:
> The Route activity can be configured to operate on either Batches or Batch Folders, depending on the processing scope.
> This flexibility enables advanced workflow automation and process segmentation in Grooper.

Properties

NameTypeDescription
General
Processing Options

See Also

Used By

Notification