About the LicensingSettings.xml File
The LicensingSettings.xml file contains the ABBYY FlexiCapture SDK protection settings. This file is necessary for correct work of the Licensing Service in the network. When Licensing Service is used on a local computer, this file is required if you use a Hardware protection key.
The file is generated automatically during Developer or Runtime installation in automatic mode. The XML scheme of the settings is located in the LicensingSettings.xsd file. You can find this file in the Inc folder (Start > Programs > ABBYY FlexiCapture 12 SDK > Include Files 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,
- and 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 FlexiCapture SDK is installed on a local computer, you should specify the settings only in the <LocalLicenseServer>, if necessary. While if ABBYY FlexiCapture SDK 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 TCP/IP port
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 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 the case it goes offline.
In this case you will need Network Runtime Licenses, which will be activated on both license servers. The workstations must specify the addresses of both servers in <LicensingServers>\<MainNetworkLicenseServer> and <LicensingServers>\<BackupNetworkLicenseServer> tags. Each of the servers must specify the address of the other in <LocalLicenseServer>\<RedundancyNetworkLicenseServer>, together with the synchronization settings. 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. However, if the main server is not restored during some time, the backup server will stop functioning when this time runs out. This time may be different depending on your license.
If the backup license server fails while the main server is working, 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 start function 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. |
| EnableCodeMeterLicenses |
Complex Type. Attributes:
|
0...1 | LocalLicenseServer | Specifies whether CodeMeter protection keys can be used on the computer. |
| RedundancyNetworkLicenseServer |
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. |
| MainNetworkLicenseServer |
NetworkServerAddress. Attributes:
|
1 | LicensingServers | The parameters of the connection with the main network server where the Licensing Service is installed. |
| BackupNetworkLicenseServer |
NetworkServerAddress. Attributes:
|
0...1 | LicensingServers | The parameters of the connection with the backup network license server. |
| 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. Local inter-process communication is used. Hardware protection keys are disabled.
<?xml version="1.0" encoding="utf-8"?> <LicensingSettings xmlns="http://www.abbyy.com/Protection/LicensingSettings"> <LocalLicenseServer> <ConnectionProtocol ProtocolType="LocalInterprocessCommunication" /> <EnableCodeMeterLicenses 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". The TCP/IP protocol is used for communication between the server and workstations.
For a workstation:
<?xml version="1.0" encoding="utf-8"?> <LicensingSettings xmlns="http://www.abbyy.com/Protection/LicensingSettings"> <LicensingServers> <MainNetworkLicenseServer ServerAddress="computername" ProtocolType="TCP/IP" /> </LicensingServers> </LicensingSettings>
For a server:
<?xml version="1.0" encoding="utf-8"?> <LicensingSettings xmlns="http://www.abbyy.com/Protection/LicensingSettings"> <LocalLicenseServer> <ConnectionProtocol ProtocolType="TCP/IP" /> </LocalLicenseServer> </LicensingSettings>
See also
Distribution of Applications Which Use the ABBYY FlexiCapture SDK Library
8/15/2023 1:19:30 PM