RecogContinueOnFailure

Determines if a batch will abort if page or field recognition fails.

Important: The intended use of this legacy action is limited to those action libraries that do not support automatic retry. For all other libraries, the continue-on-failure setting is automatically set to True, which means that batches are not aborted as a result of recognition action failures. For information about automatic retry and the action libraries that support it, see SetupAutomaticRetry.

Member of namespace

Recog_Shared

Syntax

bool RecogContinueOnFailure (StrParam)

Parameters

String value True or False.
  1. True: a recognition failure will not be automatically retried if recognition fails. The batch will continue and the application can use the value assigned to the RecogStatus variable to decide how to proceed on success or failure of recognition. For more information on the RecogStatus variable, see information about the RecogContinueOnFailure action.
  2. False: causes the batch to abort if a full-page or field-level recognition action fails. If UseOutOfProcessRecog is enabled, the batch will abort only if the second recognition attempt fails.

Returns

Always True.

Level

All.

Details

This action determines if a batch will abort if page or field recognition failed.
Note: If RecogContinueOnFailure is not specifically called, the default False value is used. This means that batches will abort if recognition fails.

After a recognition operation is complete, the variable RecogStatus is set to indicate the success or failure of recognition. If page-level recognition is being performed, RecogStatus values of 0, 1 or 2 are considered successful.

The full list of values includes:
  • 0 - Success
  • 1 - Recognition was successful but there are no results, the page was empty.
  • 2 - Recognition was successful and additional processing such as RotateImage was performed.
  • 4 - Failure: the recognition engine cannot be instantiated.
  • 5 - Failure: the recognition engine timed out (the time specified by the SetEngineTimeout action has expired).
  • 6 - Failure: could not load image to engine.
  • 7 - Failure: could not load image to engine (path not found).
  • 8 - Failure: image could not be rotated.
  • 10 - Failure: general failure occurred and recognition was not completed.
Example
RecogContinueOnFailure(True)
RecognizePageOCR_S()