| Event | Description |
|---|---|
| Automatic call when the station starts | Runs after the station starts. |
| Automatic call before the station closes | Runs before the station closes. |
| Automatic call when a scanning session completes | Runs when the scanning session completes. Use these scripts to modify a scanned batch with custom rules. |
| Automatic call when a page is added | Runs after a page is added to the batch. Use these scripts to modify a page. |
| Automatic call when a batch is created | Runs after a batch is created manually or automatically during scanning. Use these scripts to fill the batch registration parameters, rename the batch with custom rules, and so on. |
| Automatic call when a document is formed | Runs after a document is formed manually or automatically during scanning. Use these scripts to fill the document registration parameters, rename the batch with custom rules, search for a barcode value with an external component, and so on. |
| Automatic call before a workspace element is deleted | Runs before the user deletes the element. Use these scripts to prevent deletion of important elements. |
| Automatic call before a page operation | Runs before the user applies a page modification. Use these scripts to prevent modification of pages that were already modified. The script can access information about the operation. |
| Automatic call after a page operation | Runs after the user applies a page modification. Use these scripts to save information about modified pages. The script can access information about the operation. |
| Automatic call before export | Runs before the task is sent to the background but after the batch registration parameters are defined. If the call fails, the export task does not run and the user sees a predefined message. These scripts can modify the batch. |
| Automatic call after export | Runs after the background export task completes, but unlike the export task, the script runs in the main application. If the main application is closed when export completes, the script runs at the next station start. These scripts can modify the batch. Check whether the export succeeded with the IsExported and ExportError script parameters. |
| Additional export type | Runs in the background like other export types. These scripts cannot modify the batch; they can only return the result path, the failure reason, and the list of exported batch elements. The list and path are available to the script if the export is resumed. Set up scripting export on the Export tab of the batch type. |
| Call by an explicit user command | A named list of scripts is declared in the batch type. Select a script to run from this list when you call the corresponding command for the open batch. You can add scripts from any list as a separate button on a user scripts toolbar, and you can assign an event that triggers the script. Toolbar customization is available from both the script list and the main menu. |
Using Scripts in ABBYY Scanning Station
Events
Script events in the ABBYY Scanning Station: automatic calls on station start, scanning completion, batch creation, page operations, export, and more.
You configure automatic scripts in the batch type, and they do not run during Undo operations.
You can handle the following events with scripts: