Click or drag to resize

ExportJob Class

Class represents an export job. Export jobs run in a priority queue. A job can be triggered by arrival of source files in a watched folder.
Inheritance Hierarchy
SystemObject
  Opait.ReportMiner.ApiExportJob

Namespace:  Opait.ReportMiner.Api
Assembly:  Opait.ReportMiner (in Opait.ReportMiner.dll) Version: 1.9.4.12917
Syntax
C#
Copy
public class ExportJob

The ExportJob type exposes the following members.

Constructors
  NameDescription
Public methodExportJob
Default constructor.
Public methodExportJob(XElement, String)
Class construction from parsing a serialized XML element.
Top
Properties
  NameDescription
Public propertyAppendExport
If true, exported data is appended to existing file instead of clearing the export file content for each export. Only supported for CSV and Pipe delimited files.
Public propertyDescription
Gets or sets user description of the job.
Public propertyDoneFolder
Gets or sets the name of the folder for successfully processed reports.

The folder name can be either a full path or relative to the location of the report file. The report will be moved to this folder if either successfully processed in ExportManager or a plugin returns 'ActionCode.Done' from a call. Files moved to this folder will be automatically renamed to avoid overwriting of existing files. The folder will be automatically created at runtime if it doesn't exist. The default is a relative folder named "Done".

Public propertyExportFile
Gets or sets the path of the export file used to save extracted fields and tables. Can be different than same defined within the report model.
Public propertyExportFolder
Gets or sets the path of the export folder used to save extracted PDF logical records. Can be different than same defined within the report model.
Public propertyExportFormat
Gets or sets the format of the export file.
Public propertyFailFolder
Gets or sets the name of the folder for failed reports.

The folder name can be either a full path or relative to the location of the report file. The report will be moved to this folder if either processing fails in ExportManager or a plugin returns 'ActionCode.Fail' from a call. Files moved to this folder will be automatically renamed to avoid overwriting of existing files. The folder will be automatically created at runtime if it doesn't exist. The default is a relative folder named "Failed".

Public propertyHasHistory
Get a flag to indicate that the job has some history.
Public propertyJobName
Gets or set the name of the job.
Public propertyLastRunDate
The date and time when the job was last run.
Public propertyLastStatus
The current or last run status of the job.
Public propertyLogFile
Gets or sets a path to the job log file.
Public propertyMaxRecords
Gets or sets the maximum number of records to process per report file. Default is zero, which means there are no restrictions.
Public propertyModelFile
Gets or sets the path to the current model definition file.
Public propertyPagesProcessed
The number of pages processed.
Public propertyPluginDll
Optional user defined plugin DLL which implements the IPlugin interface.
Public propertyRecordsCreated
The number of record created.
Public propertyRunsCompleted
The number of times the job has run.
Public propertyWatchFolder
Gets or sets the watch folder for incoming reports.
Public propertyWatchPattern
Gets or sets the file name pattern of the incoming reports. Can contain wild-cards.
Top
Methods
  NameDescription
Public methodFromXml
Initializes an instance of the ExportJob from serialized XML root element.
Public methodResetHistory
Resets the job history.
Public methodToXml
Serializes the job attributes as XML.
Top
See Also