9.0

Edit

OCR license

License categories

  • Base category: supported languages, except Arabic, Farsi, Chinese, Japanese, Korean, Thai, Hebrew, Yiddish, and Vietnamese.
  • CJK category: "Base" category languages plus Chinese Traditional, Chinese Simplified, Japanese, Korean and Korean Hangul.
  • All category: all supported languages are included. For more details, see the language list.

Activate license

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

<install_dir>/ABBYY_FRE11/license_request.txt

Send an email to your account manager in WorkFusion or create a WorkFusion 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: ___ *

Status of the server (Production, POC, UAT, DEV) ____
Category of languages: Base, or CJK (supports Chinese, Japanese, Korean), or All

Token returned by prepareLicense API: ___ (Included in license_request.txt file)

* Number of OCR pages should be estimated during POC based on the customer workload: like if during a day they “eat” 1000 pages, then to run the same for a month they need 30000 pages Non prod licenses as stated below have some predefined values 10K, 50K, 100K pages depending on complexity of the customer workload. Ideally is to request the minimal one. Account manager aware of the number of pages included into the contract. It’s a part of negotiation with the customer.

note

Pay attention that the cost of the license depends on the number of pages as well as the category. Make sure your contract with WorkFusion covers it.

If you have multiply OCR servers to balance the workload, then you need to request multiply OCR licenses – separately for each server.

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

  1. Copy this file to the following location on the OCR server:

    <install_dir>/ABBYY_FRE11/license_response.txt

  2. Navigate to the <install_dir>/ABBYY_FRE11/ directory on your OCR server and execute the activate_wf.sh script:

    cd <install_dir>/ABBYY_FRE11/
./activate_wf.sh

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

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

Take into consideration, that if the category of newly activated license is different from your previous one, the change will take effect immediately after activation, even if you have a lot of pages left from your previous license.

Verify license

After activation, you may check the state of your active license. For that, use the activeLicense API. You need to SSH into OCR server firstly.

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

 curl -s http://localhost:9002/api/v1/cloud/activeLicense

If authentication is enabled, the command is as follows:

 curl -s -H "Authorization: ..." http://localhost:9002/api/v1/cloud/activeLicense

In place of ..., provide 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.

Report 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 license consumption April 1, July 1, October 1, January 1. Send the consumption information to WorkFusion using the steps below.

For that, SSH into 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 WorkFusion support.

← PreviousNext →