Processing Status
The data is given a label in the management database, corresponding to the processing step and processing status in which the data is located. This label is important both internally in the program and for status monitoring.
For the processing status, the object types "batch" and "document" work independently of each other. These object types each have their own step and status labels. The values that are used to specify the current processing steps correspond exactly to the processing steps for batches (i.e., "Input," "Processing," "Output," and "Backup"). For documents, the values are limited to "Processing" and "Output" because only these two steps are executed at the document level.
Document Status
The following status values are available for documents:
Document Status | Description |
|---|---|
Canceled | As a result of a configured condition, the document has transitioned to the status "Canceled." In this status, the document is finalized. Just like in the status "Finished"; however, in this type of finalization, processing may still be incomplete. Reprocessing is not possible. |
Deferred | As a result of a configured condition, the document has transitioned to the status "Deferred." In this status, in the same manner as that of the status "WaitingRetry," the document waits for a renewed processing attempt by the responsible process or output worker. This renewed processing attempt will be delayed by a defined time interval. |
Error | The document has run into a processing error in the processing or output step. A renewed attempt to process the document should not be executed automatically. |
Finished | The document was processed completely and successfully. |
Suspended | As a result of a configured condition, the document has transitioned to the "Suspended" status. This status is a special form of the "Error" status. This status also enables reprocessing through administrative intervention. |
Waiting | The document is waiting for processing by the responsible process or output worker. |
WaitingAsync | The document is in an asynchronous output step. Here the document is waiting for the fulfillment of a precondition. |
WaitingFetch | The document is in an asynchronous output step. Here the document is waiting to be retrieved by an external process (via web service). As a special case, this status can also occur in the "Process" step, in which case the status will indicate that the document is in the Stack Organizer waiting to be processed by a user. |
WaitingRetry | The document has run into a processing error and is waiting for a new processing attempt by the responsible process or output worker after a defined waiting time. |
WaitingReturn | The document is in the "Process" step and is in the Stack Organizer waiting to be returned by the processing user. |
Working | The document is being processed by a processing or output worker / web service. |
Batch Status
The values available for specifying batches are similar to those for documents. Most values are purely informative, summarizing the status values of the subordinate documents. Only for the final backup step is the batch status technically relevant. The reason is that this step is executed at the level of the batch and not at the level of the individual documents.
The BatchUpdate worker is responsible for updating the batch status. Each time a document progresses to a new status, the BatchUpdate worker is activated, initiating an additional status change for the parent batch, if necessary. At the level of the batch, however, only one total value can be displayed for all associated documents for processing step and processing status. Therefore, the lowest document status contained in the batch is what then applies to the batch. For example, if a document is still in the processing step, but all other documents are already in the output step, the batch will be set to the processing step.
A similar type of logic applies to the status value. If the status "Working," "Waiting," or "Deferred" applies to one or more documents in the batch, the batch will also be set to this status – with prioritization in this order. If, on the other hand, the status "Error" or "Suspended" applies to one or more documents, this status will apply to the batch as a whole. A "Finished" or "Canceled" status for all documents indicates that the batch is ready for the final backup step.
The following status values are available for batches:
Batch status | Description |
|---|---|
Canceled | As a result of a configured condition, the batch has transitioned to the status "Aborted." In this status, the batch is finalized, though processing may be incomplete. Otherwise, it is the same as the status "Finished." Reprocessing is not possible. |
Deferred | The batch was transitioned to the "Deferred" status by a configured condition. Just as in the status "WaitingRetry," here,the batch waits for a renewed processing attempt by the responsible process or output worker. This renewed processing attempt is delayed by a defined time interval. |
Error | The batch has encountered a processing error in the processing, output, or backup step. A renewed attempt to process the document should not be executed automatically. |
Finished | The batch was processed completely and successfully. |
SetError SetSuspended SetCanceled | Intermediate status preceeding the status "Error," "Suspended," or "Canceled" The backup worker checks for these values to apply the appropriate status to faulty batches in the input system. Afterwards, the backup worker sets the faulty batches to the final status "Error," "Suspended," or "Canceled" in internal administration. |
Suspended | As a result of a configured condition, the batch has been transitioned to the "Suspended" status. This status is a special form of the "Error" status. This status also enables reprocessing through administrative intervention. |
Waiting | The batch is waiting for pending processing by the responsible process, output, or backup worker. |
WaitingAsync | The documents contained in the batch are in an asynchronous output step. In this status, the documents wait for a condition to be fulfilled. |
WaitingFetch | The documents contained in the batch are in an asynchronous output step. In this status, the documents wait to be retrieved by an external process. As a special case, this status can also occur in the "Process" step, in which case the status will indicate that the batch is in the Stack Organizer waiting to be processed by a user. |
WaitingReturn | The batch is in the "Process" processing step and is in the Stack Organizer waiting to be returned by the user processing it. |
Working | The batch is being processed by a worker or web service in the input, processing, output, or backup processing step. |