WorkflowStateEnum (Web Services API)

WorkflowStateEnum enumeration constants are used to set the state of a workflow.

enum WorkflowStateEnum {
    WS_ApplyingSettings,
    WS_Crawling,
    WS_Finishing,
    WS_NotAvailable,
    WS_Processing,
    WS_ProcessingPublishingOnly,
    WS_StartingProcess,
    WS_Suspended
};

Elements
Name Description
WS_ApplyingSettings The state of a workflow after it has been started and before the processing has begun. At this stage, the program checks if it can access the folder that contains the input documents. This state is very short in duration and is not indicated in the console (the word "Starting" is displayed instead).
WS_Crawling At this stage, the program checks the folders of the Document Library workflow. It counts the files, adds them to the database, and prepares to process them. The word "Crawling" is displayed in the console.
WS_Finishing The state of a workflow when processing is coming to an end. At this stage, the program writes the files for the last time and completes publishing the large files. The words "Finishing Processing" are displayed in the console.
WS_NotAvailable The state of a workflow that is inaccessible. The words "Not Available" are displayed in the console, together with the reason why the workflow cannot be accessed.
WS_Processing The principal state of a workflow when files are being received, processed, and recognized. The word "Processing" is displayed in the console.
WS_ProcessingPublishingOnly The state of the Document Library workflow when the input folders have been crawled and the remaining jobs have to be published.
WS_StartingProcess The state of  workflow after the start command has been executed and before information about the beginning of processing has been returned. The word "Starting" is displayed in the console.
WS_Suspended The state of a workflow that has been stopped. The word "Stopped" is displayed in the console.
See also

Workflow

26.03.2024 13:49:49

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.