Scripts
In ABBYY FineReader Server 14, you can use scripts to control the processing of your documents at various processing stages. Scripts are triggered by certain events that occur during document processing. You can use scripts to customize document separation, automate document identification and indexing, and control the handling of exported documents and failed jobs.
The following scripting languages are supported:
- JScript®
- VBScript
- C# .Net
- Visual Basic .Net
- JScript .Net
Note. To be able to use .NET scripts, you need ABBYY FineReader Server 14 Update 7 or later.
Overview
Each script receives a certain object as input. This object is termed the context object and its interface depends on the type of the script.
| Script Type | Interface | Where Executed |
|---|---|---|
| Input | IInputDocument | Processing Station |
| Separation | IRecognizedPage | Processing Station |
| Automatic Indexing | IDocumentToIndex | Processing Station |
| Initialize Index Fields | IDocumentAttributes | Processing Station or Indexing Station |
| Index Field Changed | IDocumentAttributesChanged | Indexing Station |
| Indexing Finished | IDocumentAttributesIndexingFinished | Indexing Station |
| Document Published | IPublishedDocument | Server Manager |
| Failed Job Published | IFailedJob | Server Manager |
For example, the context object of a Separation script has an IRecognizedPage interface, which provides access to the properties of a recognized page (e.g. Width, Height, Resolution, Text,etc.) and methods for interacting with a recognized page (e.g. RemoveAllBlocks).
See also: Complete list of available interfaces and descriptions of their methods and properties.
Logging
Each context object offers the following two logging methods:
- AddMessage(string) – This method adds an information message to the context object. Depending on the type of the script, the context object will be a job, a page or a document. The information message will be displayed in the job log and will also be added into the XML result.
- LogMessage(string) – This method records a message in the event log.
Example:
// Automatic Indexing script (C#)
doc.AddMessage("This message will be added to current document in the job.");
doc.LogMessage("This message will be recorded in the event log.");
This section describes how to:
3/26/2024 1:49:49 PM