- 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
Rules
ABBYY FlexiCapture for Invoices uses rules to validate invoices automatically. Upon validation, an invoice is assigned a status and a list of issued errors and warnings is generated, enabling the Operator to decide whether the invoice needs to be verified manually. While verifying an invoice in the document editor, the Operator sees the list of errors detected by the rules and can use this list to navigate and review the defective fields.
ABBYY FlexiCapture for Invoices already includes pre-defined validation rules for invoices commonly used in different countries (See Rules). Users can modify or remove existing rules and create new custom rules.
Some features specific to rules in ABBYY FlexiCapture for Invoices
For detailed instructions on working with rules in ABBYY FlexiCapture See Rules.
Rules in ABBYY FlexiCapture for Invoices have the following specific features:
Rules may affect the status of a document
To make a rule affect the status of a document, the rule must have a corresponding prefix in its name. Rules with names prefixed with (Exception) or (Rejected) will change the status of an invoice to Exception or Rejected if the rule detects errors in that invoice.
Rules may be applied to a certain set of countries
To implement this feature, use conditions for applying rules. For more information, See Rules.
Rules detect the country of an invoice based on the country of the business unit to which the invoice has been issued.
If a certain kind of validation is relevant only to particular countries, only the relevant countries should be specified in the rule conditions. Conversely, if invoices from all countries must be validated except one particular country, be sure to exclude that country in the rule conditions (the condition must apply the rule only if the value of the country of the business unit is not the same as the name of the excepted country).
Using the list of rules
View the complete list of rules
To view all the rules set up for the project:
- From the Document Definition menu, select Document Definition Properties....
- In the dialog box that opens, click the Rules tab.
- In the Show rules list, select owned by Document Definition and its children.
To view all the rules that will be applied to invoices from a particular country, say, Germany use the filter.
Setting up a filter
- In the Document Definition Properties dialog box, click the Rules tab and then click the Filter... button.
- In the Filter dialog box, select If this condition is true and then select a desired field in Field in the Invoice Layout\BU\Country field, which defines the country of the business unit.
- Select the Overlaps with set condition from the drop-down list.
- Use the Select... button to specify the required countries in the field below. A Field Value dialog box will open, where you need to select the countries for which to display the rules. For Germany, for example, select DE.
- Click OK.
Now the list will display all the rules that will be applied for invoices of the country that you specified in the filter.
Note that the condition that triggers a rule is shown in the Apply rule column.
Finding a rule in the list
You can use the following filtering criteria to find a rule:
- rule name
- the name of a field referred to by the rule
- the condition that triggers the rule
- In the Document Definition Properties dialog box, click the Rules tab and then click the Filter... button.
- In the Filter dialog box, you can select the name of the rule you want to find (the names are listed alphabetically), select a field referred to by the rule, or specify the condition that triggers the rule.
For detailed instructions on using the filter, See Rules.
Creating new rules
To create a new rule:
- From the Document Definition menu, select Document Definition Properties....
- In the dialog box that opens, click the Rules tab.
- In the Show rules list, select owned by Document Definition and its children.
- Select the field where the rule will be stored. This may affect the operation of some rules (e.g. how its error messages are generated). If you have doubts as to which field to choose, select the topmost node, i.e. Invoice Layout.
- Click New Rule....
- In the dialog box that opens select one of the standard rule types, or select Script, which allows you to write your own rule.
Note: For detailed information about each rule type and for instructions on how to create them, See Rules.
The instructions below are specific to creating rules in ABBYY FlexiCapture for Invoices.
- After you have selected a rule type, you need to specify:
- Name
The name of the rule should reflect the kind of validation performed by the rule. Errors issued by the rule will be displayed to the Operator in the following format:
Rule name: Error message.
If you want the rule to affect the status of invoices, prefix its name with (Exception) or (Rejected), depending on the status you want assigned to an invoice if the rule detects an error. - Severity
Severity flags help the Operator to review the errors and warnings and decide which invoices should be verified manually.
Data export can also be made dependent on the severity flag. For example, you can:
- export documents that have no rule errors but have rule warnings to your working database
- export documents that have rule errors to an exceptions folder
- prohibit the export of document with errors altogether
For detailed instructions on setting up export based on the severity of a rule, See Rules.
- Whether the rule should be enabled after it is created (Rule is enabled option)
- In this step you need to specify the condition for applying the rule. Typically, this condition is defined by the value of the Invoice Layout\BU\Country field.
By default, the rule will always be applied (Apply rule=always). If you want the rule to be applied only under certain conditions: - From the Apply rule list, select on condition.
- Click Edit... to modify the condition.
- Select the field whose value will trigger the rule (Invoice Layout\BU\Country).
- Specify the condition and, if applicable, allowed and prohibited values.
Example 1. The rule must be applied to German invoices.
Select the Belongs to set condition, click Add, and add the value DE.
Example 2. The rules must be applied to all invoices except German and French invoices.
Select the Does not belong to set, condition, click Add, and add the values DE, FR. - In this step, you need to set up the rule. For detailed information, See Rules.
Disabling a rule
To disable a previously set up rule:
- Find the rule in the list (see above).
- Clear the box in the Enabled column next to this rule. Alternatively, double-click the rule to open its Properties dialog box and clear the Enabled rule option on the General tab.
If you are certain that you will no longer need a rule, you can delete it. To delete a rule:
- Find the rule in the list (see above).
- Select the rule by clicking its name in the list and then click Delete.
02.03.2021 8:10:42