Working with the LicensingSettings.xml File
The LicensingSettings.xml file contains the ABBYY FineReader Engine protection settings. This file is used for correct work of the Licensing Service:
- (required) when you use a Network license with any type of protection or Standalone license with online protection.
- (optional) when you use a Standalone license with hardware protection (see Licensing).
The file is generated automatically during Developer or Runtime installation in automatic mode. Both for network and standalone installation this file is generated in two locations: in Bin and CommonBin/Licensing folders in the installation folder.
When installing manually, you will have to create this file in the Bin and CommonBin/Licensing folders and specify correct settings in it.
The XML schema of the Licensing Service settings is described in the LicensingSettings.xsd file. You can find this file in the Inc folder.
Changing the Licensing Service settings
The Licensing Service settings include two main parts:
- The settings of the Licensing Service installed on the current computer which are specified in the <LocalLicenseServer> tag.
- The parameters of connection with the network server, where the Licensing Service is installed. These parameters are specified in the <LicensingServers>\<MainNetworkLicenseServer> tag.
If ABBYY FineReader Engine is installed on a local computer, you should specify the settings only in the <LocalLicenseServer>, if necessary. While if ABBYY FineReader Engine works in a network, <LocalLicenseServer> parameters are specified on the server, and <LicensingServers>\<MainNetworkLicenseServer> parameters on workstations. If a computer is used both as a server and as a workstation, both <LocalLicenseServer> and <LicensingServers>\<MainNetworkLicenseServer> parameters should be specified. See the descriptions of tags below for details.
To change port number
To disable hardware protection keys
License activation via a proxy server
If you need to activate a license when your machine is connected to the Internet via a proxy server, specify the connection parameters in <ProxyServer> tag.
The protocols supported are SOCKS5 and HTTP. For HTTP, you can use basic access authentication or no authentication, for SOCKS username/password or no authentication.
Here is a sample file for activation via a proxy server:
<LocalLicenseServer> <ConnectionProtocol ProtocolType="Sockets" /> </LocalLicenseServer> <ProxyServer Type="SOCKS" Host="192.168.56.1" Port="9090" Login="user" Password="password" />
Using an Online License with a proxy server
An Online License does not require any special settings, but to connect via a proxy server you should specify its parameters in <OnlineLicensing> tag.
The protocol supported is HTTP for which you can use Anonymous, Basic or Digest authentication schemes.
Here is a sample file with the proxy server settings for Online Licensing:
<LocalLicenseServer> <OnlineLicensing Timeout="timeout_time" ProxyServer="http://<server_name>:<port_number>" ProxyAuth="<login>:<password>" /> <ConnectionProtocol ProtocolType="<Protocol type>" /> </LocalLicenseServer>
Setting a path to license data
By default, ABBYY FineReader Engine stores the auxiliary information about licensing in /var/lib/ABBYY/SDK/12/Licenses. To set another folder, specify the Path attribute in <LicensesFolder> tag. The full control permissions to a license data folder:
- required for the folder located on license server
- optional for the folder located on workstations
Note: You may also use the InitializeEngine function to redefine the license data folder.
Sample of specifying the license data folder
Setting up a redundant license server configuration
For licenses distributed via the network, you have the option of setting up a two-server configuration which will allow one of the servers to act as a backup to another in case it goes offline. To do this, you will need a single Network Runtime License of a special type with redundancy support enabled.
- On servers:
- The same license must be activated on both the main and the backup server.
- Each of the servers must specify the address of the other in the <LocalLicenseServer>\<RedundancyNetworkLicenseServer> tag.
- On workstations:
- All workstations must specify the addresses of both servers in the <LicensingServers>\<MainNetworkLicenseServer> and <LicensingServers>\<BackupNetworkLicenseServer> tags.
While using the license, the workstations will interact with the main license server, sending the license parameters and usage statistics to it. The main license server will regularly synchronize this data with the backup server. If the main license server fails, the backup server takes over the license management and continues to store information coming from the workstations. When the main server goes online, the license data is synchronized with the backup, and the main server again starts managing the licenses.
Note that the backup server will stop providing licenses, if the main server is not restored before a certain timeout. This timeout is specified in internal license settings and can range from 4 to 5000 hours.
If the backup license server fails while the main server is functional, the system will continue to work as if there is only one license server. When the backup server is restored, it will be synchronized with the main server and will start working as a backup again.
Sample of a redundant configuration
Note: If you need to use this configuration, please make sure that your license supports it. Contact your sales manager to find out.
Description of Tags
| Tag | Type | Multiplicity | Parent Tag | Description |
|---|---|---|---|---|
| LicensingSettings |
LicensingSettings. Elements:
|
1 | no | Protection settings. |
| LocalLicenseServer |
LocalLicenseServerSettings. Elements:
|
0...1 | LicensingSettings | The parameters of the Licensing Service located on the same computer. |
| ConnectionProtocol |
Complex Type. Attributes:
|
0...1 | LocalLicenseServer | The parameters of the connection protocol. |
| OnlineLicensing |
Complex Type. Attributes:
Currently the only supported protocol for connection via a proxy server is HTTP, for which you may specify the following attributes:
|
0...1 | LocalLicenseServer | Specifies whether online licenses can be used on the computer. |
| EnableCodeMeter Licenses |
Complex Type. Attributes:
|
0...1 | LocalLicenseServer | Specifies whether CodeMeter hardware protection keys can be used on the computer. |
| EnableIKey Licenses |
Complex Type. Attributes:
|
0...1 | LocalLicenseServer | Specifies whether iKey hardware protection keys can be used on the computer. |
| RedundancyNetwork LicenseServer |
NetworkServerAddress. Attributes:
|
0...1 | LocalLicenseServer | Specifies the settings of connection to another server and synchronization with it for each of the network license servers which work together in a redundant two-server configuration. |
| LicensingServers |
Complex Type. Elements:
|
0...1 | LicensingSettings | The list of network servers where the Licensing Service is installed. |
| MainNetworkLicense Server |
NetworkServerAddress. Attributes:
|
1 | LicensingServers | The parameters of the connection with the main network server where the Licensing Service is installed. |
| BackupNetwork LicenseServer |
NetworkServerAddress. Attributes:
|
0...1 | LicensingServers | The parameters of the connection with the backup network license server. |
| LicensesFolder |
Complex Type. Attributes:
|
0...1 | LicensingSettings | Specifies where a folder with auxiliary information about licensing should be stored. |
| ProxyServer |
ProxyServer. Attributes:
|
0...1 | LicensingSettings | The settings of Internet connection via a proxy server, required for license activation. |
Samples
The sample below shows a simple LicensingSettings.xml file for a standalone installation. Hardware protection keys are disabled.
<?xml version="1.0" encoding="utf-8"?> <LicensingSettings xmlns="http://www.abbyy.com/Protection/LicensingSettings"> <LocalLicenseServer> <ConnectionProtocol ProtocolType="Sockets" /> <EnableCodeMeterLicenses Enable="no" /> <EnableIKeyLicenses Enable="no" /> </LocalLicenseServer> </LicensingSettings>
The samples below show simple LicensingSettings.xml files for a network installation: a file for workstations and a file for a server. Licensing Service is located on the computer with the name "computername".
For a workstation:
<?xml version="1.0" encoding="utf-8"?> <LicensingSettings xmlns="http://www.abbyy.com/Protection/LicensingSettings"> <LicensingServers> <MainNetworkLicenseServer ServerAddress="computername" ProtocolType="Sockets" /> </LicensingServers> </LicensingSettings>
For the server:
<?xml version="1.0" encoding="utf-8"?> <LicensingSettings xmlns="http://www.abbyy.com/Protection/LicensingSettings"> <LocalLicenseServer> <ConnectionProtocol ProtocolType="Sockets" /> </LocalLicenseServer> </LicensingSettings>
See also
ABBYY FineReader Engine Distribution Kit
Distribution of Applications Which Use the ABBYY FineReader Engine Library
7/3/2024 8:50:25 AM