IOcrJob Properties |
The IOcrJob type exposes the following members.
Name | Description | |
---|---|---|
Actions |
Gets or sets the actions performed by the OCR job.
| |
AllFolders |
Gets or sets a flag to indicate whether to include sub-folders of the watch folder.
| |
DeletedFolder |
Gets or sets a folder name for storing image pages that were deleted
during processing as a result of user action or blank page detection.
| |
DeleteSubFolders |
Gets or sets a flag to indicate whether empty sub-folders should
be deleted from the watch folder.
| |
Description |
Gets or sets user description of the job.
| |
DestFolder |
Gets or sets the location of the destination folder.
Can be relative to the WatchFolder and contain macros.
| |
DestFolderPath |
The full path to the destination folder. The destination
folder can be relative to the watch folder.
| |
DestOverwrite |
Gets or sets a flag to indicate whether to overwrite files that already exist.
If set to 'false', then name conflicts will be automatically resolved. Default is 'false'. | |
DoneFolder |
Gets or sets a folder name for successfully processed documents.
| |
FailFolder |
Gets or sets a folder name for failed documents.
| |
FileLogCompact |
Gets or sets a flag to indicate whether a more compact formatting should be
used for messages written to the log file.
| |
FileLogLevel |
Gets or sets the minimum logging level for job messages written to the log file.
| |
FilesProcessed |
The number of files processed.
| |
IndexFilename |
Gets or sets a filename for creating an index file for OCR output from index zones.
| |
JobID |
Gets the unique identifier of the job.
| |
JobName |
Gets or sets the name of the job.
| |
LastRunDate |
The date and time when the job was last run.
| |
LogFile |
Gets or sets a path to the job log file.
| |
LogFilePath |
The actual path of the log file. LogFile can have macros and be relative
to project path. Supported macros are $(Date), $(Time) and $(ProcessId).
| |
MaxBatchSize |
Gets or sets a limit on the number of files to process when the job runs.
Default is zero which indicated no limits.
| |
ModifiedFolder |
Gets or sets a folder name for saving documents with corrected page orientation.
Only used if document is not otherwise saved, the option to fix orientation is
selected, and the document has at least one page that needs to be rotated to fix
the page orientation.
| |
OcrOptions |
Gets or sets the options for the OCR process.
| |
OcrStats |
Gets the OCR run statistics for this job.
| |
OcrTemplate |
Gets the template used for zoned OCR.
| |
PagesProcessed |
The number of pages processed.
| |
RunsCompleted |
The number of times the job has run.
| |
ScreenLogLevel |
Gets or sets the minimum logging level for job messages displayed on the screen.
| |
ShuffleSource |
Gets or sets a boolean value to indicate whether the order of the
source files should be shuffled to reduce contentions.
| |
SourceAction |
Gets or sets the post-processing action on the source document.
| |
Status |
The current or last run status of the job.
| |
WatchFolder |
Gets or sets the watch folder for incoming reports.
| |
WatchFolderPath |
The full path to the watch folder. The watch folder
can be relative to the project file.
| |
WatchPattern |
Gets or Sets a regular expression pattern for matching file extensions.
| |
ZipBackupFolder |
Gets or sets the directory where uploaded ZIP files are placed after
processing. Uploaded ZIP files are never deleted by the program.
| |
ZipInputFolder |
Gets or sets the directory where uploaded ZIP files are detected.
If defined, ZIP files will be processd one at a time by a single
instance. A qualified ZIP file will be extracted to WatchFolder
before processing.
| |
ZipMinAge |
Gets or sets the minimum age of an uploaded ZIP file before it qualifies
for processing. Set this to a value that ensures a ZIP file has been
fully uploaded bofore it is processed.
| |
ZipOutputFolder |
Gets or sets the directory where results are moved after compressing
into a ZIP file.
|