Events

Reference of the events that can trigger Scanning Station scripts, and what each is typically used for.

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

Event	When it fires	Typical use
On station start	After Scanning Station starts.
Before station close	Before Scanning Station closes.
On scanning session end	When the scanning session completes.	Modify the scanned batch according to custom rules.
On page added	After a page is added to a batch.	Modify the page.
On batch created	After a batch is created (manually or automatically during scanning).	Fill batch registration parameters; rename the batch per custom rules.
On document formed	After 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 deleted	Before the user deletes an element.	Prevent deletion of important elements.
Before page operation	Before 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 operation	After a page modification is applied.	Save information about modified pages. Details about the operation are available in the script.
Before export	After 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 export	After 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.

Related topics

• Using scripts
• Objects available from event scripts
• Configuring scripts
• Administrator mode