JobDocumentComplete (Status As Long, Identification As Long) As Long

Description

This event is fired at least once for every document collected in JobDocumentRetrieve. FORMS puts the result from the interpretation/import in Status and the result from the identification in Identification.

If the document was recognized, the name of the identified document can be found in the current Form object. Similarly, the name of the current set can be found in the Set object.

Parameters

Parameter

Description

Status 

The result of the interpretation/import. See below.

Identification 

The resulting identification. See below.

Parameter values

Values for the Status parameter:

Value

Description

0

The document was recognized. See the Identification parameter for more specific information about the document.

13761

FORMS did not recognize the document as any "legal" document for the job and rejected it. In this case, the Identification parameter has the value 11 (see below).

14530

The document file could not be processed (read), for example because the format is not supported or the file is corrupt.

Values for the Identification parameter:

Value

Description

2

Form identified.

Suggested action: Move all files supplied before the last JobDocumentRetrieve to a folder for identified files.

3

Form identified, with possible appendices. (Compare with 2 below.)

Suggested action: You do not have do anything.

4

Document recognized as a regular appendix to an identified form.

Suggested action: You do not have do anything.

5

Form with included appendices complete.

Note that this value can only appear if at least one of the form definitions in the job is defined with appendices.

Suggested action: Move all files supplied before the last JobDocumentRetrieve to a folder for identified files.

6

Set complete.

Note that this value can only appear if you are processing sets.

Suggested action: Move all files supplied before the last JobDocumentRetrieve to a folder for identified files.

7

Document recognized as an appendix to an identified form with front page removed (for example because of a blank page).

Suggested action: You do not have do anything.

8

Document recognized as an appendix to an identified form with back page removed (for example because of a blank page).

Suggested action: You do not have do anything.

9

Document recognized as a appendix to an identified form with front and back page removed (for example because of a blank page).

Suggested action: You do not have do anything.

10

The form is identified as an Unidentified form (The document is unidentified by FORMS but is accepted as a Form of the type UNIDENTIFIED, which later can be presented and processed in Verify. Note that the Status parameter value is 0.)

This value can only appear if Accept unidentified forms is selected in the job description.

Suggested action: Move all files supplied before the last JobDocumentRetrieve to a folder for identified files.

11

Unidentified form (The document is rejected by FORMS.)

Suggested action: Move the file to a folder for unidentified files.

12

Form with included appendices incomplete— for example because of an invalid number of appendices.

Note that this value can only appear if at least one of the form definitions in the job is defined with appendices.

Suggested action: Move all files supplied before the last JobDocumentRetrieve to a folder for unidentified files.

13

Set incomplete.

Note that this value can only appear if you are processing sets.

Suggested action: Move all files supplied before the last JobDocumentRetrieve to a folder for unidentified files.

14

The most recently started form, set or batch is to be ignored.

Suggested action: Move all files supplied before the last JobDocumentRetrieve to a folder for unidentified files.

15

Batch complete.

Note that this value can only appear if you are processing batches.

Suggested action: Move all files supplied before the last JobDocumentRetrieve to a folder for identified files.

16

Batch incomplete.

Note that this value can only appear if you are processing batches.

Suggested action: Move all files supplied before the last JobDocumentRetrieve to a folder for unidentified files.

17

The form has been identified but not yet saved in the database. Here you can add information to the form.

Suggested action: You do not have do anything.

Return values

Return value

Description

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 when Data source extension is selected as the form source in the job description. Depending on the Identification value, decide what to do next— for example send another document to Interpret or end the job.

Remarks

Set, SetDef, Form, and FormDef objects exists if the document is recognized.

Used by ReadSoft’s EMAIL program.

Job-level events