9.3

Edit

OCR license

License categories

  • Base category: includes supported languages, except Arabic, Farsi, Chinese, Japanese, Korean, Thai, Hebrew, Yiddish, and Vietnamese.

  • CJK category: the Base category languages plus Chinese Traditional, Chinese Simplified, Japanese, Korean, and Korean Hangul.

  • All category: all supported languages are included. See the language list.

Activating license

FRE SDK location (Linux) /ABBYY_FRE11 FRE SDK location (Windows)/ FineReaderEngine

After the installation of the OCR components, you'll find the following file on the OCR server:

Linux location of license_request.txt file

<fre_sdk_dir>/license_request.txt

If you are doing the migration from old versions (pre 8.5), follow the steps below to reuse the available number of pages in your new environment:

  • Get the number of unused pages from pre 8.5 versions.

Actions below should be repeated for all activated licenses for all OCR servers:

  1. Run License Manager using any user:

    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<INSTALL_DIR>/apps/ABBYY/FREngine11/Bin
<INSTALL_DIR>/apps/ABBYY/FREngine11/Bin/LicenseManager.Console

    The license serial number and other license parameters can differ from samples.

  2. Select activated license:

  3. Open license parameters:

  4. Make a screenshot of the first page. Ensure that the line with Volume → Regular Text → Remains is visible.

  5. Request and activate the license by sending an email to your account manager in WorkFusion or create a Service Desk ticket according to the template from the next step.

    Attach all license screenshots if the remaining value is greater than 0.

  6. Send an email to your account manager in WorkFusion or create a Service Desk ticket according to the following template.

    Attach the license_request.txt file to the email:

    Dear Support Team,
    Please, provide OCR license according to the following requirements:
    Company name: ___
    Number of pages to include: ___ *)
    Platform type:___ (Linux or Windows)
    Status of the server (Production, POC, UAT, DEV) ____
    Category of languages: Base, or CJK (supports Chinese, Japanese, Korean), or All Token returned by the prepareLicense API: ___ (content of the license_request.txt file on the OCR server).

    *) The number of OCR pages should be estimated during the POC based on the customer workload: if, during a day, they consume 1,000 pages, they need 30,000 pages to run the same for a month.
    Non-prod licenses as stated below have some predefined values: 10K, 50K, or 100K pages, depending on the complexity of the customer workload. Ideally, request the minimal one.
    The account manager is aware of the number o the pages included into the contract: it’s part of the negotiations with the customer.

    note

    Pay attention that the cost of the license depends on the number of the pages as well as the category. Make sure your contract with WorkFusion covers it. If you have to multiply OCR servers to balance the workload, request multiple OCR licenses, separately for each server.

  7. In the response to your email, WorkFusion will send you the license_response.txt file.

    Copy the file to the following location on the OCR server:

    <fre_sdk_dir>/license_response.txt

  8. Navigate to <fre_sdk_dir> directory on your OCR server and execute the script according to the configuration:

  • activate_wf.sh on Linux
  • activate_ocr.bat on Windows in SPA

Example:

cd <fre_sdk_dir>/
./activate_wf.sh

If everything is OK, the command will report a success result like this:

{"message":{"content":"License Activation Succeeded"}}

Note that the newly activated license complements the previous one and adds new OCR pages to the remaining amount.

Verifying license

After the activation, you can check the state of your active license. For that, SSH to the OCR server and use the activeLicense API endpoint.

If authentication is disabled (the auth-disabled profile is configured), no authentication header is needed, and the command looks like this:

curl -s http://localhost:9002/api/v1/cloud/activeLicense | python -m json.tool

If authentication is enabled, the command looks like this:

 curl -s -H "Authorization: ..." http://localhost:9002/api/v1/cloud/activeLicense | python -m json.tool

In place of ..., provide the credentials according to the OCR service configuration. The header may look either like Authorization: Basic your_username_pwd_base64 for basic authentication or Authorization:Bearer your_jwt_token for JWT authentication.

Reporting OCR Usage

If you use the pay-as-you-go type of license, you activate it once per installation and don't need to activate more licenses later. Instead, you need to report the license consumption as of April 1, July 1, October 1, January 1. Send the consumption information to WorkFusion using the steps below.

For that, SSH to the OCR server and invoke the following command:

curl -X POST http://localhost:9002/api/v1/cloud/activeLicense

Copy the output of the above command and send it to the WorkFusion support.

← PreviousNext →