Processing scripts

What it does

Document and batch processing scripts allow you to change the document or batch structure respectively, specify a custom order of sections in the document or order of documents in the batch. Processing scripts can be added when creating a custom stage in the in the Advanced mode of the Workflow setup.

Both scripts are used to process multiple documents and have the possibility to log the processing progress.

Document processing script

All documents to be processed are passed to this script in turn.

Parameters

Name Type Access Description
Document IDocument Read/write The document to be processed
Processing IProcessingCallback Read/write The object for logging the information about processing

Note: If the task is cancelled, the processing status will change to false (similar to using the method IProcessingCallback.ReportError).

Batch processing script

The input parameters of the script are a batch and a set of documents in it to be processed. The iteration over documents is implemented by the user.

The advantage of the batch processing script is that the methods, which can change the batch structure, are available in it. These methods make it possible to move or delete documents and pages.

Parameters

Name Type Access Description
Batch IBatch Read-only. Internal* fields of batch documents and pages are unavailable. The batch
Documents IDocuments Read/write. For these documents the batch structure can be modified. Documents to be processed
Processing IProcessingCallback Read/write The object for logging the information about processing

* - The internal field requires loading the object into memory.

01.12.2020 7:03:59


Please leave your feedback about this article