- 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)
Project Setup Station
The Project Setup Station is the station where projects are created, set up, and debugged. A project specifies Document Definitions, batch types, image import, document export, and processing options.
To create and set up a project:
- Create a project and upload it to the Application Server.
- Open the project on the server and set its properties.
- Create Document Definitions.
- Create Batch Types.
- Create Image Import Profiles.
Important! Only the Administrator may create new projects. A Project Setup Operator can only set up already created projects.
Creating a new project
Once the Administrator has established a database connection, the Administrator should:
- Launch the Project Setup Station (Start → All Programs → ABBYY FlexiCapture 12 Stations → Project Setup Station).
- Create a project.
- Upload the project to the Application Server.
After the project is uploaded to the Application Server, the Administrator may grant setup permissions for the project to a project setup Operator.
Project properties
To set project properties, the Project Setup Operator should:
- Launch the Project Setup Station.
- Select File → Open Project from Server... and specify the path to the Application Server. A Open Existing Project from Application Server dialog box appears.
- Select the project from the list of all available projects.
- Select Project → Project Properties... and specify the project properties: image pre-processing options, document recognition options, event handlers, export settings, and processing options.
Creating Document Definitions
To determine how document types are to be identified and processed, the Project Setup Operator should create Document Definitions. A Document Definition includes information about the structure of the document, the positions of its fields, export and document processing options, etc. Document Definitions are created in a Document Definition Wizard and properties are specified in a Document Definition Editor.
Creating Batch Types
ABBYY FlexiCapture can process documents in batches: prior to processing, a batch is created and the document images are placed in this batch, which then goes through the various processing stages. Typically, a batch contains all the documents processed at one go or all the documents imported from a particular folder. The settings to be used for processing the documents, are specified in the batch type. You can create several batch types for the most commonly used sets of processing options. In this case, each time an Operator creates a new batch, they can specify its type and the batch will be processed in accordance with the settings specified for this batch type.
Note:
- If no batch types are created, all batches are processed with the <default> settings specified for the entire project.
- Documents can be verified or exported either in batches or individually. This is also specified in the batch type settings.
Creating Image Import Profiles
To automate the process of adding images, image import profiles can be created on the Project Setup Station. Two types of profile are available: one involving the use of a scanner and one involving the use of a Hot Folder. A scanner profile may be used to debug the project. A Hot Folder profile imports images automatically on the Processing Station.
Note:
- A scanner profile is only available on the Project Setup Station.
- To import images from Hot Folders, you must enable Hot Folders for your project in the Administration and Monitoring Console (click Settings → Projects).
3/2/2021 8:10:41 AM