Building Lifecycle Applications for v5.0
Documents travel in batches through the lifecycle to provide consistency. A batch has a status while it in an operation and a status once the operation is complete. For, example while a batch is being indexed the status is Indexing, but when the indexing is complete the status is changed to Indexed.
In the Capture Lifecycle Editor the transition between the Capture, Index and Distribute can only be performed on completed status. The following table provides a list of complete status:
Batch Status for Capture
The following table details the batch status used during the capture process.
Batch Status | Type | Description |
Creating | Processing | The batch is being created. This is beginning status of a batch and its use depends on the Lifecycle settings. |
Created | Processed | The batch has been created. |
Ready to Convert PostScript | Waiting | The batch is ready to be converted from PostScript (Used with the Client Tools). When the Virtual Print Driver creates a batch it automatically sets this batch status to trigger the PostScript to PDF connector. |
Converting PostScript | Processing | The batch is currently being converted from PostScript (Used with the Client Tools). |
PostScript Converted | Processed | The batch has been converted from PostScript (Used with the Client Tools). This not used if the Status After Upload batch status is set in the lifecycle. |
Ready for Conversion | Waiting | The batch is ready for document conversion. |
Converting | Processing | The batch is currently in the document conversion process. |
Converted | Processed | The documents in the batch have been converted. |
Ready for Separation | Waiting | The batch is ready for document separation. The Lifecycle connector will set the batch status to Ready for Separation if the Separate Document setting is set to anything else but No in the lifecycle. |
Separating | Processing | The batch is currently in the document separation process. |
Separated | Processed | The documents in the batch have been separated. |
Ready for OCR | Waiting | The batch is ready to be OCR'd. The Lifecycle connector will set the batch status to Ready for OCR if the Document is Text Searchable or Document Indexes will be extracted from text is set to Yes in the lifecycle, or the Separate Document is set to With Templates. |
OCR in Progress | Processing | The batch is currently in the OCR process. |
OCR Complete | Processed | The batch has completed the OCR process. |
Ready for Classification Preparation | Waiting | The batch is ready to go through the Classification Preparation process. The Lifecycle connector will set the batch status to Ready for Classification Preparation if the Classify Document with either the Manual or Auto with Verification selected in the lifecycle settings. |
In Classification Preparation | Processing | The batch is in the Classification Preparation process. |
Classification Preparation Complete | Processed | The batch has gone through the Classification Preparation process. |
Ready for Classification | Waiting | The batch is ready for Classification. As the only option after Classification Preparation is this stage, the batch status is set by the Classification Prep connector. |
Classifying | Processing | The batch is in the Classification process. |
Classified | Processed | The batch has gone through the Classification process. |
Batch Status for Indexing
The following table details the batch status used during the indexing process.
Batch Status | Type | Description |
Ready for Indexing | Waiting | The batch is ready to be indexed. User indexing and status is set to Indexed after the process or Document will be Auto-Indexed set to No in the lifecycle. |
Indexing | Processing | The batch is currently being indexed by a connector. |
Partially Indexed | Paused | The batch is partially indexed by a user. |
Indexed | Processed | The batch is completely indexed. |
Ready for Auto-Indexing | Waiting | The batch is ready for auto-indexing. This status is used if the Index Document with Manual, Auto, or Auto with manual verification is set in the lifecycle settings. |
Auto-Indexing | Processing | The batch is currently in the auto-indexing process. |
Auto-Indexed | Processed | The batch has been auto-indexed. |
Ready for Verification | Waiting | The batch is ready to be verified. This Lifecycle connector will set the batch status to Ready for Verification if the Document will be Auto-Indexed is set to Yes in the lifecycle and the Auto-Indexing stage is complete. |
Verifying | Processing | The batch is in the verification process. |
Partially Verified | Paused | The batch is partially verified by a user. |
Verified | Processed | The batch has been verified. |
Ready for Final Separation | Waiting | This occurs after Classification Verification or manual classification. If there is no manual classification defined in the lifecycle, then no Final Separation is required. |
In Final Separation | Processing | The batch is in final separation. |
Final Separation Complete | Waiting | The batch is ready for final separation. |
Batch Status for Distribution
The following table details the batch status used during the distribution process.
Batch Status | Type | Description |
Ready for Distribution | Waiting | The batch is ready for distribution. |
Distributing | Processing | The batch is being distributed. |
Lifecycle Completed | Processed | The batch has been completed. This is used for lifecycles that distribute to third party business applications and document management systems. |
Distributed | Processed | The batch has been distributed. |
General Batch Status
The following table details the batch status that can occur at any stage.
Batch Status | Type | Description |
Creating | Processing | The batch is being created. This is beginning status of a batch and its use depends on the Lifecycle settings. |
Error | Waiting | An error occurred during batch processing. |
Distributing | Processing | The batch is being distributed. |
Distributed | Processed | The batch has been distributed. |