IEngine Interface

Interface to the Report Miner processing engine.

Namespace: Opait.ReportMiner.Api
Assembly: Opait.ReportMiner (in Opait.ReportMiner.dll) Version: 1.9.4.12917

Syntax

public interface IEngine

The IEngine type exposes the following members.

Properties

	Name	Description
	Document	Gets the current report document that is being processed.
	ExportJob	Gets the current Export Manager job or null if not processing jobs.
	GlobalFields	Gets the list of global fields detected for the current document.
	Labels	Gets the list of labels for the data model.
	ModelFile	Gets or sets the current model definition file. Remarks If you change the ModelFile from a plugin call, you must return Restart to reprocess the file.
	PluginFile	Gets or sets the current plugin file. Remarks If you change the PluginFile from a plugin call, you must return Restart to reprocess the file.

Methods

	Name	Description
	DetectField	Detects a field on a specified report page.
	DetectLabel	Detects a label on a specified report page.
	FormatGlobalFields	Formats the global fields detected at the report level.
	FormatRecord	Formats all extracted data for the specified record.
	GetGlobalField	Gets a detected global filed that matches the given name.
	GetLabel	Gets a detected label that matches the given name.
	MoveDocument	Moves the current report file to the specified folder.
	ParseValue	Parses the given string based on its data type.
	SaveRecordAsPdf	Saves the pages of the specified record as a PDF file.