Parameters of the Done event

Parameters of Done event

Parameter Description
StartError (int)

0: the processing of the job started successfully

Any other value: error, for example:

  • OCRService cannot start the OCRServer.

  • OCRServer cannot initialize the CSDK.

  • The WorkflowXML is corrupt or the job items are invalid.

StartErrors (int[])

null: all job items started successfully.

Any other value: error in a job item.

The index of the job item in StartErrors is the same as the position of the job item in the WorkflowXML.

Typical examples:

  • A job item cannot process the related XML snippet.

  • An exception occurred in the Run method of the job item.

RuntimeErrors (object[]) Non-fatal errors during runtime. May be null.
RuntimeErrorDescriptions (object[])

Verbose description of the error reported in RuntimeErrors parameter, typically including the phase, the file, the location within the file, and the error description. May be null.

ResponseXMLFiles (string[])

Each built-in job item can generate a ResponseXML if requested in the workflow. Generating a ResponseXML file is mandatory for some job items for proper functioning.

The ResponseXML file contains the original request, the result, and the occurring runtime errors with description.

Start errors can be included. Start error items indicate the source code and the number of the line where the error happened. May be null.

In case of start errors, contact technical support.