Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Scanning Station scripts run automatically in response to events, or when the Operator invokes them manually. Automatic scripts are configured per batch type, and don’t run during Undo operations.

Automatic events

EventWhen it firesTypical use
On station startAfter Scanning Station starts.
Before station closeBefore Scanning Station closes.
On scanning session endWhen the scanning session completes.Modify the scanned batch according to custom rules.
On page addedAfter a page is added to a batch.Modify the page.
On batch createdAfter a batch is created (manually or automatically during scanning).Fill batch registration parameters; rename the batch per custom rules.
On document formedAfter a document is formed (manually or automatically during scanning).Fill document registration parameters; rename the document; look up a barcode value via an external component.
Before workspace element deletedBefore the user deletes an element.Prevent deletion of important elements.
Before page operationBefore a page modification is applied.Prevent modifications to pages that have already been modified. Details about the operation are available in the script.
After page operationAfter a page modification is applied.Save information about modified pages. Details about the operation are available in the script.
Before exportAfter registration parameters are defined, before the export task moves to the background. If the script fails, export doesn’t run and a predefined message is shown.Modify the batch before it’s sent.
After exportAfter the background export task finishes. Runs in the main application — if the application is closed when export completes, the script runs on next start.Modify the batch after export.

Manual events

Each batch type declares a named list of user-invoked scripts. An Operator picks a script from this list to run it on the opened batch. You can add any script from these lists to the user scripts toolbar as a separate button.
Toolbar customization is available both from the script list and from the main menu.
Scripts in the list can also be associated with an automatic event, so they run on explicit invocation and when the event fires.