EzeScan WebApps

Pre-Processing

Purpose

Pre-processing consists of one or more confirgurable automated stages that are executed before a document progresses through the workflow. Multiple pre-processors can be configured, with each stage performing a specific task such as document preparation, classification, validation, or data enrichment.

Screenshot 2026-07-23 at 12.51.52 pm.png

Adding/Removing/Editing Pre-Processors

Button/Icon

Functionality

Description

Screenshot 2026-07-23 at 1.06.28 pm.png

Add a New
Pre-processors

Select a pre-processor from the drop-down list to add it to the current pre-processor configuration. Alternatively, existing pre-processor configurations can be imported using the Import from JSON option available within the drop-down menu.

Add newly added pre-processors will be added to the bottom of the list

Screenshot 2026-07-23 at 1.09.22 pm.png

Copy

Copies the selected pre-processor configuration in JSON format, allowing it to be reused or imported elsewhere.

Screenshot 2026-07-23 at 1.09.56 pm.png

Delete

Removes the selected pre-processor from the configuration. This action cannot be undone.

Screenshot 2026-07-23 at 1.10.35 pm.png

Re-order

Controls the order in which pre-processors are executed. Pre-processors run in the same order they appear in the list and can be repositioned using drag-and-drop.

Types of Pre-Processors

Name

Description

Add Note

Adds a sticky note to each item processed.

Auto Process

Automatically triggers a specified action.

Azure Content Understanding

Uses AI to extracts data from documents using field names configured on the Fields tab.

Azure Document Intelligence

Analyses documents using Azure Document Intelligence to extract key-value pairs, tables, and other document data.

Azure Open AI

Uses AI to extracts data from documents using a prompt.

Barcode Recognizer

Detects barcodes within a document and returns the decoded values as metadata.

Classify Document

Send the document to the configured DCA engine to either predict or classify the document.

Condition

Conditionally skips the execution of subsequent pre-processors.

Count Document Pages

Counts the number of pages in a document.

Delete Pages

Removes selected pages from a document before further processing or output generation.

Download Links

Downloads documents referenced by hyperlinks within a document, commonly from emails.

Duplicate Item

Creates a copy of a document for processing through multiple application pages or workflows.

EzeScan Server

Routes a document to EzeScan Server for additional processing not available within EWA.

File Converter

Converts supported file formats to PDF.

Increment Counter

Increments an Authority Server counter value.

Map Metadata

Maps metadata values produced by previous processing stages to RIA fields.

Merge Attachments

Merges document attachments into a single document for further processing.

Move Pages

Reorders pages within a document before further processing.

OCR

Generates a text searchable layer for the document.

PDF Compliance

Converts standard PDF files into PDF/A-2b compliant documents.

PDF Document Properties

Used to modify PDF properties such as Document Title, Document Subject, Document Author, and Document Keywords.

Identify Information

Identifies and locates certain types of information within a document. This is typically used to find dociments containing PII or credit card numbers.

Rename Item

Changes the name of the indexing item.

Run Query

Executes SQL queries to retrieve, insert, update, or delete data.

Split Document

Splits a document into multiple smaller documents.

Update Metadata

Modifies and cleanses metadata generated by previous processing stages.

From JSON

Imports a pre-processor configuration from a previously exported JSON file.


Common Pre-Processor Settings

When creating a pre-processing stage you have the following common settings:

Option

Description

Name

This is the name of the pre-processing stage. It is displayed to the end user.

Description

This is a friendly description of the pre-processing stage that is only visible in the admin panel.

Enabled

If enabled then this pro-processor will be executed.

Short Name

This field provides unique identification for the stage.

If an item has already executed a pre-processor with the same short name then the stage will be skipped.

This field is commonly used in combination with the Run pre-processors option.

For example say you have two indexing pages with the following pre-processors configured:

Correspondence
Document Split (short name: split)
Clean-up (short name: cleanup)

Invoices
Document Split (short name: split)
Document Clean-up (short name: cleanup)
Extract Invoice Data (short name: extract-invoice)

If an invoice incorrectly arrived into the correspondence page then it would fire off and run the Document Split and Clean-up pre-processors on the item.

image-20230130-035520.png

When a user then routes the item to the correct Invoices page we want to ensure it triggers the pre-processing again.

image-20230130-035837.png

But this time because the short names are the exact same the item will actually skip the first two stages and jump straight to the Extract Invoice Data stage.

image-20230130-035943.png


You can see which stages (that have short names configured) have been already run on the item by opening the history for an item and looking at the Metadata tab.

image-20230130-035103.png

Skip on failure

If this stage returns a failure result, then automatically continue on to the next stage. The is turned off by default.

Configuration settings specific to each pre-processor are documented in the associated child pages.

Pre-Processors in Action on a RIA Page

How Pre-Processors Are Displayed in a Queue

When a document enters a RIA queue and has pre-processors configured, the document is sent for pre-processing before it can be viewed by the end user. While pre-processing is in progress, a blue Running badge is displayed in the queue.

The status indicators displayed alongside the Running badge show the progress of each configured pre-processor. During this time, the View button is disabled until processing has completed.

Screenshot 2026-07-23 at 1.29.57 pm.png

Once all pre-processors have finished, the View button is re-enabled and the pre-processor status indicators are removed from the queue.

Screenshot 2026-07-23 at 1.38.55 pm.png

Icon

Stage Description

Screenshot 2026-07-23 at 1.47.02 pm.png

The pre-processor has been skipped.

An example of where this might occur is when an OCR pre-processor is used and configured to skip this step if a text layer is already detected

Screenshot 2026-07-23 at 1.49.37 pm.png

The pre-processor is currently being executed.

Screenshot 2026-07-23 at 1.48.22 pm.png

The pre-processor has completed successfully.

Screenshot 2026-07-23 at 1.50.06 pm.png

The pre-processor is waiting to be executed.

Detailed Pre-Processing View

Selecting a running pre-processor from the queue, or clicking the pre-processor icon at the top of the table, opens the Pre-Processing view.

Screenshot 2026-07-23 at 1.51.24 pm.png

This screen provides a detailed overview of all configured pre-processors, including their current status and any completed processing steps. Expanding a pre-processor displays additional information about the action being performed. Users can also select individual stages to view the corresponding log file.

Screenshot 2026-07-23 at 1.53.20 pm.png

Stopping, Skipping, or Retrying Pre-Processors

Users and managers can cancel or retry a pre-processor. The ability to skip a pre-processor is restricted to managers.