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 (see language list).
Activate license
Copy the /opt/workfusion/ABBYY_FRE11/license_request.txt file from OCR server → OCR directory.
If you installed OCR in non-default directory, you need to adjust the previous path respectively.
Send an email to your account manager in WorkFusion or create a Service Desk ticket according to the following template with the license_request.txt file in atachment:
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 is 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, request multiple OCR licenses – separately for each server.
Once you received the license file from WorkFusion support, you need to copy it to the OCR directory and activate it with the following command:
curl -X POST --form license=@/path/to/license_file http://your_ocr_host/api/v1/cloud/activateLicense
The request should be invoked for the same OCR Service instance, which you copied and sent the license_request.txt file from. If everything is OK, the command will report a success result like this:
{"message":{"content":"License Activation Succeeded"}}
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 activeLicense API:
curl -s -H "Authorization: ..." http://your_ocr_host/api/v1/cloud/activeLicense
In place of ... you need to provide credentials according to 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 . If authentication is disabled (auth-disabled profile is configured) no authentication header is needed and the command will look like this:
curl -s http://your_ocr_host/api/v1/cloud/activeLicense
Report OCR usage
If you use "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. Please send the consumption information to WorkFusion using the steps below.
For that invoke the following command. You need to replace your_ocr_host in the command with the domain name of your OCR Service installation.
curl -X POST http://your_ocr_host/api/v1/cloud/prepareLicense
Copy the output of the above command and send it to WorkFusion support.