Click or drag to resize

DocumentTaskEngine Properties

The DocumentTaskEngine type exposes the following members.

Properties
 NameDescription
Public propertyCurrentNumberOfArchivesInProcess If a task is running, returns the current number of archives (Zip/7zip/Tar/Rar/etc) currently being processed.
Public propertyCurrentNumberOfDatabasesInProcess If a task is running, returns the current number of databases currently being processed.
Public propertyCurrentNumberOfLargeDocumentsInProcess If a task is running, returns the current number of "large" documents currently being processed. "Large" documents are defined by LargeDocumentCritera.
Public propertyCurrentNumberOfMailStoresInProcess If a task is running, returns the current number of mail stores (PST/OST/MBOX/etc) currently being processed.
Public propertyDocumentMetadataToFileStoreQueueCount If a task is running, returns the current number of documents waiting have their extracted metadata written to file store. This is the last step for a processed document.
Public propertyEmbeddedAndTextToFileStoreQueueCount If a task is running, returns the current number of extracted embedded documents and documents with extracted text waiting to be written to file store.
Public propertyExtractedDocumentQueueCount If a task is running, returns the current number of extracted documents waiting to be processed.
Public propertyInputDocumentQueueCount If a task is running, returns the current number of documents waiting to be read for processing.
Public propertyIsFileStoreWriterComplete Returns true if a task is currently running and the task has completed writing all attachments and extracted text to ar or flat files; false if still busy or a task is not running.
Public propertyIsolateCorruptDocument RESERVED - DO NOT USE OR SET PROPERTY. Reserved for internal testing.
Public propertyIsProcessingDocumentsComplete Returns true if a task is currently running and the task has completed processing all documents; false if still busy or a task is not running.
Public propertyIsReadingDocumentComplete Returns true if a task is currently running and the task has completed reading all the input documents; false if still has documents to read or a task is not running.
Public propertyIsTaskRunning True if a task is currently being executed via a previous call to method RunTask.
Public propertyLargeDocumentQueueCount If a task is running, returns the current number of "large" documents that require special processing that are waiting to be processed. "Large" documents are defined by LargeDocumentCritera.
Public propertyNumInputDocuments If a task is running, returns the total number of input documents to be processed for this task.
Public propertyProcessedDocuments If task is currently running, returns null. If task has finished running this property returns the input document hierarchy, that is extracted children documents (embedded, attachments, and container items) are populated (if any) in ChildDocuments.
Public propertyReadDocumentQueueCount If a task is running, returns the current number of documents read and waiting to be processed.
Public propertyTaskPercentComplete If a task is running, returns the task's estimated percent complete (0-100).
Public propertyTotalArchivesProcessed If a task is running, returns the total number of archives (Zip/7zip/Tar/Rar/etc) that have currently been fully processed.
Public propertyTotalDatabasesProcessed If a task is running, returns the total number of databases that have currently been fully processed.
Public propertyTotalDocumentsProcessed If a task is running, returns the total number of documents that have currently been fully processed (includes extracted embedded and container items).
Public propertyTotalInputDocumentsProcessed If a task is running, returns the total number of input documents to task that have currently been fully processed (does NOT include extracted embedded and container items).
Public propertyTotalMailStoresProcessed If a task is running, returns the total number of mail stores (PST/OST/MBOX/etc) that have currently been fully processed.
Top
See Also