Navigation Content

Nuance OmniPage Capture SDK
16.6 Update

Nuance OmniPage Capture SDK 16.6 Release Notes

October 28, 2011

Copyright © 1995-2011 Nuance Communication Inc. All Rights Reserved.

Installation Information

Before installing this 16.6 release of the product, uninstall all previous versions (point releases) of CSDK 16.x.
Run Setup.exe from the installation CD or use AutoRun.

System requirements

System requirements for a computer used to develop a Capture SDK-enabled application under Windows XP, Windows Server 2003 and Windows Vista 32/64:

  • Pentium class personal computer with 800 MHz or higher processor (at least Pentium 4 is recommended)
  • 256 MB minimum RAM (recommended 512 MB, or more for working with grayscale or color images)
  • 500 MB free disk space
  • VGA or higher-resolution monitor with 2 MB RAM (Super VGA recommended)
  • CD-ROM drive

(Under Windows XP x64 CSDK16 runs in WOW64. CSDK16 has not been tested in this environment.)

System requirements for a computer used to run a Capture SDK-enabled application under Windows XP, Windows Server 2003 and Windows Vista 32/64:

  • Pentium class personal computer with 800 MHz or higher processor (at least Pentium 4 is recommended)
  • 128 MB minimum RAM (recommended 256 MB, or more for working with grayscale or color images)
  • Up to 200 MB free disk space (less if not all recognition modules are distributed)
  • VGA or higher-resolution monitor with 2 MB RAM (Super VGA recommended)

(Under Windows XP x64 CSDK16 runs in WOW64. CSDK16 has not been tested in this environment.)

Getting Started

Please read [CSDK16]\Documentation\CSDK16_Quick_Start_Guide.pdf for a quick start. New features are listed in the 2nd chapter of the User's Guide: [CSDK16]\Documentation\CSDK16_Users_Guide.pdf.
[CSDK16]\Documentation\CSDK_Porting_Guide.PDF contains detailed information about porting applications from v12.x to v15/v16.

Please read “Activation steps” in Chapter 1 of [CSDK16]\Documentation\CSDK16_Users_Guide.pdf for information on activating the license for your developers kit installation. The section “License Types” in the same chapter contains useful information on how products developed using the CSDK are licensed. 

Online help is provided by four HTML systems. General platform-independent information has been separated out and placed in a new help system. The offering is as follows:

  • General Introduction: System requirements, Licensing, Testing and Distributing Applications, etc.
  • RecAPI: Full reference of all functions, enums and parameters for C++ implementation. This system contains most of the overview and reference topics which are not repeated for IPRO or Visuals.
  • IPRO: Full reference of the object model, events, methods and properties.
  • Visual Toolbox: Full description of all visual components.

Vista Issues

  • Compiling and linking sample applications needs Visual Studio to be used in the mode "Run as Administrator".

User Development tools

The following development tools are considered as "fully supported" by the Capture SDK.

  • Microsoft Visual C++, Version 6.0 SP6 or higher
  • Microsoft Visual Studio.NET 2003 Version 7.1
  • Microsoft Visual Studio 2005 (SP1 is used to produce the Capture SDK)
  • Microsoft Visual Studio 2008
  • Microsoft Visual Studio 2010

Other (not tested) development environments with COM and/or .NET Client support should also work with CSDK.

Known Issues

  • CSDK16 Installer and RSD do not support Windows 2000.
  • RecIproPlus API cannot be used from Visual Studio 2010 due to a type name collision (IDocument).

Technical Notes

