Events

Executed after the station is started.

Executed before the station is closed.

Executed upon completion of the scanning session. Scripts of this type are intended for modified a scanned batch according to custom rules.

Executed after adding a page to the batch. Scripts of this type are intended for modifying a page.

Executed after a batch has been created manually or automatically during scanning. Scripts of this type are intended for filling registration parameters of the batch, renaming the batch according to custom rules, etc.

Executed after a document has been formed manually or automatically during scanning. Scripts of this type are intended for filling registration parameters of the document, renaming the batch according to custom rules, search for a barcode value with an external component, etc.

Executed before the element is deleted by the user. Scripts of this type are intended to prevent deleting important elements.

Executed before the user applies a page modification operation. Scripts of this type are intended to prevent modifying pages which are modified already. Information about the operation being executed is available in this script.

Executed after the user applies a page modification operation. Scripts of this type are intended to save information about modified pages. Information about the operation being executed is available in this script.

Executed before the task is sent to background, but after the batch registration parameters are defined. If the call fails, the export task is not performed and a predefined message is displayed to the user. Scripts of this type can modify the batch.

Executed after the export task is completed in the background, but unlike the export task the script is executed in the main application. If the main application is closed at the moment of export completion, the script will be executed with the next start of the station. Scripts of this type can modify the batch.

You can check whether the export succeeded using the script parameters "IsExported" and "ExportError".

Executed in the background similar to other types of export. Scripts of this type cannot modify the batch, they can only return the result path and/or the cause of the fail and the list of exported elements of the batch. The list and the path will be available for the script if the export is resumed.

Scripting export is set up in the batch type on the export tab.

A named list of scripts is declared in the batch type. You can select a desired script to be executed from this list when calling a corresponding command for the opened batch.

Scripts from lists of any type can be added as a separate button to an additional user scripts toolbar.

Note. Toolbar customization can be called both from the list of scripts and from the main menu.

In the list of scripts it is also possible to assign an event that triggers the script.