Batch Filter

Defines configurable criteria for filtering Batches in the Batch Manager and related user interfaces.

Remarks

A Batch Filter enables users to control which Batches are displayed or processed within Grooper modules and user interfaces, based on a set of selectable criteria. This allows for streamlined workflows, targeted review, and efficient batch management.

Overview

The filter operates by applying user-defined selections for properties such as 'Process', 'Step', 'Activity', 'Status', and 'Batch Name'. Only Batches that match all specified criteria are included in the results. If a property is left empty, it does not restrict the results for that criterion.

Configuration

• Process: Restricts results to Batches associated with the selected Batch Processes.
• Step: Restricts results to Batches currently at the specified Batch Process Steps.
• Activity: Restricts results to Batches whose current step executes the selected activities.
• Status: Restricts results to Batches with one of the selected processing statuses.
• Batch Name: Optionally, filter Batches by a partial or full name match (case-insensitive).
• Include Nested Batches: Optionally, include batches that are nested within other batches.

Usage

Configure one or more filter properties to focus on relevant Batches for your workflow. For example, to display only Batches in the "Invoice Processing" Batch Process, currently at the "Review" step, and with a status of "Ready" or "In Progress", select those values in the corresponding properties.

Notes

• The filter logic is inclusive: a Batch must match all specified criteria to be included.
• Available values for 'Process', 'Step', 'Activity', and 'Status' are dynamically populated based on the current repository configuration.
• Filtering by 'Activity' requires that the Batch Process Step has an associated activity.
• Filters can be combined for precise targeting, or left broad for general batch visibility.

> [!TIP] > Use Batch Filters to reduce clutter, streamline user tasks, and ensure that only relevant Batches are presented for review or processing.

Properties

Name	Type		Description
Process	List(Of String)[]	►	Restricts the view to batches for the provided Batch Processes. EditorProcess Editor ConverterFilter Converter Use the 'Process' property to filter the list of Batches by their associated Batch Processes. Only batches belonging to the selected processes will be shown or processed. Configuration Select one or more Batch Processes from the drop-down list. If left empty, batches from all processes are included. Impact Setting this property helps users focus on specific workflows or business areas, reducing clutter and improving task relevance. Example To show only batches in the "Invoice Processing" process, select "Invoice Processing" from the list.
Step	List(Of String)[]	►	Restricts the view to batches where the current step matches one of the selected steps. EditorStep Editor ConverterFilter Converter The 'Step' property filters Batches by their current Batch Process Step. Only batches currently at the selected steps will be included in the results. Configuration Choose one or more steps from the drop-down list. If left empty, batches at any step are included. Impact This property is useful for targeting batches at a specific stage in a workflow, such as "Review" or "Export", enabling focused processing or review. Example To display batches currently at the "Review" step, select "Review" from the list.
Activity	List(Of String)[]	►	Restricts the view to batches where the current step executes one of the selected activities. EditorActivity Editor ConverterFilter Converter The 'Activity' property filters Batches by the activity type of their current Batch Process Step. Only batches whose current step executes one of the selected activities will be shown. Configuration Select one or more activities from the drop-down list. If left empty, batches with any activity are included. Impact Use this property to focus on batches performing specific actions, such as "Extract" or "Classify". Example To show batches currently running the "Extract" activity, select "Extract" from the list.
Status	ProcessingStatus[]	►	Restricts the view to batches where the status is one of the provided values. EditorStatus Editor ConverterFilter Converter The 'Status' property filters Batches by their processing status, such as "Ready", "In Progress", or "Error". Configuration Select one or more statuses from the checklist. If left empty, batches with any status are included. Impact This property is useful for monitoring or acting on batches in a particular state, such as reviewing only those that are "Ready" or troubleshooting those in "Error". Example To display only batches with a status of "Ready" or "In Progress", select those statuses from the list.
Include Nested Batches	Boolean	►	Includes batches which are nested within other batches. DefaultFalse When enabled, the 'Include Nested Batches' property allows the filter to include batches that are contained within other batches. Configuration Set to true to include nested batches. Set to false to exclude them (default). Impact Use this property to control whether sub-batches or nested batch structures are visible in the results. This is helpful when working with complex batch hierarchies or when only top-level batches are relevant. Example To include all nested batches in the batch list, enable this property.