The following technical notes are considered as additions to the documentation.

  • Selected Output formats .NET 3 Framework installed
    DOCX, PPTX, XLSX and XPS outputs use the .NET 3 Framework. If your application requires these outputs, your installer has to install .NET 3 on destination computers if it is not already present.
  • C++ Exceptions may occur under Debugger
    Add a new C++ Exception to the Debugger exception handlig to avoid unwanted debugger breaks:
    - Go to Debug->Exceptions. In the Exceptions dialog box click the Add... button.
    - Select type C++ Exceptions.
    - Type the name PDF_PROGRESS.
    - Click OK.
    - Under C++ Exceptions - PDF_PROGRESS leave the Thrown checkbox unmarked.
  • .NET 1.1 Framework is not supported by RecAPI P/Invoke and IProPlus.NET
    Only .NET 2.0 Framework compatible applications can use these interfaces.
  • Saving XPS image only output
    The application must call CoInitialize(NULL) when it wants to save XPS image files using kRecSaveImg()to set the required STA mode. For more information, see ms-help://MS.VSCC.v80/MS.MSDN.v80/MS.WIN32COM.v10.en/com/html/0f171cf4-87b9-43a6-97f2-80ed344fe376.htm
  • VB6 support removed
    Officially CSDK16 does not support VB6 integration. No sample application and technical support is available for VB6 applications.
  • Application that uses kRecInitS and RecInitPlusS at the same time
    The application has to inlude these header files in this definite order:
    #include "...\include\KernelAPIS.h"
    #include "...\include\RecApiplusS.h"

    In addition, the kRecInitS function has to called before RecInitPlusS. This usage is different from kRecInit/RecInitPlus pair

    //If the program uses OCR license
    rc = kRecSetLicenseS(OEMLicenseFile, "Your public key");

    rc = kRecInitS("C:\\Program Files\\Nuance\\OPCaptureSDK16\\Bin\\", NULL, NULL);
    rc = RecInitPlusS("C:\\Program Files\\Nuance\\OPCaptureSDK16\\Bin\\", NULL, NULL);

    // Your code comes here

  • Amplib license file
    Handling the path of the Amplib (barcode) license file has been changed. By default the DevKit searches for AMPLIB OEM license files on their installation path. (Previously that path was %SystemRoot%\AMP\Licenses\) If the application calls the RecAPI function kRecSetLicense and defines a path, the DevKit will search AMPLIB license files on this path.
  • Multiple scanner support in CSDK
    The Scanner Wizard lets you set up multiple scanners to be used in your integrating application. Due to some unresolved scanner-specific issues, the installed scanner settings might conflict. Therefore we highly recommend not to set up more than one scanner at a time for a single application.
  • Font cache file
    On first CSDK launch a font cache file fontlist6.opf is created in the folder %ALLUSERSPROFILE%\Application Data\Nuance\OmniPageCSDK16. If you install any new fonts on the system, you have to delete this file (fontlist6.opf). It will be recreated with an updated font listing on next launch.
  • On Vista 64bit OS, VSAppCSharp80.exe, VSAppCSharp90.exe, VSAppVBNET80.exe, VSAppVBNET90.exe applications do not run.
    Please rebuild them with x86 CPU setting.
  • Porting Asian applications
    All CSDK 15 functions applicable to Asian recognition were marked with the prefix ASN. When porting to v16, this should be removed since Asian recognition is done through the normal version 16 functions: the difference is marked by recognition language selection only. The language should be defined early in the settings processes, since it can influence which further settings are available or have an effect.
    All v15 functions are available in this current version, plus many new ones. Parameter choice is similar for both Asian and Western languages. On differences, see Chapter 2 of the User's Guide. The logical architecture is the same in both versions: processing passes through the same basic steps: initialization, specifying settings, loading images, preprocessing, recognition, exporting and then quitting.
    To port an application with 1000 lines of code from Asian v15 to v16 could take a day, including basic testing. Creating a distribution set and performing more thorough testing might take another day. There is not much difference between the previous and current versions when you use plain text output, but clear improvements should be apparent in the formatted output from the new kit.
  • OEM runtime licenses are not recommended to be used on a computer with the Capture SDK development environment installed.

    Purpose: As it is a runtime license it is intended to be used and tested in a runtime environment.
    Resolution: Test your OEM licensed application on a clean test computer (no CSDK installation).

    Reasons why we strongly recommend testing your distribution and runtime licenses together on a test computer (no CSDK installation and other development environments):

    1.       Your clients’ computers may not contain any development environment that includes common binaries and registry settings. Testing the distribution on a development computer can therefore be misleading, as the developer machine contains all relevant binaries and registry settings, and therefore will not pinpoint potential installation problems.

    2.       As a Fixed Volume License (FVL) and an OEM license are merged in memory during run time, OEM license test will fail on a developer computer, because the developer license is merged. Your developer license, which is an FVL, may contain more enabled features than you need in a particular application. For example, if you forgot to include Asian functionality in the OEM file but you have it in the developer license, your program will run unproblematic Chinese recognition on the developer machine but not on the client’s computer.

    Two simple solutions to run and debug your application with the CSDK distribution file set but still in a development environmentment (you can use either of them):

    1.       Simple logic in your code: when the OEM file is not present, the function kRecSetLicense should not be called. Running it on the developer machine where the OEM license file is not present, the application will use the developer license.

    2.       Using conditional compilation you can exclude the code line containing the function kRecSetLicense when making a Debug build. You can debug your application with the CSDK distribution file set using the developer license available on the developer machine.

  • Redistributable Microsoft file sets for deployments
    In all cases the deployment of your own Capture SDK-enabled application requires you to include one of the redistributable file sets from Microsoft. The Distribution Wizard of Capture SDK provides you with hints specifying which merge modules contain the redistributable file set necessary for your particular deployment. This section tries to simplify your options:

    • As the Capture SDK was built with Microsoft VS 2005, the Distribution Wizard will advise several merge modules of VS 2005. To simplify your deployment you can use the Microsoft Visual C++ 2005 Redistributable Package (x86) – VCRedist_x86.exe. It covers all necessary Microsoft binaries from those merge modules. This VCRedist_x86.exe exe can be downloaded from:
    • If your application uses the Scanning Support or the Logical Form Recognition module of CSDK or your application performs zone I/O operations, you need to include the MSXML4 redistributable package in your deployment. You can download it from:
    • If your application is built with VS.NET 2003 (version 7.1) and it uses the RECIPRO interface of CSDK, the Distribution Wizard may advise several 7.1 merge modules to be included. You can find those MSM files in your development environment (e.g. "C:\Program Files\Common Files\Merge Modules" in Windows XP) and can add them easily to your deployment.

    Point Release 6

  • This release contains about 50 changes for better stability reported by CSDK Users
    Changes are related to image specific issues. This release also contains all previous point releases.

    Point Release 5

  • New RecAPIPlus function: RecGetPage
    For more information see the description in RecAPIPlus.h or RecAPI.chm
  • New KernelAPI function: kRecGetPreprocessInfo
    For more information see the description in KernelAPI.h or RecAPI.chm
  • New KernelAPI function: kRecSetImgResolution
    For more information see the description in KernelAPI.h or RecAPI.chm
  • New JPEG library
    Release 7 JPEG library used
  • Stability issues resolved
    Customer-reported image specific reliability issues have been fixed.
  • InstallShield 2010
    CSDK 16.5 changed to use InstallShield 2010.
  • Point Release 4

  • Updated AMPLIB Barcode engine to
    A couple of Data Matrix issues have been fixed in the updated engine.
  • Updated RER handprint recognition module
    Updated version: Kadmos 4.4p
  • Updated JPEG image file library
    The updated version can be used more efficiently resulting in performance improvements.
  • Reduced PDF MRC file size
    • Improved JPEG/JPEG2000 compression can result in significantly reduced PDF/MRC output file sizes in the vast majority of cases.
    • Option "MRC lossless" is now optimized for good quality with reduced file size.
  • Improved table and line detection on Asian images
  • Image-specific improvements
    Some image-specific issues reported by customers have been fixed.
  • The setting "APIPlus.FreehPageAfterInsert" has effect on both RecInsertPage and RecUpdatePage
    This setting can be used to retain HPAGE after inserting it into HDOC or after updating a page in HDOC with it. For more details see RecAPI Help.
  • Loading password protected PDFs the warning dialog can be suppressed both in RecAPI and IPRO by means of the setting "APIPlus.ProcessPagesEx.PasswordWarning".
    For the details of the setting see the section "Point Release 3" below.
  • The missing ISApp90 and VSApp90 solution and project files have been added to the Samples folder.
  • Handling of pleading numbers in legal documents has been improved.
    Now pleading detection works even if not every line is numbered, for instance when each fifth line is numbered.
  • In RECIPRO, CRecPage now has a correctly named member SetFindAdditionalZones.
    The SetFindAdditionalZones method  was accidentally misnamed as "GetFindAdditionalZones". Now it has been corrected, and the existing GetFindAdditionalZones method that was implemented in place of SetFindAdditionalZones has been renamed as appropriate. (See reciproinc.h)


    Point Release 3

  • New DTXT PDF output converter settings
    The following settings affect the output:
    Name Brief description Values Default value
    Kernel.DTxt.PDF.BWFormat The compression used for BW images "TIF_G4" or "JBIG2" "JBIG2"
    Kernel.DTxt.PDF.ColorFormat The compression used for 24bit color images "JPEG" or "JPG2000" "JPG2000"
    Kernel.DTxt.PDF.BWQuality To use lossy or lossless compression for JBIG2 "min" or "lossless" "min"
    Kernel.DTxt.PDF.ColorQuality Compression quality for JPEG and JPG2000 "min", "good" or "lossless" "min"
    Kernel.DTxt.PDF.BWMaxDPI Maximum allowed DPI for BW images 0 means no restriction 0
    Kernel.DTxt.PDF.ColorMaxDPI Maximum allowed DPI for color images 0 means no restriction 0
    Kernel.DTxt.PDF.CompressContentStream The content streams in the output will be compressed. false or true true
    Kernel.DTxt.PDF.Linearized The output will be also a "linearized PDF". false or true false
    Kernel.DTxt.PDF.PDFA The output will be PDF/A compliant. false or true false

  • Document. LoadImage(const CString FileName /*= _T("")*/, long InsertPos /*= -1*/, long ImageIndex /*= -1*/);
    If the optional ImageIndex Long parameter is specified, only the requested (1 based indexed) page is loaded from a multi-page image file. If it is unspecified, all contained pages are loaded.

  • Uninstaller removes all files from "Program Files\Nuance\OmniPageCSDK16" folder and sub-folders
    All user files as well.
  • How to compile ISApp or VSApp samples with Visual Studio 2008
    You just launch VS2008 and open the MyISApp80.sln solution. VS2008 offers to convert it to the new 2008 format. Accept it and you can immediately compile the VB.NET and CSHARP projects. The MFC project has some link problem which can be fixed by getting the Property Page of MyISappMFC80 and in the Linker -> Input tab write:

    Additional Dependencies: RecIproPlusExe90UD.lib htmlhelp.lib mfcs90ud.lib
    Ignore Specific Library: mfcs90ud.lib
  • The CSDK can now produce UTF-8 enconded XML output files in addition to UTF-16 enconding.
    kRecSetCodePage("UTF-8"); works on XML output.
  • New setting for RecProcessPagesEx() function for handling password protected PDF files.
    The default value is true. This means during RecProcessPagesEx a password dialog box pops up. If the setting is false, a master password protected PDF file will be loaded as image without prompting for the password.
  • The default value of the setting Kernel.Img.Rotation.EnabledForAsian is TRUE.

    Point Release 2

  • Additional UI Language support
    CSDK16.2 has 5 new UI languages in the Visual Controls and Scanner Wizard.
    New languages are: Brazilian Portuguese, Dutch, Italian, Spanish, Swedish
  • CSDK can process multipage input files safely up to 500 pages per formatted (RecAPIPlus) output file.
    There is a workaround if the application needs to export more than 500 pages into one output file.
    See this code fragment in the Support/500Pages folder in CD content.
  • CMC7 font support
    New filling method intoduced. FM_CMC7 for the RM_RER recognition module. If FM_CMC7 is selected, the new knowledge base file norm.rec should be beside CSDK binaries and the application installer has to redisribute it.
    For MICR E13-B type, you have to use the FM_MICR/RM_RER setting combination.
    Both CMC7 and E13-B features require the RER license.
  • Asian PDF file handling improvement
    Our PDF overlay matching technology now works with Asian PDF files as well.
  • RecAPIS support libraries in source format
    From now the RecAPIS application can compile and link this support module as their building model requires. The four sources are available in the Support folder.
  • Visuals.dll requires two additional DLLs
    WindowCalsses.dll, SkinnedWindows2.dll.
  • ISAppMFC60 project cannot be compiled
    There is a missing header file reference in MainDlg.cpp
  • Source Control references remain in the sample sln files
    Please ignore the warning in Visual Studio when loading MyISAppMFC60.sln and MyVSAppMFC60.sln solution files.

    Point Release 1

  • Direct XML fontsize unit is changed to 0.01 points from TWIPS
  • IMF_PDFENCRYPTION enum added to RecAPI
    //! PDF encryption types. The setting "Kernel.Imf.PDF.Encryption" gets one of the values from the following new enum, for specifying the used encryption type. */
    typedef enum tagIMF_PDFENCRYPTION
  • Documentation indexing improved
    The help systems and the two guide PDF files for the 16.1 point release have all been updated with additions, improvements and corrections. The indexing for all help systems has been substantially expanded, with 700 to 850 new keyword entries added to IPRO and Visuals respectively, with around a thousand new jumps onto topics. In these cases the new descriptive entries are added to the existing index systems, which were more technical in nature (names of methods, events, properties, controls, etc.).

    For RecAPI two indexes are provided. The existing HTML system index remains intact as it was, listing function names and other technical items. There is now a second index with some 500 descriptive and feature-oriented keywords (hyperlinked to the relevant entries inside other topics), presented in a topic called Index, located immediately after the Introduction topic in the TOC.
  • Added sample applications
    Seven new IPRO samples have been added, with two of them also developed for RecAPI:

    Sample 39 Form processing
    Sample 40 3D deskew for digital camera input
    Sample 41 Workflow-based processing (Sample 48 for RecAPI)
    Sample 42 Accessing table structure information (Sample 49 for RecAPI)
    Sample 43 Using the Setting Manager
    Sample 44 Text marking, marking for redaction
    Sample 45 Performing redaction
  • .NET Application configuration file
    Location of configuration file is the folder of the application and its name is <appname>.exe.config.
    Additional information: RecAPI.chm page RecAPI .NET Support

The very latest version of this file is located in root folder of the installation media.


Choose your country.