- 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
Exporting data to a file
To configure export to file, proceed as follows:
- In the Document Definition editor window, click Document Definition → Export Settings...
- Click Add... and select Export to data files in the Type field.
- Specify whether export is obligatory.
- Specify whether images should be exported.
- Specify which documents (with and/or without errors) should be exported and click Next>.
- Specify the export parameters and click Next>. The adjustable export parameters depend on the value specified in the Target field.
- Recreate filenames and structure of Hot Folder subfolders,
details
If you select this value, the folder structure will mimic that in the Hot Folder the document images had been imported from. When configuring this export type, select the folder to mimic the Hot Folder structure in the Export path field.
- Export all documents to one file,
details
Select this value to export all data to one file. When configuring this export type, enter the path and the name of the file to export data to in the Export path field.
- Create a separate folder for each batch,
details
Select this value to export each document to a separate file:
- Specify the path and the first characters of the file name in the File prefix field;
- For each batch to be exported to a separate folder, select Create a separate folder for each batch.
- Create folder structure and filename using template,
details
If you select this value, file names and the subfolder structure will form depending on the document parameters.
- Specify the root export path in the Export path.
- Specify the file naming options. To do it, click Edit... and specify the necessary rules. For more information, see Export file naming options.
- In the If file exists field, select the action for the program to carry out if a file with the generated name already exists.
The export path is specified relative to the root folder specified in Project Properties. You only need to specify a name of subfolder to which documents will be saved. If you need to use the export path which is different from the root path in Project Properties, you need to specify the export path in UNC format (\\computer_name\share_name[\path]). Also, make sure all the stations involved in exporting have access to the specified location. Export errors will occur, if the path is specified in the following format: \[path].
- Select a file saving format, specify additional export properties for the selected file type, and select the text encoding, if necessary. Then click Next>.
Microsoft Office Excel workbook (*.xlsx)
- Select Preserve value type on export to export the data basing on its types. Clear this option to export all data with the General type.
Note: Works only for the fields of the Number type.
- Select Make separate files for repeatable items to export tables and fields with multiple repetitions to separate files. Mind the note.
- Configure the field names and format, if necessary. To do it, click Field Mapping and, in the Field Mapping dialog box, specify the field names and the format of fields with numbers and dates.
Microsoft Office Excel workbook (*.xls)
- Select the Excel version (5.0/95; 97-2003; 97-2003 (compatible with 5,0/95)).
- Select Preserve value type on export to export the data basing on its types. Clear this option to export all data with the General type.
Note: Works only for the fields of the Number type.
- Select Make separate files for repeatable items to export tables and fields with multiple repetitions to separate files. Mind the note.
- For Excel 5.0/95, select a code page. See Export file formats.
- Configure the field names and format, if necessary. To do it, click Field Mapping and, in the Field Mapping dialog box, specify the field names and the format of fields with numbers and dates.
XML Document (*.xml)
- Specify the additional data to be exported (field locations and types, errors, recognition quality data).
- Select Preserve value type on export if you want to save the xml-scheme with field type descriptions.
- Select the encoding. See Export file formats.
- Specify the field names, if necessary. To do it, click Field Mapping and, in the Field Mapping dialog box, specify the field names.
Comma-separated values file (*.csv)
- Select Column separator.
- Select Make separate files for repeatable items, if you want tables and fields with multiple repetitions to be exported to separate files. Mind the note.
- Select the encoding and a code page. See Export file formats.
- Configure the field names and format, if necessary. To do it, click Field Mapping and, in the Field Mapping dialog box, specify the field names and the format of fields with numbers and dates.
Text file (*.txt)
- Select Column separator.
- Select Make separate files for repeatable items, if you want tables and fields with multiple repetitions to be exported to separate files. Mind the note.
- Select the encoding and a code page. See Export file formats.
- Configure the field names and format, if necessary. To do it, click Field Mapping and, in the Field Mapping dialog box, specify the field names and the format of fields with numbers and dates.
DBase file (*.dbf)
- Select Preserve value type on export to export data basing on its types. Clear this option for all the fields to be of the Text type.
- Select Make separate files for repeatable items, if you want tables and fields with multiple repetitions to be exported to separate files. Mind the note.
- Select a code page. See Export file formats.
- Configure the field names, if necessary. To do it, click Field Mapping and, in the Field Mapping dialog box, specify the field names.
JSON Document (*.json)
- Specify the additional data to be exported (field locations and types, errors, recognition quality data).
- Select Preserve value type on export to export the data basing on its types.
- Select the encoding. See Export file formats.
- Specify the field names, if necessary. To do it, click Field Mapping and, in the Field Mapping dialog box, specify the field names.
Important! Complete steps 8 and 9 only if you selected the Save document images option in step 4.
- If you want to save the images, specify the image saving parameters and click Next>.
- Choose either to save images together with the data or to specify the image folder;
- Select the image file naming scheme: similar to the data files or otherwise. See Export file naming options.
- Specify the fields that contain images you want to hide during export.
- If images should be stored, specify image storage options and click Next>.
- Select the desired image format, quality, and color.
- To change the resolution of the source images, select Change resolution to and select the appropriate value from the list.
- If you select PDF or PDF/A as a storage format, you can create searchable PDF files.
- Enter an export profile name and click Finish.
The program will export all values of document fields to one or more files of the specified format.
Note: By default, repeating fields (i.e., fields with multiple instances and tables) are exported into separate files for which a new folder is created. The name of the folder consists of the name of the export file. To disable export of repeating fields into separate files, clear the option Make separate files for repeatable items on the Export Destination Wizard tab (the option is available for all formats except XML). In this case, when repeating fields will be exported into one export file and the program will add a new line for each element instance.
Note: When exporting data about exported images (images of pages or fields) to a file, the path to the file can be:
- relative, if the images are being exported to the same folder as the file (or its subfolders);
- absolute in all other cases.
3/2/2021 8:10:42 AM