Overview

This document defines various batch instance status used to specify the current state of a batch instance.

Batch Instance Status list

Following are the status used during the course of processing of a batch instance:

  • NEW
    • This status is for a newly created batch. This status shows that a batch has been created but has not yet been picked up for processing. This status can only occur once in the lifetime of a batch instance before its processing is finished.
  • LOCKED
    • This status is for a batch instance when a lock is taken over it by an executing server so that no other server can process it. This is the first thing done on the batch instance after it has been picked up. Once the batch has been locked, further processing can be done over it only by the server having its lock held.
  • READY
    • This status is for a batch instance which has been either restarted or moved out of Review/validation state and is waiting for the pick-up service to start its processing.
  • ERROR
    • This status is for a batch whose processing has failed, i.e. during its processing some business logic has been defied, which has failed and hence the batch has been sent to error.
  • FINISHED
    • This status is for a batch whose processing has been finished and the desired output has been acquired.
  • RUNNING
    • This status is for a batch which is currently in one of the automatic processing stages. All the stages except for Review and Validation are counted as the automatic processing stages.
  • READY_FOR_REVIEW
    • This status is for a batch which has reached the “Review_Document” plugin during the course of its processing and now needs to be reviewed manually by the user. During this stage, user can perform various operations on the batch like classifying, splitting, copying, deleting the document etc.
  • READY_FOR_VALIDATION
    • This status is for a batch which has reached the “Validate_Document” plugin during the course of its processing and now needs to be validated manually by the user. During this stage, user can perform all the operations it can do during the review stage along with the ability to change the value of the document level fields which have been extracted.
  • RESTARTED
    • This status is for a batch which has been restarted in earlier versions of Ephesoft Application (before 2.4 version). This status is no longer used in latest version of Ephesoft Application and has only been present to maintain backward compatibility.
  • DELETED
    • This status is for a batch which has been deleted during the course of its processing.
  • TRANSFERRED
    • This status is confined for a batch belonging to a batch class which implements “grid computing”. Batch is displayed in ‘Transferred’ status on a source machine when it has been received completely at the remote destination machine but its processing has not started there as yet.
  • RESTART_IN_PROGRESS
    • This status is for a batch which has been asked to restart and the system is processing on the information on how and from what point the batch will be restarted.
  • REMOTE
    • This status is confined for a batch belonging to a batch class which implements “grid computing”. Batch is displayed in ‘Remote’ status on a destination machine when it has been received completely from the source machine but its processing has not started here as yet i.e. the batch is still being prepared to be processed on the destination machine.

 

<Back| 4.0.0.0 Release Documentation

Was this article helpful to you?

Engineering