ClearImage v10 Licensing

This document explains licensing concepts and error handling of the ClearImage v10.
To learn about licensing of the ClearImage v9 and earlier see here.

ClearImage v10 vs ClearImage v9

With the introduction of ClearImage v10, the licensing model has been modified to support new integration requirements, like the .Net Core and NuGet distribution. The major changes vs. ClearImage v9 and earlier versions are:

Feature ClearImage v10 ClearImage v9 and earlier
Installer Single ClearImage SDK Installer.
NuGet
package
ClearImage SDK Installer for Development.
ClearImage PDK Installer for Production.
Production Licensed products and ClearImage version, released before license support expiration date. Licensed products and ClearImage PDK.
Development ClearImage generates an error calling unlicensed modules for random images. Optionally, an occasional dialog box is displayed in Windows Apps. ClearImage SDK displays an occasional dialog box when used in Windows Apps. An error when used in Windows Service or Web Apps.
.NET versions .Net Framework 4.0 and later
.Net Core 3.0 and later
.Net Framework 4.0 and later for v9
.Net Framework 2.0 or 3.5 for v8 and earlier

Terminology

Modules and Products

The ClearImage functionality is encapsulated in several modules. The major modules are:

Module Functions
CiImage Open and save image files. Basic image processing operations (e.g., rotate, invert)
CiRepair Automatically repair images (e.g., auto-deskew, auto-rotate, clean noise)
CiTools Image analysis and modification (e.g., find lines, measure rotation)
CiBarcodePro Read 1D and postal barcodes (e.g., Code39, Code128, IMB)
CiPdf417 Read PDF417 Barcodes
CiQR Read QR Codes
CiDataMatrix Read DataMatrix Barcodes
CiDlIdReader Read one PDF417 barcode and/or one Code39 or Code128 barcode
CiDlIdDecoder Decode Driver license data in PDF417 Barcode
WebApi REST API for barcode reading on a Web Server.
CcMicr Read MICR line data on check images.


The ClearImage functionality is acquired by purchasing a license for ClearImage products, which are:

Product Modules
ClearImage Reader 1D CiImage, CiBarcodePro
ClearImage Reader 2D CiImage, CiPdf417, CiDataMatrix, CiQR
ClearImage Reader 1D+2D CiImage, CiBarcodePro, CiPdf417, CiDataMatrix, CiQR
ClearImage DL/ID License Reader CiImage, CiDlIdReader, CiDlIdDecoder
ClearImage IP CiImage, CiRepair, CiTools
MICR Recognition CiImage, CcMicr
Web API WebApi

Purchase, Registration and Licensing

After placing an order for one or more licenses for a product, the Inlite customer receives a registration certificate for the order.
The certificate is used to register the product on a physical computer or VM or Cloud instance ("target system"). Registering a product binds all of its licensed modules to the target system forever or until the license is transferred to another target system. Registration is done by clicking the Register Licenses button on the Licensing Tab of the Inlite Control Center (ICC)

Each license is associated with the support expiration date ("Support Date"). Upon the license purchase, the date is one year after the order date OR three years if additional support is purchased. To continue support beyond the initial date, customers can purchase the Software Assurance Program to extend and align support for ALL licenses owned by the customer to December 31 of the next year.

Multiple versions of ClearImage can be installed and used on the target system. Typically applications use the active version that is the registered COM object or GAC assembly, selected and displayed on the Version tab of the ICC. However, certain applications (e.g., registration-free COM, .Net Core, etc.) reference the version installed in the application directory. The runtime version is the version loaded by the application regardless of the loading mechanism.

License Types

Licenses for most of the products are available in two types.

  • Server License operates on any Windows physical or virtual computer without limitations.
  • Workstation License is a low-cost license that imposes a performance limitation on the processed pages-per-minute (ppm) depending on the host environment:
    • 25 ppm operating under Windows 7, 8, 10 running on a physical computer.
    • 5 ppm operating under Windows Server or VM or on a Cloud instance
    To enforce the ppm limit, a call to open an image might take a longer time to complete.

