- Introducing ABBYY FlexiCapture
- Installing and running the program
- ABBYY FlexiCapture architecture
-
Program settings
- ABBYY FlexiCapture Setup
- Multitenancy
- Creating a project
-
Document Definitions
- Creating fixed Document Definitions
- Creating Document Definitions for semi-structured documents
- Document Definitions without automatic fields extraction
- Document sets
-
Document Definition fields
- Text entry fields
- Checkmarks
- Checkmark groups
- Barcodes
- Pictures
- Tables
- Field group
- Service fields
- Index fields
- Link to an existing field
- Fields without a region
- Creating a field with a non-rectangular region
- Fields with several instances
- Fields with several regions
- How to change a field name
- Copying, moving, deleting fields
- Exclusion of a region from recognition
- Document Definition Wizard
- Editing and publishing a Document Definition
- Creating Document Definitions
- Document Definition properties
- Properties of a Document Definition section
- Rule validation
- Export settings
- Configuring data presentation in the document window
- Testing Document Definitions
- Localizing a Document Definition
- Classification
- Field extraction training
- Operating a configured project
-
ABBYY FlexiCapture for Invoices
- Features of ABBYY FlexiCapture for Invoices
- How to capture invoices
-
How to set up an invoice capture project
- Country and language settings
- Connecting vendor and business unit databases
- Data export settings
- The status of documents in ABBYY FlexiCapture for Invoices projects
- Training ABBYY FlexiCapture for Invoices
- Rules
- Capturing additional invoice fields
- Purchase Order Matching
- Enabling additional program features for operators
- Using multiple Document Definitions
- Editing invoice processing settings in XML files
- Updating the Document Definition for invoices
- Tax systems
- Specifications
- Capturing receipts
- Capturing purchase orders
- Using NLP to process unstructured documents
- ABBYY FlexiCapture interface
-
Appendix
-
Using scripts in ABBYY FlexiCapture
- Specifics of scripts written in .Net languages
- External assemblies
- 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 scripts for the Web Verification Station
- Creating a machine-readable form
- Hot keys
- Additional options
- Description of Processing Server commands
- ABBYY FlexiCapture sample projects
- Supported recognition languages
- Supported classifier languages
- Fonts for correct characters rendering
- Supported text types
- Supported barcode types
- Supported input formats
- Processing PDF files
- Export file formats
- Date formats
- Alphabet used in regular expressions
- Patents
- Third-party technologies
- Glossary
- Technical support
- How to buy ABBYY FlexiCapture
- End-User License Agreement (EULA)
-
Using scripts in ABBYY FlexiCapture
Registration parameters
Registration parameters are textual properties allowing to identify a specific batch or document. These properties can be represented by the scanning date, the name of the Scanning Operator, etc. A registration parameter may be required or optional.
Registration parameters can be assigned to the batch during creation (if the batch is created automatically using image import profiles). Registration parameters can also be assigned to batches and documents on the Scanning Station and sent together with the images.
The registration parameters can be configured on the Registration Parameters tab of the Batch Properties or Document Properties dialog box respectively (click Properties... on the shortcut menu).
The value of the registration parameter can be used when applying a FlexiLayout in the following cases:
- A FlexiLayout is used to check for preset data in a document. It is used when the information is known and a user needs to check whether it is present in the document.
- When some previously known information is recorded in registration parameters of a document and may affect the logic of searching for fields. For example, a found classifier’s class or a preset vendor is recorded in a registration parameter. This value is transferred from registration parameters of the document to the FlexiLayout and can be searched for by this FlexiLayout equally with other fields of the FlexiLayout.
The registration parameter can be passed to the input of both the main and an additional FlexiLayout. To do this, the input named parameter of the FlexiLayout in ABBYY FlexiLayout Studio must be of the String type and its name must match the name of the registration parameter of the document in ABBYY FlexiCapture.
Note: It is recommended to specify different names for batch and document registration parameters. In case of identical names, the document registration parameter is always used when substituting the registration parameter value. For example, when generating file names during export.
Named registration parameters
It is also possible to specify some of document processing settings using named registration parameters.
- fc_Predefined:DefinitionsToMatch. This registration parameter allows you to limit the number of Document Definitions used for matching. The parameter value is treated as the set of Document Definitions used for matching for a given document. The value can be a Document Definition name, the name of a specific section or a set of sections and Document Definitions where elements are separated by semicolons. For example:
"Document Definition 1; Document Definition 2\Section 1; Document Definition 2\ Section 2".
This registration parameter can be filled in by Operator in the Scanning Station (manually or by using a script). It is also possible to fill in this parameter in any stage prior to recognition if it becomes clear which Document Definition should be matched (e.g. as a result of classification).
- fc_Predefined:DocumentError. If this parameter is not empty, then in the export stage, the document will be considered as a document with error and will be exported according to export profiles for erroneous documents. The description of an error contains the value of the registration parameter.
Storing basic message header details in the registration parameters
When you import images from an e-mail folder using the MAPI, IMAP server or POP3 server protocols, information about the message will be automatically added to the registration parameters of the batch you are creating. The following parameters are added:
- fc_Predefined:EmailSubject
The message's subject. - fc_Predefined:EmailSender
The message's name. - fc_Predefined:EmailAddressee
The message's name. - fc_Predefined:EmailDate
The date and time when the message was received.
Note: If you don't want information about the message to be added to the batch's registration parameters, set the following registry key:
[HKEY_CURRENT_USER\Software\ABBYY\FlexiCapture\12.0\Controller] "UseHotFolderSpecialParameters"="false".
3/2/2021 8:10:42 AM