Batch - ABBYY Documentation

Contains a list of batches. For diagrams of the relationships, see Processing of objects and Routing.

List of columns

Key	Name	Type	Required	Description
PK	`Id`	`int`	Yes	Batch identifier.
	`AnalyzedDocumentsCount`	`int`	Yes	The number of documents that have been analyzed.
	`AssembledDocumentsCount`	`int`	Yes	The number of assembled documents.
	`BatchPurpose`	`int`	No	The purpose of the batch. Possible values: `0` (batch with data), `1` (batch for training Document Definition matching), `2` (batch for training classifiers).
	`BatchTypeId`	`int`	Yes	Batch type identifier. Corresponds to the entry identifier in the BatchType table. Has the value `null` for Default batches.
	`Comment`	`nvarchar`	No	Batch comment.
	`CreationDate`	`datetime`	Yes	Date of batch creation.
	`CreatorId`	`int`	No	The identifier of the user that created the batch.
	`DataVerificationSymbols`	`int`	Yes	The total number of characters to be submitted for group verification and the number of fields to be verified during field verification.
	`DocumentsCount`	`int`	Yes	The number of documents in the batch.
	`EditedSymbols`	`int`	Yes	The number of edited characters.
	`ElapsedProcessingSeconds`	`int`	No	The time remaining or processing the batch, in seconds.
	`ErrorText`	`nvarchar`	No	Description of batch processing errors.
	`ExportedDocumentsCount`	`int`	Yes	The number of exported documents.
	`ExternalId`	`nvarchar`	No	External batch identifier.
	`FixedElapsedTimeValue`	`tinyint`	No	Indicates whether ElapsedProcessingSeconds needs to be re-calculated when the batch is moved to a different processing stage. Possible values: 0 - re-calculate; 1 (default) - do not re-calculate.
	`ForcedVerifcationSymbols`	`int`	Yes	The number of characters requiring forced verification.
	`IdCounter`	`int`	No	The counter of batch object identifiers.
	`IsDeleted`	`bit`	Yes	Deleted batch indicator.
	`LastRoutingDate`	`datetime`	No	The last date when the batch was transferred to a different processing stage.
	`MaxDocumentPriority`	`int`	Yes	The maximum priority a document can have in the batch. For possible values, see Priority.
	`Modification`	`int`	Yes	The counter of modifications made to the batch for purposes of synchronization during parallel processing.
	`Modified`	`timestamp`	Yes	Indicates modified entries.
	`Name`	`nvarchar`	No	The name of the batch.
	`OwnerId`	`int`	No	The identifier of the project owner (for FrontOffice projects). Corresponds to the entry identifier in the Principal table.
	`PagesCount`	`int`	Yes	The number of pages in the batch.
	`Priority`	`int`	Yes	Batch priority. For possible values, see Priority.
	`ProcessingStageId`	`int`	No	The identifier of the current processing stage of the batch. Corresponds to the entry identifier in the ProcessingStage table.
	`ProjectId`	`int`	Yes	The identifier of the project to which the batch belongs. Corresponds to the entry identifier in the Project table.
	`RecognizedDocumentsCount`	`int`	Yes	The number of recognized documents.
	`RecognizedSymbols`	`int`	Yes	The number of recognized characters.
	`SLABeginOfProcessing`	`datetime`	No	The time when the processing of the batch was started for SLA purposes. By default, this time is the time when the batch was created.
	`SLAEndOfProcessing`	`datetime`	No	The time when the processing of the batch was completed for SLA purposes.
	`SLAExpirationDate`	`datetime`	No	Processing deadline for the batch.
	`Status`	`int`	Yes	The status of batch processing. A set of status flags.
	`TotalSymbols`	`int`	Yes	The total number of characters in the batch.
	`UncertainSymbols`	`int`	Yes	The number of recognized characters that may have been recognized incorrectly.
	`VerificationSymbols`	`int`	Yes	The number of recognized characters that require verification.
	`VerifiedDocumentsCount`	`int`	Yes	The number of verified documents.
	`WarningText`	`nvarchar`	No	Description of batch processing warnings.

​List of columns

List of columns