Operational Modes

ClearImage operates in one of three modes:

  • Evaluation mode is a default mode for 60 days after ClearImage SDK or ClearImage PDK is installed for the first time. During the evaluation period all modules are licensed.
  • Production mode supports licensed customer’s production requirements. Calling unlicensed modules raises an error.
  • Development mode supports customer’s ongoing development after the expiration of the evaluation period.
    Periodic dialog boxes or error messages limit the ability to use ClearImage for production purposes.

Production Mode

In production mode, ClearImage operates within the scope of the purchased licenses. This mode is activated when:

  • Evaluation mode has expired, and one or more licenses are registered.
  • In the Version Tab of the ICC.
    • Click the Activate Production Version button.
    • Select Production: … in the "Operational mode" list

Each release of ClearImage is associated with a version release date ("Release Date"). The licenses are perpetual, but a customer is not authorized to use ClearImage versions whose Release Date is later than the license Support Date ("unauthorized version"). The applications calling a module in unauthorized version raises the “unauthorized version” exception. Since modules can have different Support Dates, eligibility is enforced on a module level. A call to an unlicensed module raises the “unlicensed module” exception.

Development mode

In development mode, ClearImage supports customer’s continuous development and testing of unlicensed modules. This mode is activated when :

  • Evaluation mode has expired, and no licenses are registered.
  • In the Version Tab of the ICC.
    • Click the Activate Development Version button.
    • Select Development:… in the "Operational mode" list

Calling a licensed module in an authorized version operate as in Production mode. Otherwise, the call results in.

  • Any application - a "development mode" exception is randomly generated for some images, selection of which cannot be changed by the user.
  • UI applications only (Windows or Console application) -: an occasional dialog box is displayed, where the user is required to click a button to continue.

Licensing errors

L2000 Use of unlicensed module

This error is generated in the Production mode when an application calls an unlicensed module. To avoid this error:

  • Remove or comment-out lines in the application that reference an unlicensed module, or
  • Purchase and register a license for the products containing an unlicensed module.

L2001 Use of unauthorized version

This error is generated in the Production mode when an application calls a licensed module, but the Support Date for this module is earlier than the Release Date of the runtime ClearImage version.
Initial Support Date on the target system is set during the registration. Following the purchasing of the Software Assurance Program, Support Dates should be updated on the target system. To do this do either:

  • Click the Update Support Dates button on the Licensing Tab of the ICC, or
  • Click the Request Support Extension button on the Licensing Tab of the ICC.
    Once order is placed you will receive an email with instructions and an attached Support Status file (.cisup). To update support:
    • Click the Update Support Dates button on the Licensing Tab of the ICC, or
    • Save the Support Status file (.cisup) into C:\ProgramData\Inlite folder.

To avoid this error::

  • Update Support Dates of the licenses using actions above. or
  • Revert to the earlier "authorized version" of ClearImage. To identify such version click the Check for Updates button on the Versions tab of the ICC

L2002 This random image is excluded in Development mode

This error is generated in the Development mode when an application calls an unlicensed module or in unauthorized version. Only random subset of all images triggers this error, preventing unlicensed use in the Development mode. To avoid this error::

  • Purchase and register a license for the products containing an unlicensed module or extend Support Date for a licensed module (see Production mode errors above), or
  • If using a UI applications (Windows or Console application), select "Development: Dialog box is occasionally displayed" in the "Operational mode" list of the Version tab of the ICC

The ClearImage Demo application, included with ClearImage SDK, allows processing of all files.

L2003 ClearImage SDK is not installed

This error is generated when:

  • Runtime version is installed using NuGet package or ClearImage runtime DLL is just copied to the target system.
  • ClearImage SDK is not installed on the target system

To avoid this error download and install ClearImage SDK.