- 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
English (English) - Change language
Document Definition editor menu
Document Definition
Menu item | Description | |
Add Pages... | Adds a new page image to the Document Definition. | |
Add Document Section... | Adds a new section to the batch. | |
Add Summary Section... | Adds a summary section to the batch | |
Import Document Section... | Imports the selected document section. | |
Add Link to Document... | Adds a link to another Document Definition to the Document Definition. | |
Script Modules | Rule Script... | Opens the Rule Global Script Module of the Script Editor. For more about script modules, see Using scripts in FlexiCapture. |
Export Script... | Opens the Export Global Script Module of the Script Editor. For more about script modules, see Using scripts in FlexiCapture. | |
Export Settings... | Opens the Export Settings dialog box, where you can configure data export options. | |
Document Definition Properties... | Opens a dialog box where you can view and edit the properties of the Document Definition. | |
Localization | Localizable Script Messages... | Opens a dialog box where you can view and edit error messages. For more information, see Localizing a Document Definition. |
Localization Options... | Opens the localization options for the Document Definition. For more information, see Localizing a Document Definition. | |
Save | Saves your changes. | |
Close | Closes the Document Definition editor. |
Edit
Menu item | Description | |
Undo | Undoes the previous action. | |
Redo | Redoes the undone action. | |
Cut | Cuts highlighted objects. | |
Copy | Copies highlighted objects to the Clipboard. | |
Paste | Pastes the Clipboard contents to the user-specified location. | |
Delete | Deletes highlighted objects. | |
Delete Region | Removes regions from the images of highlighted objects. | |
Select All | Selects all. | |
Select Regions by Type... | Detects objects of a certain type. | |
Select Fields by Type... | Highlights fields of a specific type on the image. | |
Create Field | Text | Adds a text entry field to the document structure (without adding a region on the image). |
Checkmark | Adds a checkmark field to the document structure (without adding a region on the image). | |
Checkmark Group | Adds a checkmark group field to the document structure (without adding a region on the image). | |
Barcode | Adds a barcode field to the document structure (without adding a region on the image). | |
Picture | Adds a picture field to the document structure (without adding a region on the image). | |
Table | Adds a table field to the document structure (without adding a region on the image). | |
Group | Adds a group of fields to the document structure (without adding a region on the image). | |
Service Field | Adds a service field to the document structure (without adding a region on the image). | |
Link to Existing Field | Adds a link to an existing field | |
Copy Text from Image... | Gets text from a region and stores it in the Clipboard. After selecting this command, highlight the region where the desired text is located. | |
Image... | Despeckle | Removes noise from the image. |
Invert | Inverts the image. | |
Rotate 90° Clockwise | Rotates the image 90° clockwise. | |
Rotate 90° Counterclockwise | Rotates the image 90° counterclockwise. | |
Rotate 180° | Rotates the image 180°. | |
Change Resolution... | Opens the Set Resolution dialog box, where you can specify a new image resolution value. | |
Save As... | Saves the image to a file. | |
Replace... | Replaces the image with another one. |
View
Menu item | Description | |
Image Layout | Static Elements | Switches to Static Elements mode. |
Field Regions | Switches to Field Regions mode. | |
Document Structure | Show Document Structure | Shows/hides the document structure window. |
Fields | Switches the Document Structure window to the Fields mode. | |
Pages | Switches the Document Structure window to the Pages mode. | |
Data Form | Shows/hides the data form. | |
Data Form Text Size | Very Large | Selects the largest font for the text displayed in the data from. |
Large | Selects a large-sized font for the text displayed in the data from. | |
Medium | Selects a medium-sized font for the text displayed in the data from. | |
Small | Selects a small-sized font for the text displayed in the data from. | |
Very Small | Select the smallest font for the text displayed in the data from. | |
Layout Toolbar | Horizontal | Docks the toolbar of the image layout window horizontally. |
Vertical | Docks the toolbar of the image layout window vertically. | |
Errors Window | Top | Places the errors window at the top of the screen. |
Bottom | Places the errors window at the bottom of the screen. | |
Left | Places the errors window on the left. | |
Right | Places the errors window on the right. | |
Show Assembly Errors | Shows / hides the assembly errors. | |
Show Multi-Field Rule Errors | Shows / hides the multi field rule errors. | |
Show Single-Field Rule Errors | Shows / hides the single field rule errors. | |
Show Unmatched Region Errors | Shows / hides the unmatched regions errors. | |
Status Bar | Shows / hides the status bar. | |
Show Image in Black and White | Shows color and grayscale images in black-and-white. | |
Image Scale | Fit to Width | Fits the width of the page to the display area. |
Fit to Height | Fits the height of the page to the display area. | |
Best Fit | Fits the entire page to the display area. | |
400% | Scales the image to 400% of the original size. | |
200% | Scales the image to 200% of the original size. | |
100% | Scales the image to 100% of the original size. | |
75% | Scales the image to 75% of the original size. | |
50% | Scales the image to 50% of the original size. | |
25% | Scales the image to 25% of the original size. | |
Custom... | Lets you select your own custom scaling setting. | |
Zoom in | Makes the image larger. | |
Zoom out | Makes the image smaller. | |
Properties... | Opens a dialog box where you can view and edit the properties of the highlighted object. |
Layout
Menu item | Description | |
Adjust Region | Adjusts the positions of the selected form elements. | |
Align Regions | Left | Aligns the selected form elements along the left-hand side of the last selected element. |
Right | Aligns the selected form elements along the right-hand side of the last selected element. | |
Top | Aligns the selected form elements along the top side of the last selected element. | |
Bottom | Aligns the selected form elements along the bottom side of the last selected element. | |
Space Evenly | Across | Evenly distributes the selected elements horizontally. |
Down | Evenly distributes the selected elements vertically. | |
Suggest Name | Suggests the explanatory text that is closest to the field region to be used as the name of the field. | |
Get Name from Image... | Changes the name of the field to a recognized text fragment located anywhere on the page. | |
Group | Groups highlighted objects. | |
Ungroup | Ungroups highlighted objects. | |
Duplicate Field | Creates a copy of a field or group of fields. | |
Continue Region... | Creates a field with multiple regions. | |
New Instance... | Creates a field with multiple instances. |
Form
Menu item | Description | |
Restore Default Size | Restores the default size of the selected form element. | |
Margins | Adjust | Sets the same margin size for all the selected elements. |
Reset All to Default | Restores the default margin size for the selected elements. | |
Delete All | Deletes the margins for the selected elements. | |
Reset Left to Default | Restores the default left margin size for the selected elements. | |
Delete Left | Deletes the left margin for the selected elements. | |
Reset Right to Default | Restores the default right margin size for the selected elements. | |
Delete Right | Deletes the right margin for the selected elements. | |
Reset Top to Default | Restores the default top margin size for the selected elements. | |
Delete Top | Deletes the top margin for the selected elements. | |
Reset Bottom to Default | Restores the default bottom margin size for the selected elements. | |
Delete Bottom | Deletes the bottom margin for the selected elements. | |
Horizontal Alignment | Left | Aligns the selected form elements along the left-hand side of the last selected element. |
Right | Aligns the selected form elements along the right-hand side of the last selected element. | |
Center | Aligns the selected form elements along the center of the last selected element, without shifting the elements vertically. | |
Stretched | Evenly distributes the selected elements horizontally. | |
Vertical Alignment | Top | Aligns the selected form elements along the top side of the last selected element. |
Bottom | Aligns the selected form elements along the bottom side of the last selected element. | |
Center | Aligns the selected form elements along the center of the last selected element, without shifting the elements horizontally. | |
Stretched | Evenly distributes the selected elements vertically. | |
Select | Select Form Control | Selects the control element of the field. |
Select Cell | Selects the cell that contains the selected field. | |
Select Caption | Selects the caption related to the field. | |
Select Field Picture | Selects the picture related to the field. | |
Select Field | Selects the field related to the caption. | |
Select All Cells | Selects all the cells on the form. | |
Select Row Cells | Selects all the cells in the row that contains the selected cell. | |
Select Columns Cells | Selects all the cells in the column that contains the selected cell. | |
Deselect Cells | Clears cell selection. | |
Group | Group | Groups the selected elements. |
Ungroup | Ungroups the selected elements. | |
Lock Group | Locks the selected group of fields. Locked elements cannot be moved. | |
Unlock Group | Unlocks the selected group of fields. | |
Add Caption | Adds the caption of the selected field which corresponds to the document structure. | |
Add Field Picture | Adds the picture of the selected field. | |
Insert Control | Text | Adds explanatory text to the data form. |
Button | Adds a button to the data form. The button opens a dialog box enabling the user to check the field value against a database using a rule. | |
Field | Adds a field to the data form. This command is only available if at least one of the fields is missing in the data form. | |
Show as Table | Displays the selected repeating group of fields as a table on the form. | |
Columns and Rows | Create Columns and Rows... | Creates a table in an empty data form. Range of allowed values: 1 to 1000. |
Add Rows Above... | Adds 1 to 10 rows above the row that contains the selected cell. | |
Add Rows Below... | Adds 1 to 10 rows below the row that contains the selected cell. | |
Add Columns Left... | Adds 1 to 10 rows to the left of the row that contains the selected cell. | |
Add Columns Right... | Adds 1 to 10 rows to the right of the row that contains the selected cell. | |
Remove Row | Deletes the row that contains the selected cell. | |
Remove Column | Deletes the column that contains the selected cell. | |
Remove Empty Columns and Rows | Deletes any columns and rows that contain no elements. | |
Restore Column Sizes | Restores the default column sizes. | |
Restore Default View | Restores the default row sizes. | |
Merge Cells | Merges adjoining cells. | |
Split Cells | Splits previously merged cells. | |
Tab Order... | Opens the Tab Order... dialog box, where you can view or edit the order in which the TAB key moves the input focus from one field to another during verification. | |
Restore Default View |
Restores the original appearance of the form.
|
Testing
Menu item | Description | ||
Run Test | Starts testing the Document Definition on a document image. | ||
Finish Test | Stops testing the Document Definition. | ||
Image Mode | Enables the default document image viewing mode. | ||
Data Mode | Enables the default document data viewing mode. | ||
Layout | Image Window | Top | Places the image window at the top of the screen. |
Bottom | Places the image window at the bottom of the screen. | ||
Left | Places the image window on the left. | ||
Right | Places the image window on the right. | ||
Show Toolbar | Shows/hides the toolbar in data mode. In the image mode, the toolbar is always displayed and cannot be hidden. | ||
Show error message for active field | Changes the way errors are displayed for the current field. | ||
Verification | Next Item to Verify | Goes to the next item to be verified. | |
Previous Item to Verify | Goes to the previous item to be verified. | ||
Next Uncertain Character | Goes to the next low-confidence character. | ||
Previous Uncertain Character | Goes to the previous low-confidence character. | ||
Next Rule Error | Goes to the next rule error. | ||
Previous Rule Error | Goes to the previous rule error. |
Batch
Menu item | Description | |
Switch to Test Batch... | Allows testing the Document Definition using test batches. | |
Close Test Batch... | Closes the test batch. | |
View | Details | Switches to Details view. |
Thumbnails | Switches to Thumbnails view. | |
Customize Documents Table... | Opens the Choose Columns dialog box, where you can select columns to display and customize their view. | |
Load Images... | Opens the Load Images dialog box, where you can select images to be loaded and specify image pre-processing options. | |
Scan Images... | Opens a dialog box where you can scan images to be added to the batch. | |
Import Images... | Opens a dialog box where you can select an image import profile. | |
Recognize | Recognizes the batch. | |
Run Data Verification... | Runs verification on the batch. | |
Export | Exports the batch. | |
Export to | Data to Files... | Opens a dialog box where you can specify data saving options. |
Images to Files... | Opens a dialog box where you can specify image saving options. | |
Database... | Opens a dialog box where you can configure the database connection settings. |
Tools
Menu item | Description |
Autodetect Objects by Type... | Automatically detects and highlights fields and static elements of a certain type (depending on the mode). |
Update Index Fields | Updates links to existing fields |
Check Document Definition | Checks the Document Definition. |
Match Section | Checks the matching of a Document Definition section. |
Update FlexiLayouts... | Allows updating used FlexiLayouts. |
Update Definition with XFD... |
Updates a Document Definition created from an XML Form Definition. For more information, see Using XFD files to update Document Definitions. |
Options... | Opens a dialog box where you can select GUI colors and view or modify the keyboard shortcuts. |
Help
Menu item | Description |
Help Topics | Opens ABBYY FlexiCapture help file. |
Web Help | Opens ABBYY FlexiCapture help website. |
Send Feedback... | Allows users to send comments and suggestions to ABBYY. |
3/2/2021 8:10:42 AM