- 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
Mapping classes to Document Definition sections
The following scenarios are possible when mapping classes to Document Definition sections:
- You are using a ready-made classification model that was trained in, say, ABBYY FlexiLayout Studio.
In this case, all the necessary classes have already been created and all you need to do is map these classes to their respective Document Definition sections. To do this:
- Click the
button on the toolbar or select Class Mapping... in the Classification Training menu. Next, in the Class Mapping dialog box, click the Autocorrect... button to open the Correct Links dialog box. In this dialog box, select the Match names of classes to names of Document Definition sections option.
More information about the Correct Links dialog...
- Match names of classes to names of Document Definition sections - select this option to automatically link classes and sections that have identical names.
- When matching, ignore this text in names of classes for first pages - select this option and specify the text that should be ignored in the names of the first pages' classes when comparing classes and sections. If, for example, you have two classes — passport and passport_firstpage, and you want to link both of them to the passport document definition, select this option and specify "_firstpage" in the field. Then, when classes are linked, this text will be ignored, and both classes will be linked to the same definition.
- Remove duplicates - select this option to automatically remove duplicate links.
- In the Class Mapping dialog box, check to make sure that each class has been correctly mapped to its respective Document Definition section.
Important! If you see a class name displayed in red, this class has not been mapped to any sections in the Document Definition. Possible reasons:
- The name of the class may not match any section names (e.g. due to a typo). If this is case, map the class to its section manually, optionally correcting the typo.
- There is no section in the Document Definition to which the class can be mapped. If this is the case, create the section manually and map the class to that section.
To map a class to section manually, complete the following steps:
- In the Class Mapping dialog box, click the Add link... button.
- Select a class and its corresponding Document Definition section.
Note: You can select the Show unmatched only option to display only unmapped classes and sections.
- Click OK.
- You are using a previously trained classification model in a new project.
In this case, some of the necessary classes have already been created, but you need to add or remove some classes and Document Definition sections. To do this:
- Click the
button on the toolbar or select Class Mapping... in the Classification Training menu. Next, in the Class Mapping dialog box, click the Autocorrect... button to open the Correct Links dialog box. In this dialog box, select the Match names of classes to names of Document Definition sections option.
- If you need to create a new class or section, click the New class... button in the Class Mapping dialog box. Then,
- Create a new class and click Add.
- To create a new section, select the name of the appropriate Document Definition from the list and specify a name for the new section (you will also need to specify a recognition language and mode).
- Specify the required parameters:
- Select the Variant parameter if you need to create several variants of the class. For example, you may want to create variants for bank statements received from different banks (they will typically have the same set of fields, but each bank will have its own field layout).
- Select the Page position parameter if the first page of the document is easy to identify visually. This parameter is useful when assembling multi-page documents. The classifier will correctly identify the first and last page of the document. The class and section of the document will be identical, but this parameter will be different (First only/ Any position).
- Click the Add Link button.
- Once all the classes have been mapped to their respective sections, click OK.
Important! If there are identical "class-section" mappings, their names will appear in red. Click Autocorrect... → Remove duplicates to remove the duplicates.
- You are creating a new classification model because you need to train the program to extract fields and classify documents. In this case, you need to create the necessary classes and Document Definition sections and map each class to its section. To do this:
- Click the
button on the toolbar or select Class Mapping... in the Classification Training menu. Next, in the Class Mapping dialog box, create the missing sections and classes.
- Sections need to be created for classes without sections. Choose one or several classes without any assigned sections and click Autocreate sections. In the new dialog box, choose one of the following available options for creating a section:
- Based on Settings –
- Languages – It is necessary to set a correct language for recognition to proceed without errors. This property defines both the language itself and other settings like date format, currency, etc.
- Select a Recognition mode from the list.
- Prefer settings from batch type – Select this option if you want to synchronize full-text recognition settings.
Note: Disabling the synchronization may lead to slower template matching.
- Based on existing Document Section Definition – choose this option if the project already has a section with the correct full text recognition sections. The created section will be identical to the selected one in everything except the name.
- Click OK. This will create a document definition and a section with names identical to the selected class.
- If you need to create classes for existing unlinked sections, select one or several sections and click Autocreate classes. New classes will be created for the selected sections, which will have a name consisting of the document definition and the section name
- Modify and/or delete the appropriate classes and links if needed.
Note: The Class Mapping window can also be used to merge classes. To do this, select the appropriate classes and click Merge classes. In the dialog box, specify a name for the new class. If the merged classes were linked to different document definitions, then the new class will be linked to each one of them.
3/2/2021 8:10:42 AM