- The duration of access to skills
- The number of pages that can be processed
- The available skills
A subscription applies to all users in a tenant. If a subscription is tied to several tenants, they will share counters for each skill.
Configuring ABBYY Subscription Service Access
In an isolated environment, configure access from Vantage to the ABBYY Subscription service to send subscription usage statistics. The frequency with which these requests are sent is determined by your subscription settings. By default, the statistics are sent daily. Options:- Direct access. Allow HTTPS requests to
https://licensing-us.abbyy.com - Proxy access. Redirect requests through a proxy.
Using a Proxy
Before you start, make sure that the kubectl command-line tool is installed on your machine and a connection to the Kubernetes cluster has been established.
- Access the Consul web interface:
http://localhost:8500/ui/dc1/kv/secret/
- Select the required Vantage environment.
- Change the values of the following keys:
| Key | Description |
|---|---|
secret/.../subscriptions/licensingHqClientProxyUse | Set to True to enable proxy. |
secret/.../subscriptions/licensingHqClientProxyUri | Proxy address with protocol and port (e.g., http://<proxyaddress>:3128) |
secret/.../subscriptions/licensingHqClientProxyDomain | User domain. If your proxy uses domain account authentication, specify the domain name. The proxy login will consist of this domain name and the user name. |
secret/.../subscriptions/licensingHqClientProxyUserName | Proxy login. |
secret/.../subscriptions/licensingHqClientProxyPassword | Proxy password. |
- Click Save.
- Restart the
abbyy-vantage-subscriptionsdeployment.
Viewing Subscription Parameters
- On the Tenants tab, click the tenant name.
- Navigate to the Subscription tab.
- Subscription type, serial number, and expiry date
- Skill Counters: Available pages per skill, next update date
- Subscription Parameters: Additional options (e.g., Advanced Designer availability)
How Pages Are Counted
ABBYY Vantage keeps count of all document pages processed by users with license-specific counters. The counter type used to calculate the number of processed pages depends on the skill used and on whether the skill is licensed or not. Licensed skills are skills that have been created by ABBYY or its partners and that have undergone the licensing procedure at ABBYY. Counter types:| Counter Type | Description |
|---|---|
| Dedicated counters | For licensed skills (e.g., ABBYY Invoice, ABBYY Bill Of Lading). Each licensed skill has its own dedicated counter. |
| Core Cognitive Skills | For all unlicensed ABBYY Vantage skills. |
| OCR Skill | For pages processed using OCR skills. |
| Licensed Skills | For trial versions of licensed skills only. This lets you process documents using licensed skills whose counters are either not part of your license or have run out of pages. |
When Pages Are Counted
Design time (Document and Classification skills):- Importing demo documents into a Document skill
- Importing files into a document set for training
- Uploading pages to the Documents section
- Processing documents in transactions
- Using the Try Skill feature
Pages are counted even if the transaction fails after document import.
Process Skill Page Counting
| Skill Configuration | Counter Behavior |
|---|---|
| Only unlicensed skills | Core Cognitive Skills counter increments once per page |
| One licensed skill | Licensed skill counter increments once per page |
| Unlicensed + one licensed | Counter depends on which skill processes the document |
| Multiple licensed skills | Each licensed skill counter increments per page |
If for some skill(s) contained within a Process skill all related counters have reached their respective limits, no transaction will be launched.
Managing Subscriptions
A System Administrator can manage tenant subscriptions. Specifically, a System Administrator can link, modify, and delete subscriptions.Linking a Subscription
Upload the subscription file when creating a new tenant or add it to an existing tenant via the tenant settings.
Modifying a Subscription
- Open the Tenants tab and click the tenant name.
- Navigate to the Subscription tab.
- Click the menu icon next to the subscription type.
- Select Change Subscription File and upload the new file.
Deleting a Subscription
- Open the Tenants tab and click the tenant name.
- Navigate to the Subscription tab.
- Click the menu icon and select Delete Subscription.
Licensed Skills Reference
| Skill Name | License Name |
|---|---|
| Invoice US, EU, CA, ES, UA, AU-NZ, CN, Invoice Classifier | ABBYY.Invoice |
| Purchase Order US, EU, Purchase Order Classifier | ABBYY.PurchaseOrder |
| Receipt, Receipt CJK, Hotel Invoice, Taxi Receipt, Expense Management Classifier | ABBYY.Receipt |
| Commercial Invoice | ABBYY.CommercialInvoice |
| Bill Of Lading | ABBYY.BillOfLading |
| Air Waybill | ABBYY.AirWaybill |
| Remittance Advice | ABBYY.RemittanceAdvice |
| Utility Bill | ABBYY.UtilityBills |
| Bank Statement | ABBYY.BankStatements |
| Personal Earning Statement | ABBYY.PersonalEarningStatements |
| Arrival Notice | ABBYY.ArrivalNotice |
| Form W-2, Wage and Tax Statement | ABBYY.IrsTaxFormW-2 |
| Form 1040, U.S. Individual Income Tax Return, Form 1040, U.S. Individual Income Tax Return 2022, Form 1040 Classifier | ABBYY.IrsTaxForm1040 |
| Certificate of Origin | ABBYY.CertificateOfOrigin |
| Form 990, Return of Organization Exempt From Income Tax | ABBYY.Form990 |
| Form 1098, Mortgage Interest Statement | ABBYY.TaxForm1098 |
| Identity Documents | ABBYY.IdReading |