JobDocumentRetrieve event

This event is fired in Interpret when Data source extension is selected as the source in the job description.

You provide INVOICES with one or two files for interpretation. The files can be:

Image files. Supply two image files if the invoice is two-sided.
XML files. Supply only one XML file at a time.

The interpretation result is returned in the JobDocumentComplete event.

The JobDocumentError event is also available, if you set the AllowErrorHandlerEventHook setting in Eilocal.ini.

If you want the image files to be moved after identification, subscribe to the JobDocumentComplete event and change the desired paths of the images file on each invoice page using the COM API.

Use the Result parameter to control the further flow of the Interpret module. See below.

Syntax

Public Function JobDocumentRetrieve(ByRef srcPathToFrontPage As String, ByRef srcPathToBackPage As String, ByRef notUsed1 As String, ByRef notUsed2 As String, ByRef Type As Integer, ByRef Result As Long) As Long

Parameters

srcPathToFrontPage

The full path to the front page file.

srcPathToBackPage

The full path to the back page file.

notUsed1

Obsolete starting in INVOICES 5-5 SP4.

notUsed2

Obsolete starting in INVOICES 5-5 SP4.

Type

This value is always 0.

Result

Tells INVOICES what to do next:

0	Process the supplied image file(s) in the DocPath1 and DocPath2 parameters.
1	Process the XML file in the DocPath1 parameter.
-1	No more files to process.

Active objects

Interpret Application or InterpretApp

Invoice (OLE) or Invoice (COM API)

InvoiceProfile

Job (OLE) or Job (COM API)

JobDescription

Return values

EV_OK	Normal return.
EV_OK_ABORT	No effect – treated the same as EV_OK.
EV_ERROR	Causes an error message and job termination

Suggested usage

Used by data source extensions, for example ReadSoft EMAIL and ReadSoft COLLECTOR. (Note: ReadSoft EMAIL is not supported with INVOICES 5-6.)