15
ABBYY FineReader Engine 12 User's Guide: Contents
Enumerations ............................................................................................................................................................ 760
AltoVersionEnum ............................................................................................................................................ 761
AvailableBarcodeModulesFlags ................................................................................................................ 761
AvailableEngineModulesFlags ................................................................................................................... 762
AvailableExportFormatsFlags ..................................................................................................................... 764
AvailableLanguageSetsFlags ...................................................................................................................... 765
AvailableTextTypesFlags .............................................................................................................................. 767
AveragingMethodEnum ............................................................................................................................... 768
BackgroundColorModeEnum ..................................................................................................................... 769
BarcodeOrientationEnum ............................................................................................................................ 770
BarcodeSupplementTypeEnum .................................................................................................................. 771
BarcodeTypeEnum ......................................................................................................................................... 772
BaseLanguageLetterSetEnum ..................................................................................................................... 775
BitmapBitsFormatEnum ................................................................................................................................ 776
BlockLayerTypeEnum .................................................................................................................................... 777
BlockRoleEnum ............................................................................................................................................... 778
BlockTypeEnum ............................................................................................................................................... 779
BusinessCardFieldComponentTypeEnum ............................................................................................... 781
BusinessCardFieldTypeEnum ...................................................................................................................... 783
BwPictureFormatsEnum ................................................................................................................................ 784
CaseRecognitionModeEnum ...................................................................................................................... 785
CharacterFlags ................................................................................................................................................ 786
ClassifierTypeEnum ....................................................................................................................................... 787
CodePageEnum .............................................................................................................................................. 788
ColorPictureFormatsEnum ........................................................................................................................... 792
CorrectSkewModeEnum .............................................................................................................................. 793
DetectColorRegionFlags .............................................................................................................................. 795
DictionaryTypeEnum ..................................................................................................................................... 795
DitheringMethodEnum ................................................................................................................................. 796
FieldMarkingTypeEnum ................................................................................................................................ 797
FileExportFormatEnum ................................................................................................................................. 798
FontEmbeddingModeEnum ........................................................................................................................ 801
FontFormattingModeEnum ......................................................................................................................... 801
FontNamesFiltersEnum ................................................................................................................................. 802
FontTypeEnum ................................................................................................................................................ 806
FREngineModuleEnum ................................................................................................................................. 806
GrayPictureFormatsEnum ............................................................................................................................ 807
HTMLDocumentSplittingModeEnum ........................................................................................................ 809
HTMLFormatModeEnum ............................................................................................................................. 809
HTMLSynthesisModeEnum ......................................................................................................................... 810
HyperlinkSchemeEnum ................................................................................................................................. 811
ImageColorTypeEnum .................................................................................................................................. 812
ImageFileFormatEnum .................................................................................................................................. 812
ImageTypeEnum ............................................................................................................................................. 817
16
ABBYY FineReader Engine 12 User's Guide: Contents
LanguageCategoryEnum ............................................................................................................................. 817
LanguageIdEnum ........................................................................................................................................... 818
LicenseCounterTypeEnum ........................................................................................................................... 823
MessagesLanguageEnum ........................................................................................................................... 824
MonospaceDetectionModeEnum ............................................................................................................. 826
MultiProcessingModeEnum ........................................................................................................................ 827
NoiseModelEnum .......................................................................................................................................... 828
NumberingStyleEnum ................................................................................................................................... 829
ObjectsColorEnum ......................................................................................................................................... 835
ObjectsTypeEnum .......................................................................................................................................... 836
OrientationDetectionModeEnum .............................................................................................................. 837
PageFlushingPolicyEnum .............................................................................................................................. 837
PageOrientationEnum ................................................................................................................................... 838
PageProcessingStageEnum ........................................................................................................................ 839
PageSplitDirectionEnum ............................................................................................................................... 840
PageSplitTypeEnum ....................................................................................................................................... 840
PaperSizeDetectionModeEnum ................................................................................................................. 841
PaperSizeModeEnum ................................................................................................................................... 842
ParagraphAlignmentEnum .......................................................................................................................... 843
ParagraphExtractionModeEnum ............................................................................................................... 843
ParagraphRoleEnum ..................................................................................................................................... 844
ParagraphTabAlignmentEnum ................................................................................................................... 846
PDFAComplianceModeEnum ...................................................................................................................... 846
PDFAttachmentBindingEnum ....................................................................................................................... 848
PDFEncryptionAlgorithmEnum ................................................................................................................... 848
PDFExportModeEnum .................................................................................................................................. 849
PDFExportScenarioEnum ............................................................................................................................. 850
PDFKeyLengthEnum ....................................................................................................................................... 851
PDFMRCModeEnum ...................................................................................................................................... 852
PDFResolutionTypeEnum ............................................................................................................................. 853
PDFVersionEnum ............................................................................................................................................ 854
PhotoProcessingModeEnum ...................................................................................................................... 855
PictureColorityModeEnum .......................................................................................................................... 856
QueuePushingModeEnum ........................................................................................................................... 856
ReadingTypeEnum ......................................................................................................................................... 857
RemoveGarbageRegionFlags .................................................................................................................... 858
RotationTypeEnum ........................................................................................................................................ 858
RTFPageSynthesisModeEnum .................................................................................................................... 860
SeparatorTypeEnum ..................................................................................................................................... 861
SkewCorrectionModeEnum ........................................................................................................................ 862
SourceContentReuseModeEnum .............................................................................................................. 862
StyleParamsEnum ........................................................................................................................................... 863
TabLeaderTypeEnum .................................................................................................................................... 865
TableSeparatorTypeEnum ........................................................................................................................... 866
17
ABBYY FineReader Engine 12 User's Guide: Contents
TextAndBackgroundColorModeEnum ..................................................................................................... 867
TextCategoryEnum ........................................................................................................................................ 867
TextEncodingTypeEnum ............................................................................................................................... 868
TextLanguageLetterSetEnum ...................................................................................................................... 870
TextLayoutRetentionModeEnum ............................................................................................................... 871
TextTypeEnum ................................................................................................................................................. 871
ThreeStatePropertyValueEnum .................................................................................................................. 873
TimeoutHandlingModeEnum ..................................................................................................................... 875
TimeZoneTypeEnum ...................................................................................................................................... 875
TrainingModeEnum ....................................................................................................................................... 876
TXTExportFormatEnum ................................................................................................................................ 877
UserPatternsTrainingFlags .......................................................................................................................... 877
VolumeRefreshingPeriodEnum .................................................................................................................. 878
WordModelTypeEnum ................................................................................................................................. 879
XLSXLayoutRetentionModeEnum .............................................................................................................. 881
XLSXPaperSizeEnum ..................................................................................................................................... 882
XMLCharAttributesEnum .............................................................................................................................. 885
Return Codes ............................................................................................................................................................ 886
Licensing ................................................................................................................................ 889
Activation .................................................................................................................................................................... 890
License Manager Utility ......................................................................................................................................... 892
Working from the Command Line ............................................................................................................ 893
Working with the LicensingSettings.xml File .................................................................................................... 895
Modules ..................................................................................................................................................................... 902
Installing the Wibu CodeMeter Drivers ............................................................................................................ 915
Counter Increasing Methods ............................................................................................................................... 916
Copyright and Trademark Notices .................................................................................................................... 918
Minimum Terms of EULA ...................................................................................................................................... 939
Distribution ........................................................................................................................... 940
Installing the Library ............................................................................................................................................... 940
Activating the Library .............................................................................................................................................. 942
Installing the Licensing Service .................................................................................................................. 943
Distribution Kit .......................................................................................................................................................... 945
Distribution Kit: PDF ...................................................................................................................................... 982
Working with the FREngine12_Distribution.csv File .............................................................................. 986
Specifications ....................................................................................................................... 990
Supported Image Formats ................................................................................................................................... 990
Predefined Languages ........................................................................................................................................... 992
Text Types ............................................................................................................................................................... 1005
Barcode Types ....................................................................................................................................................... 1006
Export Formats ...................................................................................................................................................... 1010
XML Schema Description .......................................................................................................................... 1011
18
ABBYY FineReader Engine 12 User's Guide: Contents
Predefined Profiles Specification ...................................................................................................................... 1034
What's New ............................................................................................................................................................. 1040
Backward Compatibility Issues .......................................................................................................................... 1041
Version 11 ...................................................................................................................................................... 1041
Version 10 ...................................................................................................................................................... 1061
Business Cards API ....................................................................................................................................... 1062
Functions ...................................................................................................................................................... 1063
Engine Object ............................................................................................................................................... 1064
Engine for Java .......................................................................................................................................... 1069
Image-Related Objects ................................................................................................................................ 1069
Layout-Related Objects ............................................................................................................................... 1075
Language-Related Objects ......................................................................................................................... 1077
Text-Related Objects ................................................................................................................................... 1080
Document-Related Objects ........................................................................................................................ 1084
Batch Processor ............................................................................................................................................ 1092
Mechanism Objects ..................................................................................................................................... 1092
Parameter Objects ....................................................................................................................................... 1097
License-Related Objects .............................................................................................................................. 1122
Supplementary Objects ............................................................................................................................... 1124
Differences between ABBYY FineReader Engine for Windows and Linux ............................................ 1126
Documentation Changes ..................................................................................................................................... 1128
System Requirements .......................................................................................................................................... 1134
Frequently Asked Questions ........................................................................................... 1136
Contact ABBYY ................................................................................................................... 1142
How to Buy .............................................................................................................................................................. 1142
Technical Support ................................................................................................................................................. 1142
ABBYY FineReader Engine 12 User's Guide: Introduction
19
Introducing ABBYY FineReader Engine 12
Welcome to ABBYY FineReader Engine 12!
We are glad to welcome you to our new, substantially improved ABBYY FineReader Engine.
In addition to the improved recognition process technologies, FineReader Engine 12 takes the user
experience to a whole new level with:
· Optimally balanced profiles with fine-tuned task parameters
· Market-leading recognition accuracy
· Amazing processing speed
· A record 208 recognition languages, including Chinese, Japanese, Korean and Arabic
· Comprehensive Developer's Help
Key New Features
With the upgraded FineReader Engine, you get:
· Improved Japanese OCR
· New deployment options
· Support for additional languages
· Improved document layout recreation
· New scanning features
· New export formats
Basic Usage Scenarios
Extensive ABBYY SDK experience in hundreds of products all over the world helps us identify the most
common usage scenarios:
Document Conversion
Scenarios
Scenarios for Data Capture General Scenarios
· Document Conversion for
Content Reuse
· Document Archiving
· Book Archiving
· Text Extraction
· Field-Level Recognition
· Barcode Recognition
· Business Card Recognition
· Image Preprocessing
· Document Classification
How to Use This Help
In this Developer's Help you can find all the necessary information about ABBYY FineReader Engine 12.
Guided Tour
See the Guided Tour section to learn about how to use ABBYY FineReader Engine:
· Basic Usage Scenarios Implementation
Here you can find out how you can use ABBYY FineReader Engine for your specific task.
· Advanced Techniques
Contains information for advanced users.
· Best Practices
ABBYY FineReader Engine 12 User's Guide: Introduction
20
Offers some advice on how to prepare images for recognition.
· Samples
A short description of available samples. A detailed description of the samples can be found in the Code
Samples Library provided with this distribution pack.
API Reference
Complete FineReader Engine API reference.
Licensing
Important information about ABBYY FineReader Engine licenses and activation.
Distribution
Information about distribution of applications which use the ABBYY FineReader Engine library.
Specifications
The list of supported image formats, predefined languages, text types, barcode types, export formats,
system requirements, and:
· What's New in ABBYY FineReader Engine 12
· Compatibility with ABBYY FineReader Engine 11
Frequently Asked Questions
Most frequently asked questions about ABBYY FineReader Engine.
Contact ABBYY
Here you can find the contact information of the ABBYY offices and technical support service.
Please visit our website at www.abbyy.com for the most up-to-date information about ABBYY FineReader
Engine.
Basic Usage Scenarios OverviewThis section describes the most common scenarios in which ABBYY FineReader Engine may be used. We
recommend that you begin work with ABBYY FineReader Engine by selecting the scenario most suitable for
your task. After you found the appropriate scenario, you can find a detailed description of the scenario,
implementation advice, and suggestions on optimizing the code for specific tasks in the Basic Usage
Scenarios Implementation section.
Document Conversion
The result of this
scenario is an editable
version of a document.
In this scenario,
document images are
recognized, retaining all
the original formatting
intact, and the data are
ABBYY FineReader Engine 12 User's Guide: Introduction
21
Document Conversion
saved to an editable file
format. As a result, you
get editable versions of
your documents, which
can be easily checked
for errors and
modified.
See Document
Conversion for details.
In this processing
scenario, paper
documents are
converted into non-
editable digital copies
containing all document
information in a
searchable format. As a
result of such
processing, digital
copies of documents
may be easily found in
an electronic archive
using full-text search,
document text
segments may be
copied, and documents
may be sent by e-mail
or printed out.
See Document
Archiving for details.
This scenario is used
for processing books,
magazines, and
newspapers to create
an electronic library;
for instance, when
digitizing paper book
collections for
purposes of facilitating
and expanding access
to them and for their
preservation.
ABBYY FineReader Engine 12 User's Guide: Introduction
22
Document Conversion
In this scenario, books,
magazines, and
newspapers are
converted into non-
editable digital copies
containing all
information from the
source in a searchable
format.
See Book Archiving for
details.
Data Capture
This scenario is used to
recognize all document
text in order to prepare
documents for search
and extraction of useful
data.
Such a scenario may
serve as a basis for
implementing more
complex scenarios to
extract important data
from documents,
especially for
automated input of
paper document data
into information
systems and databases,
and for automated
classification and
indexing of documents
in document
management systems
(e.g., inputting invoices
into accounting
software, inputting
questionnaires into a
CRM system).
This scenario enables
the extraction of the
body text of a
document and texts on
ABBYY FineReader Engine 12 User's Guide: Introduction
23
Document Conversion
logos, seals, and on
any elements other than
the body text.
See Text Extraction for
details.
In the case of field-level
recognition, short text
fragments are
recognized in order to
capture data from
certain fields.
Recognition quality is
crucial in this scenario.
This scenario may also
be used as part of
more complex
scenarios where
meaningful data are to
be extracted from
documents (for
example, to capture
data from paper
documents into
information systems
and databases or to
automatically classify
and index documents in
Document Management
Systems).
In this scenario, the
system recognizes
either several lines of
text in only some of the
fields or the entire text
on a small image. The
system computes a
certainty rating for each
recognized character.
The certainty ratings
can then be used when
checking the
recognition results.
Additionally, the system
may store multiple
recognition variants for
ABBYY FineReader Engine 12 User's Guide: Introduction
24
Document Conversion
words and characters in
the text, which may then
be used in voting
algorithms to improve
the quality of
recognition.
See Field-Level
Recognition for details.
In this scenario, ABBYY
FineReader Engine is
used to read barcodes.
Barcodes may need to
be read, for example,
for purposes of
automatic document
separation, for
processing documents
by a Document
Management System,
or for indexing and
classifying documents.
This scenario may be
used as part of other
scenarios. For example,
documents scanned
with high-speed
production scanners
may be separated by
means of barcodes, or
documents prepared
for long-term storage
may be placed into
archiving Document
Management Systems
based on the values of
their barcodes.
When extracting
barcodes from texts,
the system may detect
all barcodes or only
barcodes of a certain
type with a certain
value. The system may
get the value of a
ABBYY FineReader Engine 12 User's Guide: Introduction
25
Document Conversion
barcode and calculate
its check sum.
Recognized barcode
values can be saved
into formats most
convenient for further
processing, for
example into TXT.
See Barcode
Recognition for details.
Business cards contain
business information
about a company or a
person. Business cards
can include person
name, company,
telephone numbers, fax,
e-mail, website
addresses and similar
information. You may
need to capture this
information from paper
business cards and
save it in electronic
format. It can be an
electronic address
book of a mobile
phone, e-mail client, or
any other data storage
system. For example,
business cards are
often passed by e-mail
or network in vCard
format.
See Business Cards
Recognition for details.
General