New features and changes

This document presents an overview of the innovations, improvements and changes in version 21 of the CSDK.

Screen capture OCR accuracy Improvement

CSDK contains a new preprocessing algorithm for recognizing screen captures.

If the images to be processed can include screen captures, you need to set Kernel.Img.ScreenCapture setting to SCR_AUTO or SCR_YES.

If SRC_AUTO option is selected, CSDK analyzes the image and uses the optimal algorithm.

Objects API for .NET Core supports Docker container environments on Windows (and later Linux)

Kofax.OmniPageCSDK.NETCore.Objects.dll, Kofax.OmniPageCSDK.NETCore.CAPI.dll, and Kofax.OmniPageCSDK.NETCore.RecPDF.dll assemblies have to be used in their .NET Core applications, that is .NET Core v2.1.

For CSDK usage in Docker, check the Manual for container chapter of Additional documentation in Release Notes.

RecAPI for Java
  • It is the JNI implementation of the RecAPI. The current implementation is based on Java version 8.

  • The csdk_omnipage.jar and csdk_omnipage.dll files can be in the bin folder.

  • The complete Java Sample can be in Samples\JavaSamples. The Build.cmd builds the sample. Run it from an Admin command prompt. Run.cmd -x 1 to build sample #1.

Essay, New Output Format support

Essay mode concept is about exporting layout metadata unified at document-level, allowing the user to easily process further the exported document. It uses the following functions:

  • Newly introduced support for styles and heading levels

  • Improved Headers/Footers settings

Enable Styles, Heading levels, and Header/Footer features, and select one of the new Essay mode converter shortcuts (Converters.Text.DocXEssay, Converters.Text.Rtf2000Essay, or Converters.Text.Html50Essay) when exporting a document. The already existing export flags can be also used.

Improvement in accuracy

Significant accuracy improvements are achieved in mixed alphanumeric text recognition.

Form Template Datarules

User can assign data rules, for example wordlist, regular expression or logical expressions, to form fields. After the recognition process, the form fields and the letters of the fields are flagged if they fulfil the data rules or not. Users can quickly verify the erroneous fields. Using this feature increases the reliability and the reparability of forms.

Form Template Adaptation

Form Template Editor now supports Form Template Adaptation, a new operation to create a new form template based on an already existing similar template.

Changes in CSDK Licensing

CSDK Installer does not install License Service for CSDK. After the install, you need to use OPLicMgr.exe or OPLicMgrUI.exe from the bin folder to license the CSDK. Seat and OEM licenses should be managed using these tools.

The previous central licensing has been replaced by the new component, OmniPage Licensing Agent. OPLA functionality is very similar to NLS/NCLS and it is used for page-based licenses.

See more detailed information on the new licensing in the Licensing section of the General Information document.

The default Omnifont OCR engine configuration change to accurate one

The default OCR recognition engine is RM_AUTO. This engine used 2-way vote OCR on Latin based input images. From version 21 it is changed to 3-way vote where it is possible. The default OCR engine is more accurate and slightly slower. If an application requires the previous 2-way voting, set Kernel.OcrMgr.PreferAccurateEngine to false.


The default value changed from FALSE to TRUE.

Assembly and Namespace changes in .NET APIs

In this version .NET assemblies and its namespaces were changed due to the rebranding to Kofax Inc. The new names are descriptive and easy to use. Applications must be changed a bit to refer to the assemblies and namespaces.

Generally Nuance.OmniPage.CSDK is replaced with Kofax.OmniPageCSDK. Check the samples for exact names.

Old IProPlus .NET support API and its Samples are retired and not supported

There is a newer version. The applications have to use the current IProPlus .NET API, Kofax.OmniPageCSDK.IproPlus.dll and Samples\HowCouldWeUseIt.

Revoked binaries Commands to recreate
IproPlus.NET.dll tlbimp IproPlus.dll /out:IproPlus.NET.dll /sysarray /namespace:IproPlus
IproPlus.SRV.NET.dll tlbimp IproPlus.exe /out:IproPlus.SRV.NET.dll /sysarray /namespace:IproPlus
MediumWeightVisualsLib.dll tlbimp MediumWeightVisuals.dll /out:MediumWeightVisualsLib.dll /sysarray
MediumWeightVisuals.NET.dll aximp MediumWeightVisuals.dll /out:MediumWeightVisuals.NET.dll /rcw:MediumWeightVisualsLib.dll
VisualsLib.dll tlbimp Visuals.dll /out:VisualsLib.dll /sysarray
Visuals.NET.dll aximp Visuals.dll /out:Visuals.NET.dll /rcw:VisualsLib.dll
Old RecAPI P/Invoke API (CAPI_PInvoke.dll) is retired

The applications have to use the new assemblies, Kofax.OmniPageCSDK.CAPI.dll and Kofax.OmniPageCSDK.ArgTypes.dll.

Old ISAppMFC and VSAppMFC samples are retired

Study the Samples\HowDoWeUseIt. It is a complete sample for C/C++ applications.

MAX image file support is retired

Version 21 is not able to load MAX image files.

New features of earlier versions can be found in the documents of the given release.