- Introducing ABBYY FlexiCapture
- ABBYY FlexiCapture architecture
-
Using scripts in ABBYY FlexiCapture
- Specifics of scripts written in .Net languages
- External assemblies
- Script editor
- Object model
-
Scripts for customizing processing stages
-
Types of scripts
- Script rule
- Autocorrection script
- Export script
- User script (custom action)
- Document assembly script
- Custom recognition script
- Stage rule
- Processing scripts
- Data set update script
- Data set validation scripts
- Document classification script
-
Event handlers
- Batch created
- Batch deleted
- Batch parameter change
- Batch structure change (page added/page deleted/document added/document deleted)
- Pages moved
- Batch opened/closed
- Batch integrity check
- Document parameter changed
- Document state changed
- Export completed
- Script that is run after rule checks
- Before matching
- Field verification request
-
Objects
- IActionResult
- IAssemblingError
- IAssemblingErrors
- IBatch
- IBatchCheckResults
- IBatchItem
- IBatchItems
- IBatchTypeClassifier
- IBatchTypeClassifierResult
- IBinarizationParams
- IBoxedBoolean
- ICharacterParams
- ICharactersParams
- ICheckmarkGroupValue
- ICheckmarkValue
- IDataSet
- IDataSetQuery
- IDataSetRecord
- IDocument
- IDocuments
- IDocumentExportResults
- IDocumentsExportResults
- IDocumentDefinitionInfo
- IDocumentDefinitionInfoArray
- IEditablePictureObject
- IExportFieldsToRedact
- IExportImageSavingOptions
- IField
- IFieldRegion
- IFieldRegions
- IFields
- IFlexiCaptureTools
- ILocalContrastParams
- IMatchedSectionInfo
- IMatchingInfo
- IPage
- IPageClassificationResult
- IPages
- IPictureObject
- IPictureObjectsInfo
- IPrincipal
- IPrincipals
- IProcessingCallback
- IProject
- IProperties
- IProperty
- IPropertyModificationInfo
- IRecordCheckResult
- IRecordset
- IRect
- IRects
- IRoutingRuleResult
- IRuleContext
- IRuleError
- IRuleErrors
- IRuleTag
- IRuleTags
- IScriptBinaryAttributes
- IScriptDefinitionContext
- ISectionDefinitionInfo
- ISectionDefinitionInfoArray
- IShadowsHighlightsParams
- IStageInfo
- IUserAttachment
- IUserAttachments
- IUserSessionInfo
- IValue
- IVARIANTArray
- TAssemlingErrorType
- TBatchItemType
- TColorToFilter
- TExportFieldType
- TExportType
- TImageCompressionType
- TPageClassificationType
- TPdfAVersion
- TPdfDocumentInfoType
- TPdfTextSearchAreaType
- TPrincipalType
- TProcessingPriority
- TPropertyType
- TRuleErrorType
- TStateType
- Sample scripts
- Internal names of recognition languages
-
Types of scripts
-
Scripts for processing interface events
-
Event handlers
- On Document Closed
- On Project Closed
- On Activate Document
- On Field Control Activate
- On Return From Task
- On User Command
- On Field Control Deactivate
- On Closing Document
- On Task Close
- On Closing Project
- On Region Change
- On Task Window Mode Changed
- On Open Document
- On Task Window Create
- On Task Reject
- On Region Control Draw
- On Task Send To Stage
- On Text Field Validating
-
Objects
- IBoolean
- IBoxedFieldControl
- IDocumentEditor
- IDocumentItem
- IDocumentItems
- IDocumentsCollection
- IDocumentsWindow
- IDrawContext
- IErrorControl
- IErrorControls
- IErrorsWindow
- IFieldControl
- IFieldRegionControl
- IFieldRegionControls
- IFormWindow
- IImageWindow
- IMainMenu
- IMainWindow
- IMenu
- IMenuItem
- IPageControl
- IPageItem
- IPageItems
- IPagesCollection
- IPoint
- ISelection
- IShellRational
- IShellRect
- IShellRects
- ITaskWindow
- ITextEditor
- IToolbar
- IToolbarButton
- IToolbars
- TCommandBarType
- TCommandID
- TDockingType
- TDocumentState
- TErrorType
- TSelectionType
- TTaskWindowMode
- TTextSize
- TUserRole
- TWorkWindowType
-
Event handlers
- User script for Web Verification Station
-
Application Programming Interface (API)
- About the ABBYY FlexiCapture Application Server Web Services API
- Using the Web Services API of the ABBYY FlexiCapture Application Server
-
References
- API Methods
- Data types
- Working with files
- Web Services Mobile API
- Web Services for user account management
- Examples of API Use
- Integrating Web Stations into third-party systems
- Configuring additional settings and customizing Web Stations
- Custom reports
-
Appendix
- Supported recognition languages
- Fonts for correct characters rendering
- Supported text types
- Supported barcode types
- Supported input formats
- Export file formats
- Date formats
- Alphabet used in regular expressions
- Protecting Document Definitions and additional modules
- Glossary
- Patents
- Third-party technologies
- Technical support
- End-User License Agreement (EULA)
English (English) - Change language
Batch
What it does
The Batch data type stores information about a batch.
Fields
Name | Type | Description |
Id | int | The ID of the batch |
Name | string | The name of the batch |
BatchTypeId | int | The ID of the batch type. 0 corresponds to the "Default" batch type |
Priority | int | Batch priority. Possible values: see Priority. |
Description | string | A description of the batch |
ElapsedProcessingSeconds | int | The time remaining until until the deadline for processing the batch, in seconds |
HasAttachments | bool | A flag that shows whether the batch has attachments |
Properties | RegistrationProperty[] | The set of registration parameters for the batch |
StageExternalId | int | The ID of the processing stage in which the task is created |
CreationDate | long |
The date and time when the batch was created. Completed when the batch is being created. Cannot be modified later. To convert values, use the following methods (C#): DateTime dtTime; long lTime; ... // conversion from DateTime to long dTime = DateTime.FromFileTime(lTime); ... // conversionfrom long to DateTime lTime = dTime.ToFileTime(); |
SLAExpirationDate | datetime | Processing deadline of the batch |
SLAStartDate | long |
Batch processing start time and date. Completed when the batch is being created. Cannot be modified later. To convert values, use the following methods (C#): DateTime dtTime; long lTime; ... // conversion from DateTime to long dTime = DateTime.FromFileTime(lTime); ... // conversionfrom long to DateTime lTime = dTime.ToFileTime(); |
DocumentsCount | int | The number of documents in the batch |
RecognizedDocumentsCount | int | The number of recognized documents |
AssembledDocumentsCount | int | The number of assembled documents |
VerifiedDocumentsCount | int | The number of verified documents |
ExportedDocumentsCount | int | The number of exported documents |
PagesCount | int | The number of pages in the batch |
ProjectId | int | Identifier of the project the batch belongs to. Corresponds to the entry identifier in the Project table |
RecognizedSymbolsCount | int | The number of recognized characters |
UncertainSymbolsCount | int | The number of uncertain characters |
VerificationSymbolsCount | int | The number of verified characters |
ErrorText | string | A description of the batch processing errors. Completed automatically by the Application Server. |
OwnerId | int | The ID of the user or group who owns the project |
CreatorId | int | The ID of the user who created the batch (completed when the batch is being created; cannot be modified later) |
02.03.2021 8:10:41